GET api/account/advisor?externalRef={externalRef}&date={date}

Get advisor accounts with matching external reference, date time created / updated

Request Information

URI Parameters

Name	Description	Type	Additional information
externalRef	External reference ('Advisor Code') of advisor account	string	None.
date	Recorded date time when the advisor account is created or updated. Format in yyyy-MM-dd	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Advisor

Name	Description	Type	Additional information
AdvisorID	TPP identifier of advisor	integer	Required
BranchID	The branch ID the advisor account is linked	integer	Required
AdvisorName	The name on the advisor account	string	Required String length: inclusive between 0 and 100
ExternalRef	An identifer of account in front office systems. Synonymous with 'Advisor Code'	string	String length: inclusive between 0 and 100
AdvisorTeamID	TPP identifier of advisor team	integer	None.
Status	The status on the advisor account	enAdvisorStatus	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "AdvisorID": 110168,
    "BranchID": 1000,
    "AdvisorName": "Mr Bob Dob",
    "ExternalRef": "A111",
    "AdvisorTeamID": 1,
    "Status": 1
  },
  {
    "AdvisorID": 110169,
    "BranchID": 1000,
    "AdvisorName": "Ms Teresa Hanson",
    "ExternalRef": "A111",
    "AdvisorTeamID": 3,
    "Status": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfAdvisor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <Advisor>
    <AdvisorID>110168</AdvisorID>
    <AdvisorName>Mr Bob Dob</AdvisorName>
    <AdvisorTeamID>1</AdvisorTeamID>
    <BranchID>1000</BranchID>
    <ExternalRef>A111</ExternalRef>
    <Status>Active</Status>
  </Advisor>
  <Advisor>
    <AdvisorID>110169</AdvisorID>
    <AdvisorName>Ms Teresa Hanson</AdvisorName>
    <AdvisorTeamID>3</AdvisorTeamID>
    <BranchID>1000</BranchID>
    <ExternalRef>A111</ExternalRef>
    <Status>Active</Status>
  </Advisor>
</ArrayOfAdvisor>