POST api/account/advisor/{advisorID}

Update an advisor account

Request Information

URI Parameters

Name	Description	Type	Additional information
advisorID		integer	Required

Body Parameters

AdvisorAccountUpdate

Name	Description	Type	Additional information
BranchID	Branch ID of the advisor	integer	None.
AdvisorTeamID	Advisor team ID of the advisor	integer	None.
AdvisorName	Advisor account name	string	String length: inclusive between 0 and 100
ExternalRef	External reference. An identifier of account in front office systems. Synonymous with 'Advisor Code'	string	String length: inclusive between 0 and 100
Status	Status can be set to Suspended to trigger account closure	enAdvisorStatus	None.
Persons	List of persons associated with the advisor account. Required for persons that are to access via TPP portal, or if persons are to receive contracts / statements	Collection of AdvisorPersonLink	None.

Request Formats

application/json, text/json

Sample:

{
  "BranchID": 1000,
  "AdvisorTeamID": 2688,
  "AdvisorName": "a109098",
  "ExternalRef": "258970",
  "Status": 3,
  "Persons": [
    {
      "PersonID": 105896,
      "AccessType": 1,
      "IsPrincipal": true
    },
    {
      "PersonID": 105897,
      "AccessType": 1,
      "IsPrincipal": false
    }
  ]
}

application/xml, text/xml

Sample:

<AdvisorAccountUpdate 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">
  <BranchID i:type="x:int" xmlns="">1000</BranchID>
  <AdvisorTeamID i:type="x:int" xmlns="">2688</AdvisorTeamID>
  <AdvisorName i:type="x:string" xmlns="">a109098</AdvisorName>
  <ExternalRef i:type="x:string" xmlns="">258970</ExternalRef>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" i:type="d2p1:enAdvisorStatus" xmlns="">Suspended</Status>
  <Persons xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account" i:type="d2p1:ArrayOfAdvisorPersonLink" xmlns="">
    <d2p1:AdvisorPersonLink>
      <d2p1:AccessType>NormalAccess</d2p1:AccessType>
      <d2p1:IsPrincipal>true</d2p1:IsPrincipal>
      <d2p1:PersonID>105896</d2p1:PersonID>
    </d2p1:AdvisorPersonLink>
    <d2p1:AdvisorPersonLink>
      <d2p1:AccessType>NormalAccess</d2p1:AccessType>
      <d2p1:IsPrincipal>false</d2p1:IsPrincipal>
      <d2p1:PersonID>105897</d2p1:PersonID>
    </d2p1:AdvisorPersonLink>
  </Persons>
</AdvisorAccountUpdate>

Response Information

Resource Description

AdvisorAccountUpdateResult

Name	Description	Type	Additional information
AdvisorID	TPP identifier of updated advisor	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AdvisorID": 109126
}

application/xml, text/xml

Sample:

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

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": 1,
      "Description": "sample string 1"
    },
    {
      "Code": 1,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

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