GET api/Relation?companyCode={companyCode}

Get Relation List

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	Company Identifier	string	Required

Body Parameters

None.

Response Information

Resource Description

Response message with a list of all Relations. HttpStatusCode.Conflict when user isn't connected to Company

GetRelationListMessageResponse

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
RelationIdentifiers	List of Relation Identifiers	Collection of RelationListResponseItem	None.
Footer	Footer item	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "RelationIdentifiers": [
    {
      "RelationIdentifier": "string 1",
      "RelationType": "Customer"
    },
    {
      "RelationIdentifier": "string 1",
      "RelationType": "Customer"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<GetRelationListMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <RelationIdentifiers>
    <RelationListResponseItem>
      <RelationIdentifier>string 1</RelationIdentifier>
      <RelationType>Customer</RelationType>
    </RelationListResponseItem>
    <RelationListResponseItem>
      <RelationIdentifier>string 1</RelationIdentifier>
      <RelationType>Customer</RelationType>
    </RelationListResponseItem>
  </RelationIdentifiers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetRelationListMessageResponse>