POST api/orders/amendment/active

Create an active amendment instruction for an order.

Request Information

URI Parameters

None.

Body Parameters

Active 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
MarketReference	Reference used to match order on markets.	string	String length: inclusive between 0 and 50
NotesForClient	Order notes for client.	string	String length: inclusive between 0 and 1000
ClientBrokerageScheduleID	Client brokerage schedule ID.	integer	None.
OrderGiver	Order Giver	string	None.
CustomBrokerageFee	Custom Brokerage Fee. e.g. 50.50	decimal number	None.
CustomBrokeragePercent	Custom Brokerage Percent. e.g. 0.5 = 50%	decimal number	None.
RegistrationType	Order registration type.	enOrderSettlementType	None.
RegistrationDetail	Order registration detail.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 12345,
  "CreatorID": 1234,
  "Quantity": 1024,
  "Price": 12.55,
  "PriceType": 1,
  "MarketReference": "12345",
  "NotesForClient": "ABCDEF",
  "ClientBrokerageScheduleID": null,
  "OrderGiver": "Order Giver Testing",
  "CustomBrokerageFee": null,
  "CustomBrokeragePercent": 2.7778,
  "RegistrationType": 2,
  "RegistrationDetail": "I1234567890"
}

application/xml, text/xml

Sample:

<AmendmentActiveCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <ClientBrokerageScheduleID i:nil="true" />
  <CreatorID>1234</CreatorID>
  <CustomBrokerageFee i:nil="true" />
  <CustomBrokeragePercent>2.777800</CustomBrokeragePercent>
  <MarketReference>12345</MarketReference>
  <NotesForClient>ABCDEF</NotesForClient>
  <OrderGiver>Order Giver Testing</OrderGiver>
  <OrderID>12345</OrderID>
  <Price>12.55</Price>
  <PriceType>Limit</PriceType>
  <Quantity>1024</Quantity>
  <RegistrationDetail>I1234567890</RegistrationDetail>
  <RegistrationType>IssuerSponsored</RegistrationType>
</AmendmentActiveCreation>

Response Information

Resource Description

Active amendment creation result.

AmendmentActiveCreationResult

Name	Description	Type	Additional information
OrderAmendmentID	Order amendment ID of amendment instruction was for.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderAmendmentID": 12345
}

application/xml, text/xml

Sample:

<AmendmentActiveCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <OrderAmendmentID>12345</OrderAmendmentID>
</AmendmentActiveCreationResult>

Error Response Information

Resource Description

Active 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>