BootView WebApi

<back to all web services

UpdateAssistedRelease

The following routes are available for this service:
PUT/assistedreleases/{id}Use this to move items from Queued to Dispatched (i.e. Dispatch a boot) and Dispatched to Queued (i.e. Un-Dispatch a boot).
UpdateAssistedRelease Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe unique boot collection attempt Id
AssistedReleaseStatusbodyAssistedReleaseStatusYesThe status that you want to update the Boot Attempt to (Queued | Dispatched). If you try to update to the same status (i.e. from Queued to Queued), nothing will happen, and the response will be Success=false.
OfficerNamebodystringNoThe name of the officer dispatched is required when Dipatching a boot for release but not when Un-dispatching
AssistedReleaseStatus Enum:
NameValue
Both0
Unknown1
Queued5
Dispatched6

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.

PUT /assistedreleases/{id} HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAssistedRelease xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AssistedReleaseStatus>Both</AssistedReleaseStatus>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <OfficerName>String</OfficerName>
</UpdateAssistedRelease>

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>