BootView WebApi

<back to all web services

GetCustomerOfficers

The following routes are available for this service:
GET/customers/{id}/officersGets the list of officers for the given customer. If the current user doesn't have access to this customer, the service returns an error.
GetCustomerOfficers Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe customer id.
IsDeletedqueryboolNoWhether the Officer is deleted.
CanAuthorizeReleasequeryboolNoWhether the Officer can authorize release.
IsOfficerqueryboolNoWhether the Officer is a Booting Officer.
IsEnforcementOfficerqueryboolNoWhether the Officer is an Enforcement Officer.
RequiredToLoginForBootingqueryboolNoWhether 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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetCustomerOfficers HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetCustomerOfficers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CanAuthorizeRelease>false</CanAuthorizeRelease>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsDeleted>false</IsDeleted>
  <IsEnforcementOfficer>false</IsEnforcementOfficer>
  <IsOfficer>false</IsOfficer>
  <RequiredToLoginForBooting>false</RequiredToLoginForBooting>
</GetCustomerOfficers>
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>