Trading:QueryRequestStatuses

Requests the valid Pending Request Status definitions. Use the Provider property on an Account.

Controller: Trading
Topic: QueryRequestStatuses
Action: Publish
Permissions: None

Request

Name	Type	Expect	Description
Provider	String	Always	The trading data provider to get Request Statuses for

Response

An unordered array of Request Status objects.

Request Status object

An Request Status is uniquely identified by the Code.

Name	Type	Expect	Description
Code	String	Always	The code identifying this Request Status.
Allows	String	Always	The allowed actions in this state. One or more of the following values, separated by commas: None: No actions permitted. Amend: The Request is able to be amended. Cancel: The Request is able to be cancelled. All: The Request can amend or cancel.
Reason	String	Always	The reasons behind this state. One or more of the following values, separated by commas: Unknown: The reason is unknown. Normal: State is a normal part of the Request lifecycle. Manual: State was initiated manually. Abnormal: State is abnormal, indicating a fault or other issue. Completed: State represents a completed Request. Waiting: State is due to a temporary wait

Example

Send:

{"Controller":"Trading","Topic":"QueryRequestStatuses","TransactionID":1,"Data":{"Provider":"Motif[Demo]"}}

Receive:

{
 "Controller":"Trading",
 "Topic":"QueryRequestStatuses",
 "Data":
 [
  {
   "Code":"Pending", "Reason":"Normal,Waiting", "Allows":"None"
  },
  {
   "Code":"Queued", "Reason":"Normal","Allows":"Amend,Cancel"
  },
  {
   "Code":"Submitted", "Reason":"Normal,Waiting","Allows":"None"
  },
  {
   "Code":"Completed", "Reason":"Normal,Completed","Allows":"None"
  },
  {
   "Code":"Rejected", "Reason":"Abnormal,Completed","Allows":"None"
  }
 ],
 "TransactionID":1
}