Label Setup

Get Label Setup

GET /api/.../labelsetup

Returns cataloging label setup for the logged in user.

Request Information

Parameters

None

DtoLabelSetup
Property Type Nullable Description
DefaultLabelOptionID int No Default label option ID (Cataloging = 1, Serials = 2).
CatalogingLabelOption DtoLabelOption No Cataloging label option.
LabelTypes List<DtoLabelType> Yes List of label types.
PrintOptions List<DtoLabelPrintOption> Yes List of print options.
LabelDefaultOptions List<DtoLabelDefaultOption> Yes List of label default options.
DtoLabelOption
Property Type Nullable Description
LabelTypeID int No Cataloging Label type ID.
PrintOptionID int No Cataloging Print option ID (OnDemand = 1, Batch = 2, QuickPrint = 3).
Serials LabelTypeID int No Serials Label type ID.
SerialsPrintOptionID int No SerialsPrint option ID (OnDemand = 1, Batch = 2, QuickPrint = 3).
DtoLabelType
Property Type Nullable Description
LabelTypeID int No Label type ID.
DisplayName string No Display name of label type.
DtoLabelPrintOption
Property Type Nullable Description
PrintOptionID int No Print option ID.
Description string No Description of print option.
DtoLabelDefaultOption
Property Type Nullable Description
OptionID int No Label default option ID.
OptionDesc string No Description of label default option.

Response Information

Example
application/json, text/json 
{
  "LabelTypes": [
    {
      "LabelTypeID": -13,
      "DisplayName": "PAS-Test"
    },
    {
      "LabelTypeID": -12,
      "DisplayName": "Zebra GK420t"
    },
    {
      "LabelTypeID": -11,
      "DisplayName": "Dymo LabelWriter 450"
    },
    {
      "LabelTypeID": -10,
      "DisplayName": "Intransit"
    },
    {
      "LabelTypeID": -8,
      "DisplayName": "test"
    },
    {
      "LabelTypeID": -6,
      "DisplayName": "test branch label"
    },
    {
      "LabelTypeID": -5,
      "DisplayName": "Testing 1"
    },
    {
      "LabelTypeID": -4,
      "DisplayName": "Marcia's Label"
    },
    {
      "LabelTypeID": 1,
      "DisplayName": "Spine Sheets"
    },
    {
      "LabelTypeID": 3,
      "DisplayName": "SL4 Sheets"
    },
    {
      "LabelTypeID": 4,
      "DisplayName": "SL6 Sheets"
    },
    {
      "LabelTypeID": 5,
      "DisplayName": "SLB Sheets"
    },
    {
      "LabelTypeID": 6,
      "DisplayName": "Serial Sheets"
    },
    {
      "LabelTypeID": 7,
      "DisplayName": "Spine Continuous feed rolls"
    },
    {
      "LabelTypeID": 11,
      "DisplayName": "SLB Continuous feed rolls"
    },
    {
      "LabelTypeID": 13,
      "DisplayName": "Computype 1 x 1.5 1 part label"
    },
    {
      "LabelTypeID": 14,
      "DisplayName": "Computype 1.125 x 1.25 1 part label"
    },
    {
      "LabelTypeID": 15,
      "DisplayName": "Computype 2 part label"
    },
    {
      "LabelTypeID": 16,
      "DisplayName": "Computype 3 part label"
    },
    {
      "LabelTypeID": 17,
      "DisplayName": "Computype 1.5 x 1  1 part label"
    }
  ],
  "PrintOptions": [
    {
      "PrintOptionID": 1,
      "Description": "On Demand"
    },
    {
      "PrintOptionID": 2,
      "Description": "Batch"
    },
    {
      "PrintOptionID": 3,
      "Description": "Quick print"
    }
  ],
  "DefaultLabelOptionID": 2,
  "CatalogingLabelOption": {
    "LabelTypeID": -13,
    "PrintOptionID": 1,
    "SerialsLabelTypeID": -13,
    "SerialsPrintOptionID": 1
  },
  "LabelDefaultOptions": [
      {
          "OptionID": 1,
          "OptionDesc":"Cataloging Option",
      },
      {
          "OptionID": 2,
          "OptionDesc": "Serials Option"
      }
  ]
}

HTTP Response Codes

Code Description
200 OK. Success