Platform | Address

Service to manage entities of type 'Address'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/addresses

URL	api/{tenantKey}/{orgKey}/corePatterns/addresses
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Addresses
PUT:
DELETE:
- DELETE Address by identifier
- DELETE Address by key

All Resources

This service uses the following resources:

AddressResource
ApiAddressResource

GET Operations

GET Addresses

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses

GET /corePatterns/addresses

GET Addresses (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses?page={page}&pageSize={pageSize}

GET /corePatterns/addresses?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{id}

GET /corePatterns/addresses/{id}

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}

GET /corePatterns/addresses/{addressKey}

GET Print Address by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{id}/print?template={template}

GET /corePatterns/addresses/{id}/print?template={template}

GET Print Address by key

Prints the specified entity record.

The following elements are required:

addressKey

(int) The key for address.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/print

GET /corePatterns/addresses/{addressKey}/print

GET Original Print AddressOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{id}/printOriginal?template={template}

GET /corePatterns/addresses/{id}/printOriginal?template={template}

GET Original Print Address by key

Prints the specified entity record.

The following elements are required:

addressKey

(int) The key for address.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/printOriginal

GET /corePatterns/addresses/{addressKey}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses

POST /corePatterns/addresses

PUT Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/addressKey

PUT /corePatterns/addresses/{addressKey}/addressKey

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/buildingNumber

PUT /corePatterns/addresses/{addressKey}/buildingNumber

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/cityName

PUT /corePatterns/addresses/{addressKey}/cityName

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/contactName

PUT /corePatterns/addresses/{addressKey}/contactName

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/contactTitle

PUT /corePatterns/addresses/{addressKey}/contactTitle

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/country

PUT /corePatterns/addresses/{addressKey}/country

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/externalId

PUT /corePatterns/addresses/{addressKey}/externalId

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/externalVersion

PUT /corePatterns/addresses/{addressKey}/externalVersion

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/formattedAddress

PUT /corePatterns/addresses/{addressKey}/formattedAddress

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/index

PUT /corePatterns/addresses/{addressKey}/index

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/isActive

PUT /corePatterns/addresses/{addressKey}/isActive

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/isExternallyManaged

PUT /corePatterns/addresses/{addressKey}/isExternallyManaged

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/pOBox

PUT /corePatterns/addresses/{addressKey}/pOBox

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/postalZone

PUT /corePatterns/addresses/{addressKey}/postalZone

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/postalZoneRef

PUT /corePatterns/addresses/{addressKey}/postalZoneRef

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/region

PUT /corePatterns/addresses/{addressKey}/region

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}/streetName

PUT /corePatterns/addresses/{addressKey}/streetName

DELETE Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{id}

DELETE /corePatterns/addresses/{id}

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:

api/{tenantKey}/{orgKey}/corePatterns/addresses/{addressKey}

DELETE /corePatterns/addresses/{addressKey}

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.