REL documentation
customers customerbarcodedefs (http://api.3plcentral.com/rels/customers/customerbarcodedefs)
Resource:
Collection: of customerbarcodedef
C# Rel Const:
Rels.CustomerSvc.CustomerBarcodeDefs
URI template:
{id}/barcodedefs
Obtain URI from:
/rels/customers/customer , /rels/customers/customersummary
get all barcode defs for given customer
Success status: 200; Response is cacheable
Name (* = required) Data Type Description
id * int Customer Id
Type Description
ResourceList IList<Customer.Models.BarcodeDef>
Name string name by which the barcode definition will be known on the records of the database
TotalLength int SUM(BarcodeDefElement.Length); here for convenience without having to perform the SUM
GroupWith string barcode defs with same GroupWith are considered companions, each of which should be scanned for completeness
Elements IEnumerable<Customer.Models.BarcodeDefElement> field content contained within the barcode, listed in order of appearance in the barcode
ElementType Customer.Models.BarcodeDefElementType how name is interpreted
- 0: TrackBy
- 1: SavedElement
- 2: Skip
Name string name of track-by, name of saved element, or blank if skip
Length int number of characters
Links IList<WebApi.Hal.Link>
- edit DELETE
- /rels/customers/customer
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/customerbarcodedef": [
      {
        "name": "str",
        "totalLength": 2,
        "groupWith": "str",
        "elements": [
          {
            "elementType": 0,
            "name": "str",
            "length": 2
          }
        ]
      }
    ]
  }
}
add barcode def for given customer; no need to set TotalLength, it's computed
Success status: 200
Name (* = required) Data Type Description
id * int Customer Id
definition for components contained within a single barcode
Type Description
Name string name by which the barcode definition will be known on the records of the database
TotalLength int SUM(BarcodeDefElement.Length); here for convenience without having to perform the SUM
GroupWith string barcode defs with same GroupWith are considered companions, each of which should be scanned for completeness
Elements IEnumerable<Customer.Models.BarcodeDefElement> field content contained within the barcode, listed in order of appearance in the barcode
ElementType Customer.Models.BarcodeDefElementType how name is interpreted
- 0: TrackBy
- 1: SavedElement
- 2: Skip
Name string name of track-by, name of saved element, or blank if skip
Length int number of characters
Sample content-type: application/hal+json
 
{
  "name": "str",
  "totalLength": 2,
  "groupWith": "str",
  "elements": [
    {
      "elementType": 0,
      "name": "str",
      "length": 2
    }
  ]
}
definition for components contained within a single barcode
Type Description
Name string name by which the barcode definition will be known on the records of the database
TotalLength int SUM(BarcodeDefElement.Length); here for convenience without having to perform the SUM
GroupWith string barcode defs with same GroupWith are considered companions, each of which should be scanned for completeness
Elements IEnumerable<Customer.Models.BarcodeDefElement> field content contained within the barcode, listed in order of appearance in the barcode
ElementType Customer.Models.BarcodeDefElementType how name is interpreted
- 0: TrackBy
- 1: SavedElement
- 2: Skip
Name string name of track-by, name of saved element, or blank if skip
Length int number of characters
Links IList<WebApi.Hal.Link>
- edit DELETE
- /rels/customers/customer
Sample accept: application/hal+json
{
  "name": "str",
  "totalLength": 2,
  "groupWith": "str",
  "elements": [
    {
      "elementType": 0,
      "name": "str",
      "length": 2
    }
  ]
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.