Create new address
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new address
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
The Post /addresses/ Operation allows users to create a new address, available from product version 3.0.22. It requires an API Key for authorization and accepts various body parameters, including building details such as buildingId, buildingName, city, country, and street information. The request must be in application/json format. Successful creation returns a 201 response with the address details, including creation timestamps and identifiers. The address can be marked as default, with restrictions on modification or deletion. Error responses include a 400 status for validation failures, detailing which fields failed, and a 401 status for missing or invalid authentication credentials. The API is designed to ensure proper address management while maintaining security and data integrity.
Did you find this summary helpful?
Thank you for your feedback
Post
/addresses/
Operation is used to create new address. Available from product version 3.0.22.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
address to be created
object
buildingId
string
Building id
buildingName
string
Building name
city
string Required
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
district
string
Building district
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
integer
Source system id
sourceSystemKey
integer
Source system key
streetname
string Required
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
usagePurpose
integer
Building Usage id
usagePurposeAlt
integer
Address Secondary Usage id
zipcode
string
Building zipcode
Responses
201
A created Address
object
buildingId
string
Building id
buildingName
string
Building name
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
empty
integer
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Valid values[ 0, 1 ]
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
integer
Source system id
sourceSystemKey
integer
Source system key
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
integer
Building Usage id
usagePurposeAlt
integer
Address Secondary Usage id
zipcode
string
Building zipcode
400
There was an error in request. Usually field validation failed.
object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
