Framework | Address
Service to manage entities of type 'Address'.
Overview
URL | api/{tenantKey}/{orgKey}/corePatterns/addresses |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive Address
- PUT Set AddressKey Address
- PUT Set StreetName Address
- PUT Set BuildingNumber Address
- PUT Set PostalZone Address
- PUT Set CityName Address
- PUT Set POBox Address
- PUT Set ContactName Address
- PUT Set ContactTitle Address
- PUT Set FormattedAddress Address
- PUT Set ExternalId Address
- PUT Set ExternalVersion Address
- PUT Set IsExternallyManaged Address
- PUT Set Country Address
- PUT Set Region Address
- PUT Set PostalZoneRef Address
- PUT Set Index Address
- DELETE:
All Resources
This service uses the following resources:
GET Addresses (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See AddressResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Address by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See AddressResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Address by key
Returns the entity record that matches the specified key.
The following elements are required:
addressKey | (int) The key for address. |
Response:
When successful, the response body contains the entity record. See AddressResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Addresses
Creates a new entity record.
The following elements are required:
addressResource | (ApiAddressResource) The request body should contain the entity record that should be created. See ApiAddressResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiAddressResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AddressKey Address
Updates the value of attribute 'AddressKey' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BuildingNumber Address
Updates the value of attribute 'BuildingNumber' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CityName Address
Updates the value of attribute 'CityName' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ContactName Address
Updates the value of attribute 'ContactName' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ContactTitle Address
Updates the value of attribute 'ContactTitle' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Country Address
Updates the value of attribute 'Country' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ExternalId Address
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ExternalVersion Address
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set FormattedAddress Address
Updates the value of attribute 'FormattedAddress' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Index Address
Updates the value of attribute 'Index' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Address
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsExternallyManaged Address
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set POBox Address
Updates the value of attribute 'POBox' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PostalZone Address
Updates the value of attribute 'PostalZone' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PostalZoneRef Address
Updates the value of attribute 'PostalZoneRef' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Region Address
Updates the value of attribute 'Region' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set StreetName Address
Updates the value of attribute 'StreetName' in the specified entity record.
The following elements are required:
addressKey | (int) The key for address. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Address by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Address by key
Deletes the entity record that matches the specified key.
The following elements are required:
addressKey | (int) The key for address. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
AddressResource
The following elements are required:
addressKey | (int) The key for address. |
isExternallyManaged | (bool) A flag indicating if the address is externally managed. |
country | (string) The country name.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
The following elements are optional:
streetName | (string) The street name. |
buildingNumber | (string) The house number. |
postalZone | (string) The postal code. |
cityName | (string) The city's name. |
pOBox | (string) The post office box. |
contactName | (string) The contact name. |
contactTitle | (string) The contact title. |
formattedAddress | (string) The formatted address. |
externalId | (string) The external identifier for the address. |
externalVersion | (string) The external version for the address. |
region | (string) The region's name.
(fk) Allowed value: the natural key of a record of type Region. These records are accessibly through the Regions service. |
postalZoneRef | (string) The postal zone's reference.
(fk) Allowed value: the natural key of a record of type PostalZone. These records are accessibly through the PostalZones service. |
index | (int) The index. |
ApiAddressResource
The following elements are required:
addressKey | (int) The key for address. |
isExternallyManaged | (bool) A flag indicating if the address is externally managed. |
country | (string) The country name. |
The following elements are optional:
streetName | (string) The street name. |
buildingNumber | (string) The house number. |
postalZone | (string) The postal code. |
cityName | (string) The city's name. |
pOBox | (string) The post office box. |
contactName | (string) The contact name. |
contactTitle | (string) The contact title. |
formattedAddress | (string) The formatted address. |
externalId | (string) The external identifier for the address. |
externalVersion | (string) The external version for the address. |
region | (string) The region's name. |
postalZoneRef | (string) The postal zone's reference. |
index | (int) The index. |