| GET | /customers/{id}/officers | Gets the list of officers for the given customer. If the current user doesn't have access to this customer, the service returns an error. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | Guid | Yes | The customer id. |
| IsDeleted | query | bool | No | Whether the Officer is deleted. |
| CanAuthorizeRelease | query | bool | No | Whether the Officer can authorize release. |
| IsOfficer | query | bool | No | Whether the Officer is a Booting Officer. |
| IsEnforcementOfficer | query | bool | No | Whether the Officer is an Enforcement Officer. |
| RequiredToLoginForBooting | query | bool | No | Whether the Officer is Required to Login for Booting Operations |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{id}/officers HTTP/1.1
Host: api.paylock.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"id":"00000000000000000000000000000000","name":"String","type":"String","phoneNumber":"String","customerId":"00000000000000000000000000000000","isDeleted":false,"canAuthorizeRelease":false,"isOfficer":false,"isEnforcementOfficer":false,"requiredToLoginForBooting":false}]