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

Retrieves a list of ShortCodes/Headers for the account.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Account ID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfHeaderInfo

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfListOfHeaderInfo	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:

<ResponseOfListOfHeaderInfo 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>
      <HeaderInfo>
        <SelectFlag>true</SelectFlag>
        <HeaderID>2</HeaderID>
        <Header>sample string 3</Header>
        <DefaultHeader>true</DefaultHeader>
      </HeaderInfo>
      <HeaderInfo>
        <SelectFlag>true</SelectFlag>
        <HeaderID>2</HeaderID>
        <Header>sample string 3</Header>
        <DefaultHeader>true</DefaultHeader>
      </HeaderInfo>
    </Detail>
  </ResponseData>
</ResponseOfListOfHeaderInfo>