Contacts

This endpoint can be used to retrieve, create, update and remove contacts

Reference

GET /contacts/<userId>/[<contactId>]

Retrieve all contacts of a user or a single contact

POST /contacts/

Create a new contact

PUT /contacts/

Update an existing contact

DELETE /contacts/

Remove a contact

General search parameters

field	type	description/constraints	Req	W	U
useCache	boolean	Use API caching module	No	No	No
page	int	Show page x from resultset (default: 1)	No	No	No
itemsPerPage	int	Number of items per page Minimum: 1 item Maximum 100 items (default: 25)	No	No	No

Fields

field	type	constraints	Req	W	U
userId	int		Yes	Yes	No
contactId	int		No	No	No
active	boolean	Is this contact currently used in one or more active advertisements	No	No	No
name	string	The name 2 - 255 characters	Yes/No	Yes	Yes
address	string	2 - 255 characters	Yes	Yes	Yes
houseNumber	string	max 20 characters	Yes	Yes	Yes
postalCode	string	A valid Dutch postal code Not mandatory when the user is abroad. See also: county and country	Yes/No	Yes	Yes
city	string	2 - 255 characters	Yes	Yes	Yes
county	string	Available options:	Yes	Yes	Yes
		- DR
		- FL
		- FR
		- GE
		- GR
		- LI
		- NB
		- NH
		- OV
		- UT
		- ZE
		- ZH
		- ZH
		Leave empty when user is not in the Netherlands
phone	string	min 5 charactersmax 50 characters	Yes	Yes	Yes
website	string		No	Yes	Yes
skype	string	Skype-handle	No	Yes	Yes

Example retrieving Contacts

Request

GET /rest/v1/contacts/4/ HTTP/2

or

GET /rest/v1/users/4/1

Response

{
  "result": true,
  "errors": [],
  "data": [
    {
      "userId": 12311,
      "contactId": 0,
      "active": false,
      "name": "Bedrijfsnaam",
      "address": "Straatnaam",
      "houseNumber": "19b",
      "postalCode": "2818 AA",
      "city": "Zoetermeer",
      "county": "ZH",
      "country": "NL",
      "phone": "079-1234567",
      "website": "www.test.nl",
      "skype": ""
    }
  ]
}

Example creating contact

Request

POST /rest/v1/contacts/ HTTP/2

{
  "userId": 12311,
  "name": "contact naam",
  "address": "Straatnaam",
  "houseNumber": "19b",
  "postalCode": "2818 AA",
  "city": "Zoetermeer",
  "county": "ZH",
  "country": "NL",
  "phone": "079-1234567",
  "website": "www.test.nl",
  "skype": ""
}

Response

{
  "result": true,
  "errors": [],
  "data": [
    {
      "userId": 12311,
      "contactId": 2,
      "active": false,
      "name": "contact naam",
      "address": "Straatnaam",
      "houseNumber": "19b",
      "postalCode": "2818 AA",
      "city": "Zoetermeer",
      "county": "ZH",
      "country": "NL",
      "phone": "079-1234567",
      "website": "www.test.nl",
      "skype": ""
    }
  ]
}

Example updating contact

Request

PUT /rest/v1/contacts/ HTTP/2

{
  "userId": 12311,
  "contactId": 2,
  "name": "contact naam",
  "address": "Straatnaam",
  "houseNumber": "19b",
  "postalCode": "2818 AA",
  "city": "Zoetermeer",
  "county": "ZH",
  "country": "NL",
  "phone": "079-1234567",
  "website": "www.test.nl",
  "skype": ""
}

Response

{
  "result": true,
  "errors": [],
  "data": [
    {
      "userId": 12311,
      "contactId": 2,
      "active": true,
      "name": "contact naam",
      "address": "Straatnaam",
      "houseNumber": "19b",
      "postalCode": "2818 AA",
      "city": "Zoetermeer",
      "county": "ZH",
      "country": "NL",
      "phone": "079-1234567",
      "website": "www.test.nl",
      "skype": ""
    }
  ]
}

Example removing contact

Request

DELETE /rest/v1/contacts/ HTTP/2

{
  "userId": 12311,
  "contactId": 1
}

Response

{
  "result": false,
  "errors": [],
  "data": [
    {
      "userId": 12311,
      "contactId": 2,
      "active": true,
      "name": "Bedrijfsnaam",
      "address": "Straatnaam",
      "houseNumber": "19b",
      "postalCode": "2818 AA",
      "city": "Zoetermeer",
      "county": "ZH",
      "country": "NL",
      "phone": "079-1234567",
      "website": "www.test.nl",
      "skype": ""
    }
  ]
}