Features - Connectors Framework - Inbound REST API
Address
Overview
Get address by addressId
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/address/{addressId}/view.html?token=XXXXXXXX&userId={userId}
Parameters
addressId
required
Long
An unique ID representing an internal ID
address1
required
String
Line 1 of address
address2
optional
String
Line 2 of address
city
required
String
City of address
state
optional
String
State of address
zipCode
optional
String
Postal code of address
countryId
required
Long
Represents a country and should match with MobiWork countryIds
(use countries end point to get country list)
Return
Returns an Address Object if valid arguments are provided. Returns an error if not a valid request.
Curl Example
HTTP Method: GET
Request: curl -X GET "https://www.mobiwork.com/api/rest/12014/5.0.143/address/1/view.html?token=COJL8X2FKSLMMRTYCH2B"
Response: <address>
<addressId>818635</addressId>
<address1>160 Congress Park Dr</address1>
<address2></address2>
<city>Delray Beach</city>
<state>Florida</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
<latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name>Primary Address</name>
<baseDistance>9022407</baseDistance>
</address>