PUT | /collectionattempts/{id}/lockorunlock | Updates locked or unlocked state of collection attempt. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The Collection Attempt Id. |
LockCollectionAttempt | body | string | Yes | The Customer Reference Number. |
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 /collectionattempts/{id}/lockorunlock HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateLockOrUnlockCollectionAttempt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<Id>00000000-0000-0000-0000-000000000000</Id>
<LockCollectionAttempt>false</LockCollectionAttempt>
</UpdateLockOrUnlockCollectionAttempt>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">false</boolean>