Disaggregate Request Guidelines

See How To Use this Guide before interpreting the guidelines below.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.

The following data is sent in the request to TraceLink:

Data Element Occurs
Length
Type Description
soapenv:Envelope [1...1]
[]
- Required. SOAP Envelope root element.
  soapenv:Header [1...1]
[]
- Not used by TraceLink.
  soapenv:Body [1...1]
[]
- Required. SOAP Message Body.
    urn:Disaggregate [1...1]
[]
- Required. Disaggregate message.
      DisaggregateRequest [0...1]
[]
- Required. The disaggregate request message to disassociate child serial numbers from a parent container.
        Container [0...1]
[]
- The parent container's serial number. If Container is specified, all items must currently be a child of the specified container. If omitted, Strict must be set to false.
          @sn [1...1]
[1/*]
String Required. The parent serial number. See Serial Number Format Examples. *1
          @namespace [0...1]
[1/*]
String Not currently supported by TraceLink. Leave this field blank.
        Items [1...1]
[]
- Required. Child serial information.
          Item [1...*]
[]
- Required. A list of one or more child serial numbers to disaggregate from the parent container serial number.
            @sn [1...1]
[1/*]
String Required. A child serial number. See Serial Number Format Examples. *2
            @namespace [0...1
[]1/*]
String Not currently supported by TraceLink. Leave this field blank.
        EventDateTime [0...1]
[]
Date The date and time of the disaggregation event in XSD GMT date format. If omitted, the system will record the current date-time. *3
        LocationType [1...1]
[1/*]
String

The type of location where the event occurred. See the LocationId enumeration list for valid values.

        Location [1...1]
[1/*]
String

The site-level location identifier where the event occurred. *4

In most cases, this value is an SGLN, the format for which must be the numeric component only, with the urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events).
        Strict [1...1]
[]
Boolean
  • If true, the parent container must be specified. *5
  • If false, the parent container is not specified and the child serial numbers are implicitly disaggregated from their parent containers.