PUT api/labelpagelayout/{guid}

Update a page layout

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

Page Layout identifier

globally unique identifier

Required

Body Parameters

Page Layout

LabelPageLayout
NameDescriptionTypeAdditional information
G_UId

Collection of byte

None.

Guid

globally unique identifier

None.

LayoutName

string

None.

Rows

integer

None.

Columns

integer

None.

RowSpacing

integer

None.

ColumnSpacing

integer

None.

TearOffStyle

string

None.

MinimumSpacing

integer

None.

TearOffHeight

integer

None.

TearOffTop

integer

None.

TearOffBottom

integer

None.

TearOffWidth

integer

None.

TearOffLeft

integer

None.

TearOffRight

integer

None.

Printer

string

None.

DoubleSided

0 = not double sided, otherwise fits to duplex setting

Duplex

None.

PageSize

9 = A4 (RawKind)

integer

None.

Stores

Collection of integer

Relation. This field may not always be loaded or used for updates.

LabelDesigns

Collection of LabelPageLayoutDesign

Relation. This field may not always be loaded or used for updates.

LabelPrinters

Collection of LabelPageLayoutStorePrinter

Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:
{
  "g_UId": "Lkj9bIsUm0mjso/AQyz0zQ==",
  "guid": "6cfd482e-148b-499b-a3b2-8fc0432cf4cd",
  "layoutName": "sample string 2",
  "rows": 3,
  "columns": 4,
  "rowSpacing": 5,
  "columnSpacing": 6,
  "tearOffStyle": "sample string 7",
  "minimumSpacing": 8,
  "tearOffHeight": 9,
  "tearOffTop": 10,
  "tearOffBottom": 11,
  "tearOffWidth": 12,
  "tearOffLeft": 13,
  "tearOffRight": 14,
  "printer": "sample string 15",
  "doubleSided": 16,
  "pageSize": 17,
  "stores": [
    1,
    2
  ],
  "labelDesigns": [
    {
      "$id": "2",
      "pageLayoutG_UID": "zgKrmQY/k0eVb4N3hL0UKQ==",
      "pageLayoutGuid": "99ab02ce-3f06-4793-956f-837784bd1429",
      "labelDesignName": "sample string 2",
      "smallLabel": true,
      "orderLabel": 1
    },
    {
      "$ref": "2"
    }
  ],
  "labelPrinters": [
    {
      "$id": "3",
      "pageLayoutGuid": "fa5a1410-7076-48dd-9b39-91c39a25afe1",
      "storeID": 2,
      "printerName": "sample string 3",
      "storeName": "sample string 4"
    },
    {
      "$ref": "3"
    }
  ]
}

application/xml, text/xml

Sample:
<LabelPageLayout xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Labels">
  <ColumnSpacing>6</ColumnSpacing>
  <Columns>4</Columns>
  <DoubleSided>16</DoubleSided>
  <G_UId>Lkj9bIsUm0mjso/AQyz0zQ==</G_UId>
  <Guid>6cfd482e-148b-499b-a3b2-8fc0432cf4cd</Guid>
  <LabelDesigns>
    <LabelPageLayoutDesign>
      <LabelDesignName>sample string 2</LabelDesignName>
      <OrderLabel>1</OrderLabel>
      <PageLayoutG_UID>zgKrmQY/k0eVb4N3hL0UKQ==</PageLayoutG_UID>
      <PageLayoutGuid>99ab02ce-3f06-4793-956f-837784bd1429</PageLayoutGuid>
      <SmallLabel>true</SmallLabel>
    </LabelPageLayoutDesign>
    <LabelPageLayoutDesign>
      <LabelDesignName>sample string 2</LabelDesignName>
      <OrderLabel>1</OrderLabel>
      <PageLayoutG_UID>zgKrmQY/k0eVb4N3hL0UKQ==</PageLayoutG_UID>
      <PageLayoutGuid>99ab02ce-3f06-4793-956f-837784bd1429</PageLayoutGuid>
      <SmallLabel>true</SmallLabel>
    </LabelPageLayoutDesign>
  </LabelDesigns>
  <LabelPrinters xmlns:d2p1="http://gapsolutions.com.au/schema/ezimanager">
    <d2p1:LabelPageLayoutStorePrinter>
      <d2p1:PageLayoutGuid>fa5a1410-7076-48dd-9b39-91c39a25afe1</d2p1:PageLayoutGuid>
      <d2p1:PrinterName>sample string 3</d2p1:PrinterName>
      <d2p1:StoreID>2</d2p1:StoreID>
      <d2p1:StoreName>sample string 4</d2p1:StoreName>
    </d2p1:LabelPageLayoutStorePrinter>
    <d2p1:LabelPageLayoutStorePrinter>
      <d2p1:PageLayoutGuid>fa5a1410-7076-48dd-9b39-91c39a25afe1</d2p1:PageLayoutGuid>
      <d2p1:PrinterName>sample string 3</d2p1:PrinterName>
      <d2p1:StoreID>2</d2p1:StoreID>
      <d2p1:StoreName>sample string 4</d2p1:StoreName>
    </d2p1:LabelPageLayoutStorePrinter>
  </LabelPrinters>
  <LayoutName>sample string 2</LayoutName>
  <MinimumSpacing>8</MinimumSpacing>
  <PageSize>17</PageSize>
  <Printer>sample string 15</Printer>
  <RowSpacing>5</RowSpacing>
  <Rows>3</Rows>
  <Stores xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Stores>
  <TearOffBottom>11</TearOffBottom>
  <TearOffHeight>9</TearOffHeight>
  <TearOffLeft>13</TearOffLeft>
  <TearOffRight>14</TearOffRight>
  <TearOffStyle>sample string 7</TearOffStyle>
  <TearOffTop>10</TearOffTop>
  <TearOffWidth>12</TearOffWidth>
</LabelPageLayout>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.