Aggregate 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]
[-]		 - Required. SOAP Message Header. Not used by TraceLink.
  soapenv:Body [1...1]
[-]		 - Required. SOAP Message Body.
    urn:Aggregate [1...1]
[-]		 - Required. Aggregate Message.
      AggregateRequest [0...1]
[-]		 -

Required. The aggregate request message to associate child serial numbers to a parent container. See the Strict element at the bottom of the table for important configuration information.

  • If true, then the aggregated item(s) must not already have a parent. If they do, an error is returned.
  • If false, items are re-associated to the new parent and the previous aggregations are adjusted (the system performs an implicit disaggregation and then aggregates the items).
        Container [1...1]
[-]		 - Required. Parent container serial information. If the container is specified, all items must currently be a child of the specified container.
          @sn [1...1]
[1/*]		 String Required. The parent container's serial number. See Serial Number Data Examples.
          @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 aggregate to the parent container's serial number.
            @sn [1...1]
[1/*]		 String Required. A child serial number. See Serial Number Data Examples.
            @namespace [0...1]
[1/*]		 String Not currently supported by TraceLink. Leave this field blank.
        EventDateTime [0...1]
[-]		 Date The date and time of the aggregation event in XSD Date format in GMT. If omitted, the system will record the current date-time.
        LocationType [0...1]
[1/*]		 String

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

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

The site-level location identifier where the event occurred.

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

Required. A flag that determines if the system performs an implicit disaggregation and then aggregates the items:

  • If true, then the aggregated item(s) must not already have a parent. If they do, an error will be returned.
  • If false, then the items are re-associated to the new parent and the items' previous aggregations are adjusted.
        ResetAggregation [0...1]
[-]		 Boolean

A flag indicating to disaggregate all existing items in a container and aggregate the new set of items into that container.

  • If true, TraceLink disaggregates all existing items in the specified container and aggregates the new set of items into that container.
  • If false (default), TraceLink does not disaggregate all existing items in the specified container.