Schemas Postman

Postal Address. Fetch data by request POST

Get Client Postal Address data by request

# ENDPOINT
/api/clientPostalAddress/getData/clientPostalAddressSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: clientPostalAddressSearchRequest
Type: object
Variable Name Type Format Usage Description
address_type address_type string The addresses section provides the list of all available addresses a contact has as follows
List of allowed values in field (value=>name):
  • 0
    DELIVERY
  • 1
    LEGAL
  • 2
    OTHER
  • 3
    PHYSICAL
  • 4
    STATEMENT
address_type_description address_type_description string Address type description
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_full_name client_full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
counterparty_id counterparty_id integer INT64 Counterparty id
language language string The language user has specified as the language of service
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: clientPostalAddress
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data array data of Response
attribute: data
Variable Name Type Format Description
action Action string
activation_date Activation Date string DATE Activation date in the system
address_type address_type string The addresses section provides the list of all available addresses a contact has as follows
address_type_description address_type_description string Address type description
apartment apartment string Residence/correspondence number of house
card_code card_code string Card code
city city string Residence/ correspondence address city/town
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_full_name client_full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
counterparty_id counterparty_id integer INT64 Counterparty id
country_code country_code string Two-letter ISO 3166-2 code of a given country
country_description country_description string Country of residence or incorporation
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
expiration_date Expiration Date string DATE Expiration date in the system
form_title form_title string Service field
full_address full_address string Customer full address aggregates [Address Line 1], [Address Line 2], [City], [County], [Post Code] and [Country] fields
house house string Residence/correspondence number of house
house_name house_name string Residence/correspondence name of house
id id integer INT64 Record's sequence number generated in the system.
language language string The language user has specified as the language of service
latitude latitude number decimal A geographic coordinate that specifies the north–south position of a point on the Earth is surface
longitude longitude number decimal A geographic coordinate that specifies the east–west position of a point on the Earth is surface
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
place_code place_code string Residence/correspondence place code
post_code post_code string Shows the value of address postal code, zip code or post code, like CR2 9ER
region region string Residence/ correspondence region
region_code region_code string Region code
state state integer INT64 Record state for replication
street street string Residence/ correspondence name of street
sub_street sub_street string Residence/ correspondence name of substreet
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# Other endpoints
Name Endpoint
Postal Address. Fetch data by ID /model/clientPostalAddress/getDb/{id}
Postal Address. Validate data /model/clientPostalAddress/validate
Postal Address. Prepare data /model/clientPostalAddress/prepare
Postal Address. Create/update data /model/clientPostalAddress/putDb
Postal Address. Delete item by ID /api/clientPostalAddress/deleteItem/{id}