POST api/orders/amendment

Create a amendment instruction for an order.

Request Information

URI Parameters

None.

Body Parameters

Amendment creation object.

Name	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

Sample:

{
  "OrderID": 12345,
  "CreatorID": 1234,
  "Quantity": 1024,
  "Price": 12.55,
  "PriceType": 1,
  "PIN": "1234"
}

application/xml, text/xml

Sample:

<AmendmentCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <CreatorID>1234</CreatorID>
  <OrderID>12345</OrderID>
  <PIN>1234</PIN>
  <Price>12.55</Price>
  <PriceType>Limit</PriceType>
  <Quantity>1024</Quantity>
</AmendmentCreation>

Response Information

Resource Description

Amendment creation result.

AmendmentCreationResult

Name	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

Sample:

{
  "OrderID": 12345,
  "Success": true,
  "Errors": null
}

application/xml, text/xml

Sample:

<AmendmentCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OrderID>12345</OrderID>
  <Success>true</Success>
</AmendmentCreationResult>

Error Response Information

Resource Description

Amendment creation result.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>