POST api/orders/amendments
Create amendment instructions for multiple orders.
Request Information
URI Parameters
None.
Body Parameters
List of amendment instructions.
Collection of AmendmentCreationName | Description | Type | Additional information |
---|---|---|---|
OrderID |
Order ID that this amendment is for. |
integer |
Required |
CreatorID |
The person ID whom this amendment is for. Required if you are submitting this instruction on behalf of a person. |
integer |
None. |
Quantity |
Quantity of the amendment |
integer |
Required |
Price |
Price of the amendment in dollars. Required for limit amendments. |
decimal number |
None. |
PriceType |
Amendment price type. |
enOrderPriceType |
Required |
PIN |
User PIN. Use this if PIN validation is required. |
string |
None. |
Request Formats
application/json, text/json
[ { "OrderID": 12345, "CreatorID": 1234, "Quantity": 1024, "Price": 12.55, "PriceType": 1, "PIN": "1234" }, { "OrderID": 28789, "CreatorID": 1234, "Quantity": 5500, "Price": null, "PriceType": 3, "PIN": "1111" } ]
application/xml, text/xml
<ArrayOfAmendmentCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order"> <AmendmentCreation> <CreatorID>1234</CreatorID> <OrderID>12345</OrderID> <PIN>1234</PIN> <Price>12.55</Price> <PriceType>Limit</PriceType> <Quantity>1024</Quantity> </AmendmentCreation> <AmendmentCreation> <CreatorID>1234</CreatorID> <OrderID>28789</OrderID> <PIN>1111</PIN> <Price i:nil="true" /> <PriceType>MarketToLimit</PriceType> <Quantity>5500</Quantity> </AmendmentCreation> </ArrayOfAmendmentCreation>
Response Information
Resource Description
List of amendment creation results.
Collection of AmendmentCreationResultName | Description | Type | Additional information |
---|---|---|---|
OrderID |
Order ID the amendment instruction was for. |
integer |
None. |
Success |
Status of the amendment. |
boolean |
None. |
Errors |
List of errors if the amendment failed. |
Collection of string |
None. |
Response Formats
application/json, text/json
[ { "OrderID": 12345, "Success": true, "Errors": null }, { "OrderID": 34567, "Success": false, "Errors": [ "Order is not active." ] } ]
application/xml, text/xml
<ArrayOfAmendmentCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order"> <AmendmentCreationResult> <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <OrderID>12345</OrderID> <Success>true</Success> </AmendmentCreationResult> <AmendmentCreationResult> <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>Order is not active.</d3p1:string> </Errors> <OrderID>34567</OrderID> <Success>false</Success> </AmendmentCreationResult> </ArrayOfAmendmentCreationResult>
Error Response Information
Resource Description
List of amendment creation results.
stringError Response Formats
application/json, text/json
"sample string 1"
application/xml, text/xml
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>