Party Details Third Party Management
| Name | Description | Introduced In |
|---|---|---|
| getAddressSuggestions | This API retrieves the address suggestions based on the address that is being typed by the user and the user's current location by using Google APIs. | 2021.01 |
| getFormattedAddress | This API retrieves the additional address details based on the address suggestion that is selected by the applicant. | 2021.01 |
getAddressSuggestions
| Description: | Retrieves the address suggestions based on the address that is being typed by the user and the user's current location by using Google APIs. For example, when a user is typing an address, this API creates a circle with the location of the user as the center of the circle. The API then provides address suggestions from locations within the circle that match the address that is being typed by the user. If there are no suggestions that can be provided within the circle, then the API fetches the locations from outside the circle and suggests the addresses to the user. The maximum number of address suggestions that the API can fetch is 5. The API response contains a parameter called Place_ID, which is used by the getFormattedAddress API to fetch additional address details. | |||||
| Method: | POST | |||||
| URL: | {{baseUrl}}/services/data/v1/PartyDetailsThirdparty/operations/Locations/getAddressSuggestions | |||||
| Security Level: | Authorized App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters currLatitude Specifies the current latitude. currLatitude Specifies the current latitude. query {
"currLatitude": "11.127122499999999",
"currLongitude": "78.6568942",
"query": "tem"
}
|
|||||
| Response: |
Locations [] Specifies the Address with the place ID. Parameters Locations/formattedAddress Specifies the formatted address (The suggested address). Locations/place_id Specifies the place id. {
"Locations": [{
"formattedAddress": "Brihadeeswara Temple, Membalam Road, Balaganapathy Nagar, Thanjavur, Tamil Nadu, India",
"place_id": "ChIJIRL-SJ-4qjsR1oRd5UDLIx0"
}, {
"formattedAddress": "Tembhurni, Maharashtra, India",
"place_id": "ChIJB1O0UpBvxDsRlAFi4Or4AYE"
}, {
"formattedAddress": "Temptation, Round Road, Elil Nagar, Dindigul, Tamil Nadu, India",
"place_id": "ChIJa4oXYUSqADsR3AZM89Iz-Cw"
}, {
"formattedAddress": "Temple, Thanjavur, Tamil Nadu, India",
"place_id": "ChIJZ_BoCNq6qjsRnDrpNB7MbEE"
}, {
"formattedAddress": "Temanggung, Temanggung Regency, Central Java, Indonesia",
"place_id": "ChIJf2Zev5yCei4RcD1T2zYAtUE"
}],
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
getFormattedAddress
| Description: | Retrieves the additional address details based on the address suggestion that is selected by the applicant. Every address suggestion is associated with a specific place_ID and by using this unique ID, the API fetches the additional details. The address details include information on the street, city, country, and zip code. | |||||
| Method: | POST | |||||
| URL: | {{baseUrl}}/services/data/v1/PartyDetailsThirdparty/operations/Locations/getFormattedAddress | |||||
| Security Level: | Anonymous App User | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters place_id Specifies the id of a particular place. {
"place_id": "ChIJAXznRt41W4YRP1Dhw1NrYo0"
}
|
|||||
| Response: |
Locations [] Specifies the Address with the place ID. Parameters Locations/formattedAddress Specifies the formatted address (The suggested address). Locations/address_components Specifies the various components of an address. Locations/types Specifies the formatted address type. Locations/short_name Specifies the truncated address. Locations/long_name Specifies the complete address. {
"Locations": [{
"formattedAddress": "KG360, IT Business Park, Second Floor, Plot No. 232/1 Veeranam Street, OMR Bypass Road, MGR Salai, Thiruvengadam Nagar, Perungudi, Chennai, Tamil Nadu 600096, India",
"address_components": "[{"
types ":["
route "],"
short_name ":"
MGR Salai ","
long_name ":"
MGR Salai "},{"
types ":["
sublocality_level_2 ","
sublocality ","
political "],"
short_name ":"
Thiruvengadam Nagar ","
long_name ":"
Thiruvengadam Nagar "},{"
types ":["
sublocality_level_1 ","
sublocality ","
political "],"
short_name ":"
Perungudi ","
long_name ":"
Perungudi "},{"
types ":["
locality ","
political "],"
short_name ":"
Chennai ","
long_name ":"
Chennai "},{"
types ":["
administrative_area_level_2 ","
political "],"
short_name ":"
Chennai ","
long_name ":"
Chennai "},{"
types ":["
administrative_area_level_1 ","
political "],"
short_name ":"
TN ","
long_name ":"
Tamil Nadu "},{"
types ":["
country ","
political "],"
short_name ":"
IN ","
long_name ":"
India "},{"
types ":["
postal_code "],"
short_name ":"
600096 ","
long_name ":"
600096 "}]"
}],
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Error Code(s): |
None |
|||||
| Service Flow: |
|
In this topic