POST api/Transport/cancel/{id}

Cancels a Transport Request

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID value of the Transport to Cancel

integer

Required

Body Parameters

A JSON object with the parameters {"CancelReasonID":x,"Description":y}

TransportCancelParameters
NameDescriptionTypeAdditional information
CamcelReasonID

integer

None.

Description

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CamcelReasonID": 1,
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<TransportCancelParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aramark.ISIS.Web.Api.Models">
  <CamcelReasonID>1</CamcelReasonID>
  <Description>sample string 2</Description>
</TransportCancelParameters>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TransportCancelParameters'.

Response Information

Resource Description

True if successful, False otherwise

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>