POST api/report/orderReporting

Generate Order Reporting report.

Request Information

URI Parameters

None.

Body Parameters

Order reporting creation instruction.

Name	Description	Type	Additional information
StartDateTime	Start date time to filter in standard ISO format YYYY-MM-DDTHH:mm:ss.sssZ.	date	Required
EndDateTime	End date time to filter in standard ISO format YYYY-MM-DDTHH:mm:ss.sssZ.	date	Required
ClientIDs	List of client IDs to filter on.	Collection of integer	None.
SecurityCodes	List of security codes to filter on.	Collection of string	None.
SponsorshipTypes	List of sponsorship types to filter on.	Collection of enOrderSettlementType	Required
ShowBookedOrderOnly	Order with booked quantity value greater than 0.	boolean	None.
OrderStatuses	List of order status to filter on.	Collection of enOrderStatus	Required
ShowLatestOrderOnly	Flag to return latest or all order data	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "StartDateTime": "2022-01-20T00:00:00",
  "EndDateTime": "2022-01-20T23:59:00",
  "ClientIDs": [
    100500,
    100501
  ],
  "SecurityCodes": [
    "ABC",
    "DEF"
  ],
  "SponsorshipTypes": [
    1
  ],
  "ShowBookedOrderOnly": true,
  "OrderStatuses": [
    1
  ],
  "ShowLatestOrderOnly": true
}

application/xml, text/xml

Sample:

<OrderReportingCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Report">
  <ClientIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>100500</d2p1:int>
    <d2p1:int>100501</d2p1:int>
  </ClientIDs>
  <EndDateTime>2022-01-20T23:59:00</EndDateTime>
  <OrderStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities">
    <d2p1:enOrderStatus>Active</d2p1:enOrderStatus>
  </OrderStatuses>
  <SecurityCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>ABC</d2p1:string>
    <d2p1:string>DEF</d2p1:string>
  </SecurityCodes>
  <ShowBookedOrderOnly>true</ShowBookedOrderOnly>
  <ShowLatestOrderOnly>true</ShowLatestOrderOnly>
  <SponsorshipTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities">
    <d2p1:enOrderSettlementType>BrokerSponsored</d2p1:enOrderSettlementType>
  </SponsorshipTypes>
  <StartDateTime>2022-01-20T00:00:00</StartDateTime>
</OrderReportingCreation>

Response Information

Resource Description

Order reporting creation result.

ReportCreationResult

Name	Description	Type	Additional information
ReportID	Report ID created	integer	None.
Type	Type of report created.	enReportType	None.
Status	Report created status.	enReportStatus	None.
DateTimeRequested	Date and time the report created.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "ReportID": 123456,
  "Type": 177,
  "Status": 1,
  "DateTimeRequested": "2022-02-04T11:32:00"
}

application/xml, text/xml

Sample:

<ReportCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Report">
  <DateTimeRequested>2022-02-04T11:32:00</DateTimeRequested>
  <ReportID>123456</ReportID>
  <Status>Pending</Status>
  <Type>OrderReporting</Type>
</ReportCreationResult>

Error Response Information

Resource Description

Order reporting 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>