Search customers
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. | ||
| addition | varchar(255) | 1 | no | Primary address house number addition. | ||
| card_number | integer | 1 | no | Current card number. | ||
| indications | varchar(255) | N | yes | All indications. | ||
| restrictions | varchar(255) | N | yes | All restrictions. | ||
| current_budget | varchar(255) | 1 | no | Current disposal's budget. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
last_name | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
"\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003cresponse\u003e\n \u003cdata\u003e\n \u003cid\u003e1\u003c/id\u003e\n \u003cfirst_name\u003eAiden\u003c/first_name\u003e\n \u003cinitials\u003eA\u003c/initials\u003e\n \u003cinfix\u003e\u003c/infix\u003e\n \u003clast_name\u003eWillemsen\u003c/last_name\u003e\n \u003ccustomer_number\u003e77318\u003c/customer_number\u003e\n \u003cphone_number\u003e3177 1364761\u003c/phone_number\u003e\n \u003cmobile_phone_number/\u003e\n \u003cdate_of_birth\u003e1943-11-30T00:00:00+01:00\u003c/date_of_birth\u003e\n \u003czipcode\u003e5050TT\u003c/zipcode\u003e\n \u003chousenumber\u003e15\u003c/housenumber\u003e\n \u003caddition\u003eA\u003c/addition\u003e\n \u003ccard_number\u003e1858105\u003c/card_number\u003e\n \u003cindications\u003e\n \u003cindication\u003esocial-counselor\u003c/indication\u003e\n \u003cindication\u003etype-1\u003c/indication\u003e\n \u003c/indications\u003e\n \u003crestrictions/\u003e\n \u003cblocked\u003efalse\u003c/blocked\u003e\n \u003ccurrent_budget\u003e1850.00\u003c/current_budget\u003e\n \u003c/data\u003e\n \u003cdata\u003e\n \u003cid\u003e2\u003c/id\u003e\n \u003cfirst_name\u003eBas\u003c/first_name\u003e\n \u003cinitials\u003eB.R.\u003c/initials\u003e\n \u003cinfix\u003e\u003c/infix\u003e\n \u003clast_name\u003eWillemsen\u003c/last_name\u003e\n \u003ccustomer_number\u003e51314\u003c/customer_number\u003e\n \u003cphone_number\u003e+31615113161\u003c/phone_number\u003e\n \u003cmobile_phone_number/\u003e\n \u003cdate_of_birth\u003e1973-02-14T00:00:00+01:00\u003c/date_of_birth\u003e\n \u003czipcode\u003e7031BL\u003c/zipcode\u003e\n \u003chousenumber\u003e1B\u003c/housenumber\u003e\n \u003caddition/\u003e\n \u003ccard_number\u003e3130259\u003c/card_number\u003e\n \u003cindications\u003e\n \u003cindication\u003esocial-counselor\u003c/indication\u003e\n \u003cindication\u003etype-1\u003c/indication\u003e\n \u003c/indications\u003e\n \u003crestrictions/\u003e\n \u003cblocked\u003efalse\u003c/blocked\u003e\n \u003ccurrent_budget\u003e1850.00\u003c/current_budget\u003e\n \u003c/data\u003e\n\u003c/response\u003e"