POST api/Label/LabelSettings?subscriptionID={subscriptionID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

string

Required

Body Parameters

LabelSettings
NameDescriptionTypeAdditional information
Styles

Dictionary of string [key] and Collection of StyleElement [value]

None.

Logos

Dictionary of string [key] and string [value]

None.

PageRenderingPositionOffset

Position

None.

IsPaperSizeLetter

boolean

None.

UsePLUCode

boolean

None.

UseUSMetrics

boolean

None.

LabelTitleOrder

LabelTitleOrderEnum

None.

Request Formats

application/json, text/json

Sample:
{
  "Styles": {
    "sample string 1": [
      {
        "DisplayName": "sample string 1",
        "Name": "sample string 2",
        "Group": "sample string 3",
        "ColorCode": "sample string 4",
        "DefaultColorCode": "sample string 5"
      },
      {
        "DisplayName": "sample string 1",
        "Name": "sample string 2",
        "Group": "sample string 3",
        "ColorCode": "sample string 4",
        "DefaultColorCode": "sample string 5"
      }
    ],
    "sample string 2": [
      {
        "DisplayName": "sample string 1",
        "Name": "sample string 2",
        "Group": "sample string 3",
        "ColorCode": "sample string 4",
        "DefaultColorCode": "sample string 5"
      },
      {
        "DisplayName": "sample string 1",
        "Name": "sample string 2",
        "Group": "sample string 3",
        "ColorCode": "sample string 4",
        "DefaultColorCode": "sample string 5"
      }
    ]
  },
  "Logos": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PageRenderingPositionOffset": {
    "PosX": 1,
    "PosY": 2
  },
  "IsPaperSizeLetter": true,
  "UsePLUCode": true,
  "UseUSMetrics": true,
  "LabelTitleOrder": 0
}

application/xml, text/xml

Sample:
<LabelSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities">
  <IsPaperSizeLetter>true</IsPaperSizeLetter>
  <LabelTitleOrder>LAT_N</LabelTitleOrder>
  <Logos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Logos>
  <PageRenderingPositionOffset>
    <PosX>1</PosX>
    <PosY>2</PosY>
  </PageRenderingPositionOffset>
  <Styles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfStyleElementMIK_P8A7e>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <StyleElement>
          <ColorCode>sample string 4</ColorCode>
          <DefaultColorCode>sample string 5</DefaultColorCode>
          <DisplayName>sample string 1</DisplayName>
          <Group>sample string 3</Group>
          <Name>sample string 2</Name>
          <TranslatedName>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
          </TranslatedName>
        </StyleElement>
        <StyleElement>
          <ColorCode>sample string 4</ColorCode>
          <DefaultColorCode>sample string 5</DefaultColorCode>
          <DisplayName>sample string 1</DisplayName>
          <Group>sample string 3</Group>
          <Name>sample string 2</Name>
          <TranslatedName>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
          </TranslatedName>
        </StyleElement>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfStyleElementMIK_P8A7e>
    <d2p1:KeyValueOfstringArrayOfStyleElementMIK_P8A7e>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <StyleElement>
          <ColorCode>sample string 4</ColorCode>
          <DefaultColorCode>sample string 5</DefaultColorCode>
          <DisplayName>sample string 1</DisplayName>
          <Group>sample string 3</Group>
          <Name>sample string 2</Name>
          <TranslatedName>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
          </TranslatedName>
        </StyleElement>
        <StyleElement>
          <ColorCode>sample string 4</ColorCode>
          <DefaultColorCode>sample string 5</DefaultColorCode>
          <DisplayName>sample string 1</DisplayName>
          <Group>sample string 3</Group>
          <Name>sample string 2</Name>
          <TranslatedName>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
            <Translation>
              <Channel>sample string 1</Channel>
              <Value>sample string 2</Value>
            </Translation>
          </TranslatedName>
        </StyleElement>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfStyleElementMIK_P8A7e>
  </Styles>
  <UsePLUCode>true</UsePLUCode>
  <UseUSMetrics>true</UseUSMetrics>
</LabelSettings>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.