GET v1/Customers/{customerID}/LinkedAccounts

Get Linked Accounts

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerID

Customer ID

 integer

Required

Body Parameters

None.

Response Information

Resource Description

List of linked accounts

Collection of LinkedAccountDTO
NameDescriptionTypeAdditional information
CustomerIdMain

Main Customer ID of the Linked account

 integer

None.
CustomerIdLink

Secondary Customer Id of the Linked Account

 integer

None.
MainDescription

Main Description on the linked account (what shows when viewing from the main contact's perspective)

 string

None.
LinkedDescription

Secondary description on the linked account (what shows when viewing from the linked contact's perspective)

 string

None.
CustomerLinkDisplayAs

This is the description of the customer that is linked - it is not stored.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CustomerIdMain": 1,
    "CustomerIdLink": 2,
    "MainDescription": "sample string 3",
    "LinkedDescription": "sample string 4",
    "CustomerLinkDisplayAs": "sample string 5"
  },
  {
    "CustomerIdMain": 1,
    "CustomerIdLink": 2,
    "MainDescription": "sample string 3",
    "LinkedDescription": "sample string 4",
    "CustomerLinkDisplayAs": "sample string 5"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfLinkedAccountDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <LinkedAccountDTO>
    <CustomerIdLink>2</CustomerIdLink>
    <CustomerIdMain>1</CustomerIdMain>
    <CustomerLinkDisplayAs>sample string 5</CustomerLinkDisplayAs>
    <LinkedDescription>sample string 4</LinkedDescription>
    <MainDescription>sample string 3</MainDescription>
  </LinkedAccountDTO>
  <LinkedAccountDTO>
    <CustomerIdLink>2</CustomerIdLink>
    <CustomerIdMain>1</CustomerIdMain>
    <CustomerLinkDisplayAs>sample string 5</CustomerLinkDisplayAs>
    <LinkedDescription>sample string 4</LinkedDescription>
    <MainDescription>sample string 3</MainDescription>
  </LinkedAccountDTO>
</ArrayOfLinkedAccountDTO>