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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length [ { name: String, type: String, phoneNumber: String, isDeleted: False, canAuthorizeRelease: False, isOfficer: False, isEnforcementOfficer: False, requiredToLoginForBooting: False } ]