Contactpersons

Get contact persons

get

/contactpersons/

This api is used to sync contact persons with WorkorderApp. A contact person should always be related to a certain client. cpn_code is used as a unique reference to either insert or update the address. Each address record can contain the following data:

Parameter	Description	Required	Type (size)
cpn_debtor_nr	Debtor number of the relation	Y	Varchar (255)
cpn_code	Unique code of the contact person. Used as reference in the workorder.	Y	Varchar (255)
cpn_name	Name of the contact person.	Y	Varchar (255)
cpn_phone	Phone of the contact person.	N	Varchar (255)
cpn_email	Email of the contact person.	N	Varchar (255)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Response_200

No content

get/contactpersons/

GET /contactpersons/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

No content

Add contact persons

post

/contactpersons/

This api is used to sync contact persons with WorkorderApp. A contact person should always be related to a certain client. cpn_code is used as a unique reference to either insert or update the address. Each address record can contain the following data:

Parameter	Description	Required	Type (size)
cpn_debtor_nr	Debtor number of the relation	Y	Varchar (255)
cpn_code	Unique code of the contact person. Used as reference in the workorder.	Y	Varchar (255)
cpn_name	Name of the contact person.	Y	Varchar (255)
cpn_phone	Phone of the contact person.	N	Varchar (255)
cpn_email	Email of the contact person.	N	Varchar (255)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Response_200

No content

post/contactpersons/

POST /contactpersons/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

No content

Get contact by filter

get

/contactperson/

This api is used to fetch contactpersons based on a filter. Filters can be given by adding a key and values array to the URL. Adding a single filter: &key=key1&value=value1 Adding multiple filters: &key[]=key1&value[]=value1&key[]=key2&value[]=value2

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

keystringOptionalExample: cpn_debtor_nr

valueintegerOptionalExample: 82

Responses

200

Response_200

No content

get/contactperson/

GET /contactperson/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response_200

No content