GET api/person/externalreference/{reference}

Get basic person details for a given external reference.

Request Information

URI Parameters

Name	Description	Type	Additional information
reference	Person reference	string	Required

Body Parameters

None.

Response Information

Resource Description

Person

Name	Type	Additional information
PersonID	integer	None.
Salutation	string	None.
FirstName	string	None.
LastName	string	None.
IsAdmin	boolean	None.
IQSettings	IQSettings	None.

Response Formats

application/json, text/json

Sample:

{
  "PersonID": 1,
  "Salutation": "Mr",
  "FirstName": "Xavier",
  "LastName": "Test",
  "IsAdmin": true,
  "IQSettings": {
    "IQSettingShowDataInDollar": true,
    "ShowRWE": true,
    "ShowCompanyAnnouncements": true,
    "ShowNewsBites": true,
    "ShowDowJonesNews": true,
    "HighlightStyleType": 6,
    "ChartingEnabled": true,
    "ChartStreamingEnabled": true,
    "OrderingEnabled": true,
    "MarkitOnDemandPollRate": 10,
    "MarkitOnDemandPollRateOther": 11,
    "MarketMapAutoRefreshEnabled": true,
    "MarketMapPositiveColor": "#00FF00",
    "MarketMapNegativeColor": "#FF0000",
    "MarketMapZeroColor": "#0000FF",
    "FontSize": 16,
    "GridDisplayLines": true,
    "GridDisplayPadding": true,
    "ControlSizes": [
      {
        "Id": "ctrlID1",
        "Width": 3.1,
        "Height": 2.1
      },
      {
        "Id": "ctrlID2",
        "Width": 5.2,
        "Height": 4.2
      }
    ],
    "ShutdownTime": "04:00:00",
    "ShowQuoteInNewWindow": true,
    "IQRenderingInterval": 20.1,
    "IQRenderingThresholdCount": 21
  }
}

application/xml, text/xml

Sample:

<Person xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PersonID>1</PersonID>
  <Salutation>Mr</Salutation>
  <FirstName>Xavier</FirstName>
  <LastName>Test</LastName>
  <IsAdmin>true</IsAdmin>
  <IQSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.IQ">
    <d2p1:ChartStreamingEnabled>true</d2p1:ChartStreamingEnabled>
    <d2p1:ChartingEnabled>true</d2p1:ChartingEnabled>
    <d2p1:ControlSizes>
      <d2p1:ControlSize>
        <d2p1:Height>2.1</d2p1:Height>
        <d2p1:Id>ctrlID1</d2p1:Id>
        <d2p1:Width>3.1</d2p1:Width>
      </d2p1:ControlSize>
      <d2p1:ControlSize>
        <d2p1:Height>4.2</d2p1:Height>
        <d2p1:Id>ctrlID2</d2p1:Id>
        <d2p1:Width>5.2</d2p1:Width>
      </d2p1:ControlSize>
    </d2p1:ControlSizes>
    <d2p1:FontSize>16</d2p1:FontSize>
    <d2p1:GridDisplayLines>true</d2p1:GridDisplayLines>
    <d2p1:GridDisplayPadding>true</d2p1:GridDisplayPadding>
    <d2p1:HighlightStyleType>6</d2p1:HighlightStyleType>
    <d2p1:IQRenderingInterval>20.1</d2p1:IQRenderingInterval>
    <d2p1:IQRenderingThresholdCount>21</d2p1:IQRenderingThresholdCount>
    <d2p1:IQSettingShowDataInDollar>true</d2p1:IQSettingShowDataInDollar>
    <d2p1:MarketMapAutoRefreshEnabled>true</d2p1:MarketMapAutoRefreshEnabled>
    <d2p1:MarketMapNegativeColor>#FF0000</d2p1:MarketMapNegativeColor>
    <d2p1:MarketMapPositiveColor>#00FF00</d2p1:MarketMapPositiveColor>
    <d2p1:MarketMapZeroColor>#0000FF</d2p1:MarketMapZeroColor>
    <d2p1:MarkitOnDemandPollRate>10</d2p1:MarkitOnDemandPollRate>
    <d2p1:MarkitOnDemandPollRateOther>11</d2p1:MarkitOnDemandPollRateOther>
    <d2p1:OrderingEnabled>true</d2p1:OrderingEnabled>
    <d2p1:ShowCompanyAnnouncements>true</d2p1:ShowCompanyAnnouncements>
    <d2p1:ShowDowJonesNews>true</d2p1:ShowDowJonesNews>
    <d2p1:ShowNewsBites>true</d2p1:ShowNewsBites>
    <d2p1:ShowQuoteInNewWindow>true</d2p1:ShowQuoteInNewWindow>
    <d2p1:ShowRWE>true</d2p1:ShowRWE>
    <d2p1:ShutdownTime>PT4H</d2p1:ShutdownTime>
  </IQSettings>
</Person>