POST api/v1/HoldingOrderDelete

Special routine to delete data to Caliq holding order - not normally used

Request Information

URI Parameters

None.

Body Parameters

HoldingOrderDeleteParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
WebOrderRef

Website Order reference

 string

Required

Max length: 50
AccountNo

User entered unique customer account number

 string

Required

Max length: 10

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1",
  "WebOrderRef": "sample string 2",
  "AccountNo": "sample string 3"
}

application/xml, text/xml

Sample: 
<HoldingOrderDeleteParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <WebOrderRef>sample string 2</WebOrderRef>
  <AccountNo>sample string 3</AccountNo>
</HoldingOrderDeleteParams>

Response Information

Resource Description

Returns:
200 OK
204 Not Found - the supplied web ref could not be found
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

OrderCreateResults
NameDescriptionTypeAdditional information
OrderCreateData

OrderCreateData

None.

Response Formats

application/json, text/json

Sample: 
{
  "OrderCreateData": {
    "OK": true,
    "OrderID": 2,
    "OrderNo": 3,
    "OrderCreateIssues": [
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      },
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<OrderCreateResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderCreateData>
    <OK>true</OK>
    <OrderID>2</OrderID>
    <OrderNo>3</OrderNo>
    <OrderCreateIssues>
      <OrderCreateIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </OrderCreateIssue>
      <OrderCreateIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </OrderCreateIssue>
    </OrderCreateIssues>
  </OrderCreateData>
</OrderCreateResults>