PUT | /customers/{customerId}/officers/{id} | Updates an existing Officer entry for this Customer. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The customer Id. |
Id | path | Guid | Yes | The officer Id. |
Name | body | string | Yes | The label or name of the Officer. |
PhoneNumber | body | string | No | The phone number of the Officer. |
IsDeleted | body | bool | Yes | Whether the Officer is deleted. |
CanAuthorizeRelease | body | bool | No | Whether the Officer can authorize release. |
IsOfficer | body | bool | No | Whether the Officer is a Booting Officer. |
IsEnforcementOfficer | body | bool | No | Whether the Officer is an Enforcement Officer. |
RequiredToLoginForBooting | body | 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.
PUT /customers/{customerId}/officers/{id} HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerOfficer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<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>
</UpdateCustomerOfficer>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>