Search customer
GET {{AppUrl}}/api/v1/agency/customer/search?last_name={{LastName}}
Introduction
Search all customers within the following fields: - lastname: Last name - dateofbirth: Date of birth (Y-m-d) - cardnumber: Card number - phone_number: Phone number
It is possible to combine these fields, at least one must be given. No other fields are searchable.
Structure
| Item | Type | Plurality | Required | Description | ||
|---|---|---|---|---|---|---|
| id | integer | 1 | yes | |||
| first_name | varchar(255) | 1 | yes | First name. | ||
| initials | varchar(255) | 1 | yes | Initials. | ||
| infix | varchar(255) | 1 | no | Infix. | ||
| last_name | varchar(255) | 1 | yes | Last name. | ||
| customer_number | integer | 1 | yes | Customer number (identifier for municipalities). | ||
| phone_number | varchar(255) | 1 | yes | Phone number. | ||
| mobilephonenumber | varchar(255) | 1 | no | Mobile phone number. | ||
| dateofbirth | DateTime | 1 | yes | Date of birth. | ||
| zipcode | varchar(255) | 1 | no | Primary address zipcode. | ||
| housenumber | varchar(255) | 1 | no | Primary address house number. | ||
| card_number | integer | 1 | no | Current card number. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
last_name | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":1,"first_name":"Aiden","initials":"A","infix":"","last_name":"Willemsen","customer_number":77318,"phone_number":"3177 1364761","mobile_phone_number":null,"date_of_birth":"1943-11-30T00:00:00+01:00","zipcode":"5050TT","housenumber":"15","card_number":1858105},{"id":1,"first_name":"Bas","initials":"B.R.","infix":"","last_name":"Willemsen","customer_number":51314,"phone_number":"+31615113161","mobile_phone_number":null,"date_of_birth":"1973-02-14T00:00:00+01:00","zipcode":"7031BL","housenumber":"1B","card_number":null}]}