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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	id: 00000000000000000000000000000000,
	isDeleted: False,
	canAuthorizeRelease: False,
	isOfficer: False,
	isEnforcementOfficer: False,
	requiredToLoginForBooting: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		id: 00000000000000000000000000000000,
		name: String,
		type: String,
		phoneNumber: String,
		customerId: 00000000000000000000000000000000,
		isDeleted: False,
		canAuthorizeRelease: False,
		isOfficer: False,
		isEnforcementOfficer: False,
		requiredToLoginForBooting: False
	}
]