POST api/account/task/srn-search-task
Submit SRN Enquiry Task
Request Information
URI Parameters
None.
Body Parameters
SRNEnquiryTaskCreationName | Description | Type | Additional information |
---|---|---|---|
SecurityCode |
Security code |
string |
Required String length: inclusive between 1 and 12 |
AccountName |
Account name |
string |
Required String length: inclusive between 1 and 80 |
Designation |
Designation |
string |
String length: inclusive between 0 and 35 |
AddressLine1 |
Address line 1 |
string |
Required String length: inclusive between 1 and 40 |
AddressLine2 |
Address line 2 |
string |
String length: inclusive between 0 and 40 |
AddressLine3 |
Address line 3 |
string |
String length: inclusive between 0 and 40 |
TownName |
Town name |
string |
Required String length: inclusive between 1 and 35 |
Postcode |
Postcode |
string |
String length: inclusive between 0 and 16 |
State |
State |
string |
String length: inclusive between 0 and 35 |
Country |
Country code (2 letter) |
string |
Required String length: inclusive between 1 and 2 |
Request Formats
application/json, text/json
{ "SecurityCode": "BHP", "AccountName": "Mr John Doe", "Designation": "", "AddressLine1": "2 Barrack Street", "AddressLine2": "", "AddressLine3": "", "TownName": "Perth", "Postcode": "6000", "State": "WA", "Country": "AU" }
application/xml, text/xml
<SRNEnquiryTaskCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks"> <AccountName>Mr John Doe</AccountName> <AddressLine1>2 Barrack Street</AddressLine1> <AddressLine2></AddressLine2> <AddressLine3></AddressLine3> <Country>AU</Country> <Designation></Designation> <Postcode>6000</Postcode> <SecurityCode>BHP</SecurityCode> <State>WA</State> <TownName>Perth</TownName> </SRNEnquiryTaskCreation>
Response Information
Resource Description
SRNEnquiryTaskResponse
SRNEnquiryTaskResponseName | Description | Type | Additional information |
---|---|---|---|
SRNEnquiryTaskID |
SRNEnquiryTaskID |
integer |
None. |
SecurityCode |
SecurityCode |
string |
None. |
TaskStatus |
SRN Enquiry task status |
enTaskStatus |
None. |
RejectedReason |
Rejected Reason if SRN Search being rejected |
string |
None. |
SRN |
Security Holder Reference Number (SRN) - Result of SRN Search Enquiry |
string |
None. |
Response Formats
application/json, text/json
{ "SRNEnquiryTaskID": 100001, "SecurityCode": "BHP", "TaskStatus": 3, "RejectedReason": "", "SRN": "I0030032XXX" }
application/xml, text/xml
<SRNEnquiryTaskResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks"> <RejectedReason></RejectedReason> <SRN>I0030032XXX</SRN> <SRNEnquiryTaskID>100001</SRNEnquiryTaskID> <SecurityCode>BHP</SecurityCode> <TaskStatus>Completed</TaskStatus> </SRNEnquiryTaskResponse>
Error Response Information
Resource Description
SRNEnquiryTaskResponse
BadRequestResultName | Description | Type | Additional information |
---|---|---|---|
Errors | Collection of Error |
None. |
Error Response Formats
application/json, text/json
{ "Errors": [ { "Code": 1, "Description": "sample string 1" }, { "Code": 1, "Description": "sample string 1" } ] }
application/xml, text/xml
<BadRequestResultOfenSRNEnquiryTaskCreateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse"> <Errors> <ErrorOfenSRNEnquiryTaskCreateErrorYd1IcMMv> <Code>SecurityCodeRequired</Code> <Description>sample string 1</Description> </ErrorOfenSRNEnquiryTaskCreateErrorYd1IcMMv> <ErrorOfenSRNEnquiryTaskCreateErrorYd1IcMMv> <Code>SecurityCodeRequired</Code> <Description>sample string 1</Description> </ErrorOfenSRNEnquiryTaskCreateErrorYd1IcMMv> </Errors> </BadRequestResultOfenSRNEnquiryTaskCreateErrorYd1IcMMv>