Calling the APIs

Overview

The RatePoint API can be called using two methods:

API Endpoint

http://{host}:{port}/ratepoint/api/{api_name}

Request Parameter

Name: request

Value: XML String

Request Method

GET or POST

If using GET, value of request parameter should be URL encoded.


Example GET Request:

http://{host}:{port}/ratepoint/api/{api_name}?request={url_encoded_request_xml_string}

API Response

XML Data

Available APIs

Name

Description

establishSession

Establish a new API session.

terminateSession

Terminate an existing API session.

getRateforLocation

Get rates for a mapped Location.

getRate

Get all rates for a jurisdiction.

getRateHighest

Get the highest rates for a jurisdiction.

getRateLowest

Get the lowest rates for a jurisdiction.

getRateforGeocode

Get rates for a Geocode.

getAllLocations

Get all defined Locations.

getAllMappedLocations

Get all Locations that have been mapped to a geocode.

getAllUnmappedLocations

Get all Locations that have not been mapped to a geocode.

getLastUpdated

Get the date that the rates were last updated.

createLocation

Create a Location.

updateLocation

Update a Location.

deleteLocation

Delete a Location.

createCompany

Create a Company.

updateCompany

Update a Company.

deleteCompany

Delete a Company.

createSubCompany

Create a Sub Company.

updateSubCompany

Update a Sub Company.

deleteSubCompany

Delete a Sub Company

mapLocation

Map a Location.

getMappedGeocode

Get the geocode for a mapped Location.

getUnmappedGeocode

Get all geocodes for an unmapped Location.

getHighestUnmappedGeocode

Get the highest rate geocode for an unmapped Location.

getLowestUnmappedGeocode

Get the lowest rate geocode for an unmapped Location.

getHighestGeocode

Get the highest rate geocode for a jurisdiction.

getLowestGeocode

Get the lowest rate geocode for a jurisdiction.

getAllCompanies

Get all defined Companies.

getAllSubCompanies

Get all defined Sub Companies.

createUser

Create a User.

deleteParentUser

Delete a Parent User.

deleteSubUser

Delete a Sub User.

updateParentUser

Update a Parent User.

updateSubUser

Update a Sub User.

updateMappedGeocode

Update the geocode on a mapped Location.

isMapped

Returns TRUE if a Location is mapped, else returns FALSE.

getLocationId

Get the Location ID for a Location.

getDefaultMailingRate

Get the rate for the default USPS for a jurisdiction.

getDefaultMailingGeocode

Get the geocode for the default USPS for a jurisdiction.

getRateforGeoSpatial

Get rates using the GeoSpatial engine.

getRateforLatLon

Get rates using a Latitude/Longitude combination.

cleanseAddress

Cleanse an address.

getStreetLevelRate

Get rates using a street address.