POST api/account/task/issuer-out

Submit Issuer Out Request

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Source	Movement of stock from. This value can be either a HIN or a client account number. HIN value should have the format 'X' followed by 10 digits. [Mandatory]	string	None.
AccountName	Account name. Max length of 80. [Mandatory]	string	None.
Designation	Designation. Max length of 35.	string	None.
AddressLine1	Address line 1. Max length of 40. [Mandatory]	string	None.
AddressLine2	Address line 2. Max length of 40.	string	None.
AddressLine3	Address line 3. Max length of 40.	string	None.
TownName	Town name. Max length of 35. [Mandatory]	string	None.
Postcode	Postcode. Max length of 16.	string	None.
State	State. Max length of 35.	string	None.
Country	Country code (2 letters). Max length of 2. [Mandatory]	string	None.
Stock	Security code. [Mandatory]	string	None.
Quantity	Non-zero and non-negative quantity value. [Mandatory]	decimal number	None.
Reference	Reference tagged to the request (task) for easier searching.	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "Source": "X0001234567",
  "AccountName": "John Smith",
  "Designation": "",
  "AddressLine1": "123 Main Street",
  "AddressLine2": "",
  "AddressLine3": "",
  "TownName": "Sydney",
  "Postcode": "2000",
  "State": "NSW",
  "Country": "AU",
  "Stock": "BHP",
  "Quantity": 100.0,
  "Reference": "REF-001"
}

application/xml, text/xml

Sample:

<IssuerOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks">
  <AccountName>John Smith</AccountName>
  <AddressLine1>123 Main Street</AddressLine1>
  <AddressLine2></AddressLine2>
  <AddressLine3></AddressLine3>
  <Country>AU</Country>
  <Designation></Designation>
  <Postcode>2000</Postcode>
  <Quantity>100</Quantity>
  <Reference>REF-001</Reference>
  <Source>X0001234567</Source>
  <State>NSW</State>
  <Stock>BHP</Stock>
  <TownName>Sydney</TownName>
</IssuerOutRequest>

Response Information

Resource Description

IssuerOutResponse

Name	Description	Type	Additional information
TaskUID	Guid of the CHESS-To-Issuer task that was created for the request. Can be used for searching specifically for this task.	globally unique identifier	None.
Reference	Reference tagged to the task. Can be used when searching for this task.	string	None.
TaskStatus	Issuer Out task status	enTaskStatus	None.
RejectedReason	Rejected Reason if Issuer Out Submission being rejected	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TaskUID": "51310d59-1c59-4942-9cbb-4e1e8e75928d",
  "Reference": "BHP",
  "TaskStatus": 3,
  "RejectedReason": ""
}

application/xml, text/xml

Sample:

<IssuerOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks">
  <Reference>BHP</Reference>
  <RejectedReason></RejectedReason>
  <TaskStatus>Completed</TaskStatus>
  <TaskUID>51310d59-1c59-4942-9cbb-4e1e8e75928d</TaskUID>
</IssuerOutResponse>

Error Response Information

Resource Description

IssuerOutResponse

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Code": 1,
      "Description": "sample string 1"
    },
    {
      "Code": 1,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<BadRequestResultOfenIssuerOutTaskCreateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse">
  <Errors>
    <ErrorOfenIssuerOutTaskCreateErrorYd1IcMMv>
      <Code>SourceRequired</Code>
      <Description>sample string 1</Description>
    </ErrorOfenIssuerOutTaskCreateErrorYd1IcMMv>
    <ErrorOfenIssuerOutTaskCreateErrorYd1IcMMv>
      <Code>SourceRequired</Code>
      <Description>sample string 1</Description>
    </ErrorOfenIssuerOutTaskCreateErrorYd1IcMMv>
  </Errors>
</BadRequestResultOfenIssuerOutTaskCreateErrorYd1IcMMv>