| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfCustomerOfficer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<CustomerOfficer>
<CanAuthorizeRelease>false</CanAuthorizeRelease>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsDeleted>false</IsDeleted>
<IsEnforcementOfficer>false</IsEnforcementOfficer>
<IsOfficer>false</IsOfficer>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<RequiredToLoginForBooting>false</RequiredToLoginForBooting>
<Type>String</Type>
</CustomerOfficer>
</ArrayOfCustomerOfficer>