POST api/BX/CancelBX

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BXOrgid	string	None.
BXName	string	None.
BXPassword	string	None.
PolicyNos	Collection of string	None.
ShortName	string	None.
OutOrderID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BXOrgid": "sample string 1",
  "BXName": "sample string 2",
  "BXPassword": "sample string 3",
  "PolicyNos": [
    "sample string 1",
    "sample string 2"
  ],
  "ShortName": "sample string 4",
  "OutOrderID": "sample string 5"
}

application/xml, text/xml

Sample:

<RequestCancelBX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.TPS.Model.Request.BX">
  <BXName>sample string 2</BXName>
  <BXOrgid>sample string 1</BXOrgid>
  <BXPassword>sample string 3</BXPassword>
  <OutOrderID>sample string 5</OutOrderID>
  <PolicyNos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PolicyNos>
  <ShortName>sample string 4</ShortName>
</RequestCancelBX>

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 'RequestCancelBX'.

Response Information

Resource Description

ExecuteResultOfListOfResponseCancelBX

Name	Type	Additional information
Data	Collection of ResponseCancelBX	None.
Success	boolean	None.
IsSuccess	boolean	None.
Msg	string	None.
Code	integer	None.
StatusCode	string	None.
Errors	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "IsSuccess": true,
      "NoteMsg": "sample string 2",
      "PolicyNo": "sample string 3"
    },
    {
      "IsSuccess": true,
      "NoteMsg": "sample string 2",
      "PolicyNo": "sample string 3"
    }
  ],
  "Success": true,
  "IsSuccess": true,
  "Msg": "sample string 3",
  "Code": 4,
  "StatusCode": "sample string 5",
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ExecuteResultOfArrayOfResponseCancelBXNMWaovsj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZTSoft.Core">
  <Code>4</Code>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <Msg>sample string 3</Msg>
  <StatusCode>sample string 5</StatusCode>
  <Success>true</Success>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ZTSoft.TPS.Model.Response.BX">
    <d2p1:ResponseCancelBX>
      <d2p1:IsSuccess>true</d2p1:IsSuccess>
      <d2p1:NoteMsg>sample string 2</d2p1:NoteMsg>
      <d2p1:PolicyNo>sample string 3</d2p1:PolicyNo>
    </d2p1:ResponseCancelBX>
    <d2p1:ResponseCancelBX>
      <d2p1:IsSuccess>true</d2p1:IsSuccess>
      <d2p1:NoteMsg>sample string 2</d2p1:NoteMsg>
      <d2p1:PolicyNo>sample string 3</d2p1:PolicyNo>
    </d2p1:ResponseCancelBX>
  </Data>
</ExecuteResultOfArrayOfResponseCancelBXNMWaovsj>