API Resource - Addresses

Authentication Level:

This module delivers all address information.

Route overview

Name	Description	Authentication
add	Create new client address.	Service
delete	Delete single address.	Service
edit	Edit existing address.	Service
get	Get single address.	Service
getAll	Get all available addresses.	Service
getByClient	Get all addresses for given client id.	Service

/service/addresses/add post

Authentication Level: Service

Description:

Create new client address.

Request parameter:

Field	Type	Description	Default
data required	Array	Address data to be added (required).	null

Request examples

Example Request:

{
	"data": {
		"first_name": "Testvorname",
		"last_name": "Testnachname",
		"company": "Testcompany Inc.",
		"address": "Teststreet",
		"zip": "12345",
		"city": "Testcity",
		"countrycode": "de",
		"client_id": 123
	}
}

/service/addresses/delete post

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

Request examples

Example Request:

{
  "id": 123
}

/service/addresses/edit post

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

Request examples

Example Request:

{
	"id": 123,
	"data": {
		"name": "New Name",
		"zip": "54321",
		"countrycode": "fr"
	}
}

/service/addresses/get post

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

Request examples

Example Request:

{
  "id": 123
}

/service/addresses/getAll post

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

/service/addresses/getByClient post

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

Request examples

Example Request:

{
  "client_id": 123
}