Authentication Level:
This module delivers all address information.
Authentication Level: Service
Description:
Create new client address.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
data required | Array | Address data to be added (required). |
null |
Example Request:
{ "data": { "first_name": "Testvorname", "last_name": "Testnachname", "company": "Testcompany Inc.", "address": "Teststreet", "zip": "12345", "city": "Testcity", "countrycode": "de", "client_id": 123 } }
Authentication Level: Service
Description:
Delete a single address by given id.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id required | Integer | Unique ID of address (required). |
null |
Example Request:
{ "id": 123 }
Authentication Level: Service
Description:
Edit an existing address.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id required | Integer | Id of address to udate (required). |
null |
data required | Array | Address properties to be changed (required). |
null |
Example Request:
{ "id": 123, "data": { "name": "New Name", "zip": "54321", "countrycode": "fr" } }
Authentication Level: Service
Description:
Access data of one single address by its id.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id required | Integer | Unique ID of address (required). |
null |
Example Request:
{ "id": 123 }
Authentication Level: Service
Description:
Get all available addresses.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
client_id | Integer | Unique ID of client. |
null |
type | String | Address type to filter. |
null |
Authentication Level: Service
Description:
Get all addresses for given client id.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
client_id required | Integer | Unique ID of client (required). |
null |
Example Request:
{ "client_id": 123 }