POST api/Label/PrepareComposition?subscriptionID={subscriptionID}&labelName={labelName}&urlKey={urlKey}

When the user has the final set of labels on the page he can request the final output to be generated as pdf

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

string

Required

labelName

string

Required

urlKey

string

Required

Body Parameters

Collection of Pair of integer [key] and Pet [value]

Request Formats

application/json, text/json

Sample:
[
  {
    "Key": 1,
    "Value": {
      "DetailFields": [
        {
          "Key": "sample string 1",
          "OverwrittenKey": "sample string 2",
          "Value": "sample string 3",
          "OverwrittenValue": "sample string 4"
        },
        {
          "Key": "sample string 1",
          "OverwrittenKey": "sample string 2",
          "Value": "sample string 3",
          "OverwrittenValue": "sample string 4"
        }
      ],
      "PLUCodeTitle": "sample string 3",
      "ArticleMappingEntryID": 4,
      "CustomerName": "sample string 5",
      "Id": 6,
      "PetType": "sample string 7",
      "Channel": "sample string 8",
      "Line1": "sample string 9",
      "Line2": "sample string 10",
      "Line3": "sample string 11",
      "Line4": "sample string 12",
      "ImageUrl": "sample string 13",
      "Barcode": "sample string 14",
      "Price": "sample string 15",
      "PLUCode": "sample string 16"
    }
  },
  {
    "Key": 1,
    "Value": {
      "DetailFields": [
        {
          "Key": "sample string 1",
          "OverwrittenKey": "sample string 2",
          "Value": "sample string 3",
          "OverwrittenValue": "sample string 4"
        },
        {
          "Key": "sample string 1",
          "OverwrittenKey": "sample string 2",
          "Value": "sample string 3",
          "OverwrittenValue": "sample string 4"
        }
      ],
      "PLUCodeTitle": "sample string 3",
      "ArticleMappingEntryID": 4,
      "CustomerName": "sample string 5",
      "Id": 6,
      "PetType": "sample string 7",
      "Channel": "sample string 8",
      "Line1": "sample string 9",
      "Line2": "sample string 10",
      "Line3": "sample string 11",
      "Line4": "sample string 12",
      "ImageUrl": "sample string 13",
      "Barcode": "sample string 14",
      "Price": "sample string 15",
      "PLUCode": "sample string 16"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfKeyValuePairOfintPetMIK_P8A7e xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
  <KeyValuePairOfintPetMIK_P8A7e>
    <key>1</key>
    <value xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities">
      <d3p1:Barcode>sample string 14</d3p1:Barcode>
      <d3p1:Channel>sample string 8</d3p1:Channel>
      <d3p1:Id>6</d3p1:Id>
      <d3p1:ImageUrl>sample string 13</d3p1:ImageUrl>
      <d3p1:LatName>sample string 2</d3p1:LatName>
      <d3p1:Line1>sample string 9</d3p1:Line1>
      <d3p1:Line2>sample string 10</d3p1:Line2>
      <d3p1:Line3>sample string 11</d3p1:Line3>
      <d3p1:Line4>sample string 12</d3p1:Line4>
      <d3p1:Name>sample string 1</d3p1:Name>
      <d3p1:PLUCode>sample string 16</d3p1:PLUCode>
      <d3p1:PetInfoFields>
        <KeyValuePairOfstringstring>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </KeyValuePairOfstringstring>
        <KeyValuePairOfstringstring>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </KeyValuePairOfstringstring>
      </d3p1:PetInfoFields>
      <d3p1:PetType>sample string 7</d3p1:PetType>
      <d3p1:Price>sample string 15</d3p1:Price>
      <d3p1:ArticleMappingEntryID>4</d3p1:ArticleMappingEntryID>
      <d3p1:CustomerName>sample string 5</d3p1:CustomerName>
      <d3p1:DetailFields>
        <d3p1:DetailField>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:OverwrittenKey>sample string 2</d3p1:OverwrittenKey>
          <d3p1:OverwrittenValue>sample string 4</d3p1:OverwrittenValue>
          <d3p1:Value>sample string 3</d3p1:Value>
        </d3p1:DetailField>
        <d3p1:DetailField>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:OverwrittenKey>sample string 2</d3p1:OverwrittenKey>
          <d3p1:OverwrittenValue>sample string 4</d3p1:OverwrittenValue>
          <d3p1:Value>sample string 3</d3p1:Value>
        </d3p1:DetailField>
      </d3p1:DetailFields>
      <d3p1:PLUCodeTitle>sample string 3</d3p1:PLUCodeTitle>
    </value>
  </KeyValuePairOfintPetMIK_P8A7e>
  <KeyValuePairOfintPetMIK_P8A7e>
    <key>1</key>
    <value xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities">
      <d3p1:Barcode>sample string 14</d3p1:Barcode>
      <d3p1:Channel>sample string 8</d3p1:Channel>
      <d3p1:Id>6</d3p1:Id>
      <d3p1:ImageUrl>sample string 13</d3p1:ImageUrl>
      <d3p1:LatName>sample string 2</d3p1:LatName>
      <d3p1:Line1>sample string 9</d3p1:Line1>
      <d3p1:Line2>sample string 10</d3p1:Line2>
      <d3p1:Line3>sample string 11</d3p1:Line3>
      <d3p1:Line4>sample string 12</d3p1:Line4>
      <d3p1:Name>sample string 1</d3p1:Name>
      <d3p1:PLUCode>sample string 16</d3p1:PLUCode>
      <d3p1:PetInfoFields>
        <KeyValuePairOfstringstring>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </KeyValuePairOfstringstring>
        <KeyValuePairOfstringstring>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </KeyValuePairOfstringstring>
      </d3p1:PetInfoFields>
      <d3p1:PetType>sample string 7</d3p1:PetType>
      <d3p1:Price>sample string 15</d3p1:Price>
      <d3p1:ArticleMappingEntryID>4</d3p1:ArticleMappingEntryID>
      <d3p1:CustomerName>sample string 5</d3p1:CustomerName>
      <d3p1:DetailFields>
        <d3p1:DetailField>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:OverwrittenKey>sample string 2</d3p1:OverwrittenKey>
          <d3p1:OverwrittenValue>sample string 4</d3p1:OverwrittenValue>
          <d3p1:Value>sample string 3</d3p1:Value>
        </d3p1:DetailField>
        <d3p1:DetailField>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:OverwrittenKey>sample string 2</d3p1:OverwrittenKey>
          <d3p1:OverwrittenValue>sample string 4</d3p1:OverwrittenValue>
          <d3p1:Value>sample string 3</d3p1:Value>
        </d3p1:DetailField>
      </d3p1:DetailFields>
      <d3p1:PLUCodeTitle>sample string 3</d3p1:PLUCodeTitle>
    </value>
  </KeyValuePairOfintPetMIK_P8A7e>
</ArrayOfKeyValuePairOfintPetMIK_P8A7e>

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.