POST api/report/takeovers

Generate Takeovers Reporting report.

Request Information

URI Parameters

None.

Body Parameters

Takeovers report 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
SecurityCode	Security Code to filter on.	string	None.
FacilityID	ML Facilty ID (Wrap Number) to filter on.	string	None.
ClientID	Client ID to filter on.	integer	None.
ClientExternalRef	Client Exteranl Ref to filter on.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDateTime": "2022-01-20T00:00:00",
  "EndDateTime": "2022-01-20T23:59:00",
  "SecurityCode": "BHP",
  "FacilityID": "ABC10001000",
  "ClientID": 100500,
  "ClientExternalRef": "Nicholas"
}

application/xml, text/xml

Sample:

<TakeoversReportCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Report">
  <ClientExternalRef>Nicholas</ClientExternalRef>
  <ClientID>100500</ClientID>
  <EndDateTime>2022-01-20T23:59:00</EndDateTime>
  <FacilityID>ABC10001000</FacilityID>
  <SecurityCode>BHP</SecurityCode>
  <StartDateTime>2022-01-20T00:00:00</StartDateTime>
</TakeoversReportCreation>

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>