GET api/v1/admin/accounts/headers/{id}

Retrieves a list of ShortCodes/Headers for the account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Account ID

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfHeaders
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfListOfHeaders

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "Header": "sample string 3",
        "DefaultHeader": true
      },
      {
        "Header": "sample string 3",
        "DefaultHeader": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfListOfHeaders xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Headers>
        <SelectFlag>true</SelectFlag>
        <HeaderID>2</HeaderID>
        <Header>sample string 3</Header>
        <DefaultHeader>true</DefaultHeader>
      </Headers>
      <Headers>
        <SelectFlag>true</SelectFlag>
        <HeaderID>2</HeaderID>
        <Header>sample string 3</Header>
        <DefaultHeader>true</DefaultHeader>
      </Headers>
    </Detail>
  </ResponseData>
</ResponseOfListOfHeaders>