GET api/RelationCustomSettingsTypesHelper?companyCode={companyCode}

Get Relation Custom Setting Types

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 RelationCustomSetting Types. HttpStatusCode.Conflict when user isn't connected to Company

GetRelationCustomSettingsTypeMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
Types	Collection of RelationCustomSettingTypesResponseItem	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "Types": [
    {
      "Identifier": 1,
      "Description": "string 2"
    },
    {
      "Identifier": 1,
      "Description": "string 2"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<GetRelationCustomSettingsTypeMessageResponse 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>
  <Types>
    <RelationCustomSettingTypesResponseItem>
      <Identifier>1</Identifier>
      <Description>string 2</Description>
    </RelationCustomSettingTypesResponseItem>
    <RelationCustomSettingTypesResponseItem>
      <Identifier>1</Identifier>
      <Description>string 2</Description>
    </RelationCustomSettingTypesResponseItem>
  </Types>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetRelationCustomSettingsTypeMessageResponse>