POST api/account/advisor

Create new advisor account

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BrandID	Brand ID of new advisor	integer	Required
LicenseeID	Determine branch of new advisor	integer	None.
BranchID	Branch ID of new 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
LedgerCode	Ledger Code	string	String length: inclusive between 0 and 100
AdvisorTeamID	Advisor team ID of the advisor	integer	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:

{
  "BrandID": 1,
  "LicenseeID": 1000,
  "BranchID": 1000,
  "AdvisorName": "ADVISOR109072",
  "ExternalRef": "258970",
  "LedgerCode": null,
  "AdvisorTeamID": 1,
  "Persons": [
    {
      "PersonID": 105896,
      "AccessType": 1,
      "IsPrincipal": true
    },
    {
      "PersonID": 105897,
      "AccessType": 1,
      "IsPrincipal": false
    }
  ]
}

application/xml, text/xml

Sample:

<AdvisorAccountCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
  <AdvisorName>ADVISOR109072</AdvisorName>
  <AdvisorTeamID>1</AdvisorTeamID>
  <BranchID>1000</BranchID>
  <BrandID>1</BrandID>
  <ExternalRef>258970</ExternalRef>
  <LedgerCode i:nil="true" />
  <LicenseeID>1000</LicenseeID>
  <Persons>
    <AdvisorPersonLink>
      <AccessType>NormalAccess</AccessType>
      <IsPrincipal>true</IsPrincipal>
      <PersonID>105896</PersonID>
    </AdvisorPersonLink>
    <AdvisorPersonLink>
      <AccessType>NormalAccess</AccessType>
      <IsPrincipal>false</IsPrincipal>
      <PersonID>105897</PersonID>
    </AdvisorPersonLink>
  </Persons>
</AdvisorAccountCreation>

Response Information

Resource Description

AdvisorAccountCreationResult

Name	Description	Type	Additional information
AdvisorID	An identifier of new created advisor	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AdvisorID": 109126
}

application/xml, text/xml

Sample:

<AdvisorAccountCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
  <AdvisorID>109126</AdvisorID>
</AdvisorAccountCreationResult>

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

application/xml, text/xml

Sample:

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