Qodex.ai

API Place - GeographicAddress

Number of APIs: 11

TMF API Reference : TMF 673 - Place - Geographic Address Management

Release : 19.5 - January 2020

The Geographic Address API provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real address.

Resources

  • GeographicAddress
  • GeographicSubAddress
  • GeographicAddressValidation
  • Hub

Operations

Geographic Address Management API performs the following operations : - Retrieve a geographic address or a collection of geographic addresses - Retrieve a geographic sub-address - Create a geographic address validation - Retrieve, update and delete an existing geographic address validation - Notify events on these resources

  1. geographic Address Validation - Creates a GeographicAddressValidation POST {{baseUrl}}/geographicAddressValidation

  2. Client listener for entity GeographicAddressValidationStateChangeEvent POST {{baseUrl}}/listener/geographicAddressValidationStateChangeEvent

  3. geographic Address-{geographic Address Id}/geographic Sub Address - List or find GeographicSubAddress objects GET {{baseUrl}}/geographicAddress/:geographicAddressId/geographicSubAddress?fields=Ut eiusmod&offset=-6845752&limit=-6845752

  4. geographic Address Validation-{id} - Retrieves a GeographicAddressValidation by ID GET {{baseUrl}}/geographicAddressValidation/:id?fields=Ut eiusmod

  5. geographic Address Validation-{id} - Updates partially a GeographicAddressValidation PATCH {{baseUrl}}/geographicAddressValidation/:id

  6. geographic Address Validation - List or find GeographicAddressValidation objects GET {{baseUrl}}/geographicAddressValidation?fields=Ut eiusmod&offset=-6845752&limit=-6845752

  7. geographic Address-{geographic Address Id}/geographic Sub Address - Retrieves a GeographicSubAddress by ID GET {{baseUrl}}/geographicAddress/:geographicAddressId/geographicSubAddress/:id?fields=Ut eiusmod

  8. geographic Address - List or find GeographicAddress objects GET {{baseUrl}}/geographicAddress?fields=Ut eiusmod&offset=-6845752&limit=-6845752

  9. geographic Address - Retrieves a GeographicAddress by ID GET {{baseUrl}}/geographicAddress/:id?fields=Ut eiusmod

  10. hub - Register a listener POST {{baseUrl}}/hub