46 Object Address

Object Address

A postal address can be assigned to any object.

API

POST /api/v1/object/address

Get or set the postal address for an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
addresses	JSON array	null OR json	Variant. JSON array of address objects.

addresses format:

Key	Type	Description
id	UUID	Variant. Address identifier.
parent	UUID	Optional. Parent identifier.
type	STRING	Optional. Address type code.
code	STRING	Required if no other keys are specified. KLADR code: CC SS RRR CCC TTT SSSS. Where: CC = country code; SS = federal subject code; RRR = district code; CCC = city code; TTT = settlement code; SSSS = street code.
index	STRING	Optional. Postal code (ZIP).
country	STRING	Optional. Country.
region	STRING	Optional. Region.
district	STRING	Optional. District.
city	STRING	Optional. City.
settlement	STRING	Optional. Settlement.
street	STRING	Optional. Street.
house	STRING	Optional. House number.
building	STRING	Optional. Building.
structure	STRING	Optional. Structure.
apartment	STRING	Optional. Apartment.
address	STRING	Optional. Full address as a string.

NOTE: If the id value is not specified or is null, a new postal address will be created; otherwise the existing address will be updated.

NOTE: If the addresses value is not specified or is null, the method works as Get; otherwise it works as Set.

Set

POST /api/v1/object/address/set

Associate a previously created postal address with an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
address	JSON array		Required. Address identifier.
datefrom	TIMESTAMP		Optional. Period start date.

Get

POST /api/v1/object/address/get

Retrieve the postal address associated with an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
fields	JSON array		Optional. JSON array of field names to return. If omitted, the request returns all fields.

List

POST /api/v1/object/address/list

Retrieve postal addresses for an object as a list.

Request parameters: Common list request parameters