POST api/account/{clientID}/brokerregistration

Update client broker registration

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Unique client identifier.	integer	Required

Body Parameters

Client's broker registration details.

BrokerRegistrationUpdate

Name	Description	Type	Additional information
HolderStatus	HIN holder status	enHINHolderStatus	None.
ResidencyIndicator	HIN residency indicator. e.g. Domestic or Foreign	enHINResidencyIndicator	None.
BrokerRegistrationDetails		BrokerRegistrationDetails	None.
DateOfDeath	Date of death	Date	None.
ReleaseReason	HIN release reason	enHINReleaseReason	None.

Request Formats

application/json, text/json

Sample:

{
  "HolderStatus": 1,
  "ResidencyIndicator": 1,
  "BrokerRegistrationDetails": {
    "RegistrationAddress": {
      "RegAddress1": "Mr John Smith",
      "RegAddress2": "79 COLLINGWOOD STREET",
      "RegAddress3": "OSBORNE PARK WA",
      "RegAddress4": "",
      "RegAddress5": "",
      "RegAddress6": "6017"
    },
    "RegistrationNameUpdateReason1": 1,
    "RegistrationNameUpdateReason2": 9
  },
  "DateOfDeath": "2022-3-12",
  "ReleaseReason": 4
}

application/xml, text/xml

Sample:

<BrokerRegistrationUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:x="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <HolderStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" i:type="d2p1:enHINHolderStatus" xmlns="">NotifiedAsBankruptLockHolder</HolderStatus>
  <ResidencyIndicator xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" i:type="d2p1:enHINResidencyIndicator" xmlns="">Domestic</ResidencyIndicator>
  <BrokerRegistrationDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account" i:type="d2p1:BrokerRegistrationDetails" xmlns="">
    <RegistrationAddress i:type="d2p1:RegistrationAddress">
      <d2p1:RegAddress1>Mr John Smith</d2p1:RegAddress1>
      <d2p1:RegAddress2>79 COLLINGWOOD STREET</d2p1:RegAddress2>
      <d2p1:RegAddress3>OSBORNE PARK WA</d2p1:RegAddress3>
      <d2p1:RegAddress4></d2p1:RegAddress4>
      <d2p1:RegAddress5></d2p1:RegAddress5>
      <d2p1:RegAddress6>6017</d2p1:RegAddress6>
    </RegistrationAddress>
    <RegistrationNameUpdateReason1 xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" i:type="d3p1:enRegistrationNameUpdateReason">AccountDesignationChanges</RegistrationNameUpdateReason1>
    <RegistrationNameUpdateReason2 xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" i:type="d3p1:enRegistrationNameUpdateReason">SalutationOrTitleChange</RegistrationNameUpdateReason2>
  </BrokerRegistrationDetails>
  <DateOfDeath xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" i:type="d2p1:Date" xmlns="" />
  <ReleaseReason xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" i:type="d2p1:enHINReleaseReason" xmlns="">NoHoldings</ReleaseReason>
</BrokerRegistrationUpdate>

Response Information

Resource Description

BrokerRegistrationUpdateResult

Name	Description	Type	Additional information
TaskID	Transaction ID of a CHESSmessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TaskID": "1234"
}

application/xml, text/xml

Sample:

<BrokerRegistrationUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <TaskID>1234</TaskID>
</BrokerRegistrationUpdateResult>

Error Response Information

Resource Description

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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