Take sample APIs

Why do I use these messages?

Use the following messages to mark product as sampled for quality assurance or inspection by government authorities.

Which report do these messages generate?

These messages generate the 552 - Withdrawal report in the Russia Compliance application if their contents meet the report conditions.

TraceLink disaggregates the sampled product if the serial numbers are aggregated to parent containers, which prompts a disaggregation event and initiates the 913 - Unit Extract report.

Take Product Sample (XML)

Message Type: SOM_TAKE_SAMPLE

Info Exchange Display Name: Take Product Sample

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.

Data Element Occurs
Length		 Type Description
som:SOMTakeSampleMessage [1...1]
[-]		 - Required. The root element of the Take Product Sample message.
  som:ControlFileHeader [1...1]
[-]		 - Required. The message document's header information. *1
    cmn:FileSenderNumber [1...1]
[1/20]		 String Required. The company identifier of the file’s sender. *2
    cmn:FileReceiverNumber [1...1]
[1/20]		 String Required. The company identifier of the file’s recipient. *3
    cmn:FileControlNumber [1...1]
[1/20]		 String Required. The message’s unique file control ID number. A file control ID number is mandatory for all messages. *4
    cmn:FileDate [1...1]
[10/10]		 Date Required. The date that the message is sent in YYYY-MM-DD format. Date and times must be in GMT. *5
    cmn:FileTime [1...1]
[9/9]		 Time Required. Time file generated in XML in HH:MM:SSZ format. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *6
  som:MessageBody [1...1]
[-]		 - Required. Contains the main body of the message.
    cmn:EventDateTime [1...1]
[0/*]		 Datetime Required. Timestamp of the date and time when the serial number is commissioned to the object with the UTC time zone indicator in XML YYYY-MM-DDTHH:MM:SS:mmZ format. *7
    cmn:EventTimeZoneOffset [1...1]
[0/*]		 String Required. Event time zone offset. Default value is +00:00 if the source is not populated. *8
    cmn:NumberList [1...1]
[1/*]		 String Required. Contains the list of serial numbers whose statuses are being updated.
      cmn:Serial [1…*]
[1/*]		 String Required. Serial number expressed in the GS1 Application Identifier format without parentheses for the AI keys. AI(01)(21) formatted serial number for GTINs. Non-GS1 serial numbers (e.g. China) are expressed in native format. *9
        @companyPrefix [0…1]
[0/*]		 String The GS1 Company Prefix used in GTIN-14 and SSCC serial numbers.
        @filterValue [0…1]
[0/*]		 String The filter value used in GTIN-14 serial numbers.
        @format [0...1]
[1/*]		 String Identifies the format of the serial numbers. Valid values:
  • AI(01)+AI(21)
  • CN-EDMC
    cmn:EventLocation [0…1]
[0/34]		 String Site-level SGLN or another party type of the location where the event occurs. SGLN and other party type formats are the numeric component only. If there is an urn prefix, it is stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events. *10
    cmn:EventLocationType [0…1]
[0/*]		 String Conditionally required if cmn:EventLocation is present. Business or location type of the event location identifier. *11

See the BusinessAndLocationId enumeration list for valid values.
    cmn:TakeSampleReasonCode [0…1]
[0/*]		 String Required. Reason identifying why a serial number status is updated. *12

See the TakeSampleReasonCode enumeration list for valid values.
    cmn:ReasonDescription [0…1]
[0/*]		 String Text description of the reason for status update. *13
    cmn:InspectionCountryCode [0…1]
[1/*]		 String

The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *14

See the ISOCountryCode enumeration list for valid values.
    cmn:SamplingPartyId [0…1]
[0/*]		 String Required. The business or location identifier for the entity performing the sampling. *15
      @type [1...1]
[1/*]		 String Required. The business or location type for the quality control entity identifier.  *16

See the BusinessAndLocationId enumeration list for valid values.

 

<?xml version="1.0" encoding="UTF-8"?> 
<som:SOMTakeSampleMessage xmlns:som="urn:tracelink:mapper:sl:serialized_operations_manager" xmlns:cmn="urn:tracelink:mapper:sl:commontypes">
    <som:ControlFileHeader>
        <cmn:FileSenderNumber>8888882028655</cmn:FileSenderNumber>
        <cmn:FileReceiverNumber>8888882028677</cmn:FileReceiverNumber>
        <cmn:FileControlNumber>0000000001</cmn:FileControlNumber>
        <cmn:FileDate>2019-03-21</cmn:FileDate>
        <cmn:FileTime>06:31:32Z</cmn:FileTime>
    </som:ControlFileHeader>
    <som:MessageBody>
        <cmn:EventDateTime>2019-03-21T06:31:32Z</cmn:EventDateTime>
        <cmn:EventTimeZoneOffset>+00:00</cmn:EventTimeZoneOffset>
        <cmn:NumberList>
            <cmn:Serial companyPrefix="1508820" filterValue="1" format="AI(01)+AI(21)">015088202501033321100000060001</cmn:Serial>
            <cmn:Serial companyPrefix="1508820" filterValue="1" format="AI(01)+AI(21)">015088202501033321100000060002</cmn:Serial>
            <cmn:Serial companyPrefix="1508820" filterValue="1" format="AI(01)+AI(21)">015088202501033321100000060003</cmn:Serial>
            <cmn:Serial companyPrefix="1508820" filterValue="1" format="AI(01)+AI(21)">015088202501033321100000060004</cmn:Serial>
            <cmn:Serial companyPrefix="1508820" filterValue="1" format="AI(01)+AI(21)">015088202501033321100000060005</cmn:Serial>
        </cmn:NumberList>
        <cmn:EventLocation>8888882028655</cmn:EventLocation>
        <cmn:EventLocationType>GLN</cmn:EventLocationType>
        <cmn:TakeSampleReasonCode>SELECTIVE_CONTROL</cmn:TakeSampleReasonCode>
        <cmn:ReasonDescription>Released by Quality</cmn:ReasonDescription>
        <cmn:InspectionCountryCode>US</cmn:InspectionCountryCode>
        <cmn:SamplingPartyId type="GLN">0882028677010</cmn:SamplingPartyId>
    </som:MessageBody>
</som:SOMTakeSampleMessage>
Data Element Error Message Description
Class 1
cmn:EventDateTime Event date time is required !!! The error occurs if the source is empty or null.
cmn:NumberList At least one serial number is required !!! The error occurs if the source is empty or null.
cmn:Serial At least one serial number is required !!! The error occurs if the source is empty or null.
cmn:EventLocationType Valid event location type is required !!! The error occurs if the source is empty or null.
cmn:TakeSampleBusinessCode Valid take sample reason code required !!! The error occurs if the source is empty or null.
cmn:InspectionCountryCode Inspection Country Code must be two characters !!! The error occurs if the source is present, but the length does not equal two characters.
cmn:SamplingPartyId | @type Valid sampling party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Valid sampling party identifier type is required !!! The error occurs if the source is empty or null.
Class 2
cmn:ReasonDescription Reason Code is required for products sampled in Russia The error occurs if cmn:InspectionCountryCode = "RU" but the source is empty or null.
cmn:Serial Serial Number <SerialNumber> does not exist. The error occurs if the source is empty or null.
Serial number <Serial Number> is not commissioned. The error occurs if Status is not Commissioned.
Serial number <Serial Number> is not associated with Location <Location Name>. The error occurs if the source is associated with a company or location that differs from the transaction company or location.
Cannot update the status on serial number <Serial Number> with UOM <PackagingLevelUOM>. Serial numbers must be Eaches. The error occurs if the epc packaging level being sampled is not an Each.
Operation could not be performed because serial number <Serial Number> is not empty. The error occurs if packaging level UOM is not set, but the EPC has child EPCs.
cmn:SamplingPartyId Field is not populated and Country of Inspection = RU ("Russia") The error occurs if cmn:InspectionCountryCode = "RU" but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Take Product Sample (EPCIS v1.2)

Message Type: SOM_TAKE_SAMPLE

Info Exchange Display Name: Take Product Sample

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.

Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1...1]
[-]		 - Required. EPCIS message root element.
  @schemaVersion [1...1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *17
  @creationDate [1...1]
[1/*]		 DateTime Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *18
  EPCISHeader [0…1]
[-]		 - Required. The XML file control header.
    sbdh:StandardBusinessDocumentHeader [1...1]
[-]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1...1]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *19
      sbdh:Sender [1…*]
[-]		 - Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1...1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *20

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141

See the MDPartyTypeAttributes enumeration list for valid values.

GLNs do not have an urn/http prefix.
          @Authority [1...1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *21

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:Receiver [1…*]
[-]		 - Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that receives the standard business document. The Receiver element is used only once with GS1 XML messages.
        sbdh:Identifier [1...1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *22

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141

See the MDPartyTypeAttributes enumeration list for valid values.

GLNs do not have an urn/http prefix.
          @Authority [1...1]
[1/*]		 String Required. The receiver identifier type. The Authority was previously expected to be set to "GLN" for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *23

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:DocumentIdentification [1...1]
[-]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1...1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *24
        sbdh:TypeVersion [1...1]
[0/*]		 String Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0. *25
        sbdh:InstanceIdentifier [1...1]
[1/*]		 String Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others. *26
        sbdh:Type [1...1]
[0/*]		 String Required. The document type. The Type value is set to "Events" for a take product sample event. *27
        sbdh:CreationDateAndTime [1...1]
[0/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *28
  EPCISBody [1...1]
[-]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1...1]
[-]		 - Required. Includes the ObjectEvent with tl:takeProductSampleEventExtensions.
      choice%1 [1…*]
[-]		 - Required. Choice element. Only the ObjectEvent is present.
      ObjectEvent [1…*]
[-]		 - Required. ObjectEvent is the only choice within choice%1. Indicates a take product sample event when all of the following is true:
  • action = OBSERVE
  • bizStep = https://epcis.tracelink.com/bizStep/sampling
  • disposition = https://epcis.tracelink.com/disp/sampled
        eventTime [1...1]
[1/*]		 DateTime Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. The system expects the Z to be appended if it is not included; however, the system assumes that the time is GMT and therefore appends the Z. *29
        eventTimeZoneOffset [1...1]
[1/*]		 String Required. Time zone offset in effect at the time and place where the event occurred, consistent with the choice made for eventTime, per Section 7.2.8 of [EPCIS1.0.1]. *30
        epcList [1...1]
[-]		 - Required. List of the EPCs of the topmost commissioned containers (e.g. pallets, cases).
          epc [0…*]
[0/*]		 String

Required. Identifier of the parent container in EPC Pure Identity URI format. *31

See the EPCPureIdentifierFormat enumeration list for valid values.
        action [1...1]
[0/*]		 String Required. The action type of the event. The action value must equal OBSERVE. *32
        bizStep [0…1]
[0/*]		 AnyURI Required. The business step taken in the event. The bizStep value must equal http://epcis.tracelink.com/bizstep/sampling. *33
        disposition [0…1]
[0/*]		 AnyURI Required. The status of the message. The disposition value must equal http://epcis.tracelink.com/disp/sampled. *34
        readPoint [0…1]
[-]		 - The location where the event occurs.
          id [1...1]
[0/*]		 AnyURI

The SGLN EPC pure identifier of the location where the event occurs. *35
        bizLocation [0...1]
[-]		 - Not used.
          id [1...1]
[1/*]		 AnyURI Not used.
        bizTransactionList [0…1]
[-]		 - Not used.
        tl:locationId [0…1]
[0/*]		 String Serialized Operations Manager external partner location identifier. When an external Serialized Operations Manager partner submits a message, TraceLink uses the subscriber company integration user to perform the action and log this in the audit trail. This causes all messages executed by the external Serialized Operations Manager subscriber to be attributed to that company. *36
          @type [0…1]
[0/*]		 String Attribute identifying the location type. See the BusinessAndLocationId enumeration list for valid values. *37
        tl:takeProductSampleEventExtensions [0…1]
[-]		 - Take product sample event extensions group.
          tl:takeSampleReasonCode [0…1]
[0/*]		 String Required. if tl:InspectionCountryCode = RU. Reason identifying why a serial number status was updated. *38

See the TakeSampleReasonCode enumeration list for valid values.
          tl:reasonDescription [0…1]
[0/*]		 String Text description of the reason for the status update. *39
          tl:inspectionCountryCode [0…1]
[0/*]		 String

The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *40

See the ISOCountryCode enumeration list for valid values.
          tl:samplingPartyId [0…1]
[0/*]		 String Required. if tl:InspectionCountryCode = RU. Business or location identifier for the entity performing the sampling. *41
            @type [1…1]
[1/*]		 String

Required. Business or location type for the quality control entity identifier. *42

See the BusinessAndLocationId enumeration list for valid values.

 
<?xml version="1.0" encoding="UTF-8"?>
<epcis:EPCISDocument xmlns:tl="http://epcis.tracelink.com/ns" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" 
  xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" schemaVersion="1.2" creationDate="2017-02-20T17:45:20Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8779891013658</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8811891013778</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>201907251745200001</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-07-25T21:57:20Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2019-07-25T21:57:20Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024596</epc>
                </epcList>
                <action>OBSERVE</action>
                <bizStep>http://epcis.tracelink.com/bizstep/sampling</bizStep>
                <disposition>http://epcis.tracelink.com/disp/sampled</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:9297187.01994.0</id>
                </readPoint>
                <bizLocation>
                    <id/>
                </bizLocation>
                <tl:locationId type="GLN">8811891013778</tl:locationId>
                <tl:takeProductSampleEventExtensions>
                    <tl:takeSampleReasonCode>SELECTIVE_CONTROL</tl:takeSampleReasonCode>
                    <tl:reasonDescription>Released by Quality</tl:reasonDescription>
                    <tl:inspectionCountryCode>US</tl:inspectionCountryCode>
                    <tl:samplingPartyId type="GLN">8811891013778</tl:samplingPartyId>
                </tl:takeProductSampleEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description
Class 1
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!!

The error occurs if the source is present, but there is no matching entry in the lookup file.
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
ObjectEvent Object event for take product sample is required !!! The error occurs if the source is empty or null.
epc Invalid EPC format !!! The error occurs if the source is invalid.
bizStep bizStep "http://epcis.tracelink.com/bizstep/sampling" is required for ObjectEvent take product sample !!! The error occurs if the source does not equal "http://epcis.tracelink.com/bizstep/sampling".
disposition Dispositio​n "http://epcis.tracelink.com/disp/sampled" is required for ObjectEvent take product sample !!! The error occurs if the source does not equal "http://epcis.tracelink.com/disp/sampled".
readPoint | id Valid readPoint identifier type is required !!! The error occurs if the source is invalid.
tl:takeSampleReasonCode Valid take sample reason code required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:samplingPartyId | @type Valid sampling party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Class 2
epc Serial Number <SerialNumber> does not exist. The error occurs if the source is empty or null.
Serial number <Serial Number> is not commissioned. The error occurs if the serial number status is not Commissioned.
Serial number <Serial Number> is not associated with Location <Location Name>. The error occurs if the source is not associated with the correct tl:locationId.
Cannot update the status on serial number <Serial Number> with UOM <PackagingLevelUOM>. Serial numbers must be Eaches. The error occurs if the source packaging level is not an each.
Operation could not be performed because serial number <Serial Number> is not empty. The error occurs if the source packaging level is not set, but has child serial numbers.
tl:takeSampleReasonCode Reason Code is required for products sampled in Russia The error occurs if tl:inspectionCountryCode = "RU" but the source is empty or null.
tl:samplingPartyId Field is not populated and Country of Inspection = RU ("Russia") The error occurs if tl:inspectionCountryCode = "RU" but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Take Product Sample Event (EPCIS v1.2)

Message Types:

  • SOM_TAKE_SAMPLE_EVENT
  • SOM_TAKE_SAMPLE_EVENT_IB

Info Exchange Display Name: Take Product Sample

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.

Data Element Occurs
Length		 Type Description
epcis:EPCISDocument [1...1]
[–]		 - Required. EPCIS message root element.
  @schemaVersion [1...1]
[0/*]
 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *43
  @creationDate [1...1]
[1/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *44
  EPCISHeader [0…1]
[–]		 - Required. The XML file control header.
    sbdh:StandardBusinessDocumentHeader [1...1]
[–]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1...1]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *45
      sbdh:Sender [1…*]
[–]		 - Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1...1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *46

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1...1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *47

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:Receiver [1…*]
[–]		 - Required. A unique identification key for the Receiver party of the message, representing the organization that created the standard business document. The Receiver element must be used only once with GS1 XML messages.
        sbdh:Identifier [1...1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *48

SGLN and all other party types should be sent with a GS1-conformant uri prefix. For example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLN will not have a urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1...1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *49

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:DocumentIdentification [1...1]
[–]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1...1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *50
        sbdh:TypeVersion [1...1]
[0/*]		 String Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0. *51
        sbdh:InstanceIdentifier [1...1]
[1/*]		 String Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others. *52
        sbdh:Type [1...1]
[0/*]		 String Required. This element identifies the type of the document. The Type value must be set to "Events". *53
        sbdh:CreationDateAndTime [1...1]
[0/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z. *54
  EPCISBody [1...1]
[–]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1...1]
[–]		 - Required. Includes the ObjectEvent with tl:takeProductSampleEventExtensions.
      choice%1 [1…*]
[–]		 - Required. Choice element. Only the ObjectEvent is present.
      ObjectEvent [1…*]
[–]		 - Required. ObjectEvent is the only choice within choice%1. Indicates a take product sample event when all of the following is true:
  • action = OBSERVE
  • bizStep = https://epcis.tracelink.com/bizStep/sampling
  • disposition = https://epcis.tracelink.com/disp/sampled
        eventTime [1...1]
[1/*]		 DateTime Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. The system expects the Z to be appended if it is not included; however, the system assumes that the time is GMT and therefore appends the Z. *55
        eventTimeZoneOffset [1...1]
[1/*]		 String Required. Time zone offset in effect at the time and place where the event occurred, consistent with what choice was made for eventTime. Per Section 7.2.8 of [EPCIS1.0.1]. *56
        epcList [1...1]
[–]		 - Required. List of the EPCs of the topmost commissioned containers (e.g. pallets, cases).
          epc [0…*]
[0/*]		 String Required. Identifier of the parent container in EPC Pure Identity URI format. *57

See the EPCPureIdentifierFormat numeration list for valid values.
        action [1...1]
[0/*]		 String Required. The action type of the event. The action value must equal OBSERVE. *58
        bizStep [0…1]
[0/*]		 AnyURI Required. The business step taken in the event. The bizStep value must equal http://epcis.tracelink.com/bizstep/sampling. *59
        disposition [0…1]
[0/*]		 AnyURI Required. The status of the message. The disposition value must equal http://epcis.tracelink.com/disp/sampled. *60
        readPoint [0…1]
[–]		 - The location where the event occurs.
          id [1...1]
[0/*]		 AnyURI Required. The SGLN EPC pure identifier of the location where the event occurs. *61

See the MDBusinessPartyTypeAttributes enumeration list for valid values.
        bizLocation [1...1]
[–]		 - Not used.
          id [1...1]
[1/*]		 AnyURI Not used.
        bizTransactionList [0…1]
[–]		 - Not used.
        tl:locationId [0…1]
[0/*]		 String Serialized Operations Manager External partner location identifier. When an external Serialized Operations Manager partner submits a message, TraceLink uses the subscriber company integration user to perform the action and log this in the audit trail. This causes all messages executed by the external Serialized Operations Manager subscriber to be attributed to that company. *62
          @type [0…1]
[0/*]		 String Attribute identifying the location type. *63

See the LocationIdType enumeration list for valid values.
        tl:takeProductSampleEventExtensions [0…1]
[–]		 - Take product sample event extensions group.
          tl:takeSampleReasonCode [0…1]
[0/*]		 String Required. Reason identifying why a serial number status was updated. *64

See the TakeSampleReasonCode enumeration list for valid values.
          tl:reasonDescription [0…1]
[0/*]		 String Text description of the reason for the status update. *65
          tl:inspectionCountryCode [0…1]
[0/*]		 String The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *66

See the ISOCountryCode enumeration list for valid values.
          tl:samplingPartyId [0…1]
[0/*]		 String Required. Business or location identifier for the entity performing the sampling. *67
            @type [1…1]
[1/*]		 String

Required. Business or location type for the quality control entity identifier. *68

See the BusinessAndLocationId enumeration list for valid values.
 
<?xml version="1.0" encoding="UTF-8"?>
<epcis:EPCISDocument xmlns:tl="http://epcis.tracelink.com/ns" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" 
  xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" schemaVersion="1.2" creationDate="2017-02-20T17:45:20Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8779891024769</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8779891013658</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>2019120210090032</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-12-02T10:09:32Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2019-12-02T10:09:32Z</eventTime>
                <eventTimeZoneOffset>-04:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:088202.5503022.100000000670</epc>
                </epcList>
                <action>OBSERVE</action>
                <bizStep>https://epcis.tracelink.com/bizStep/sampling</bizStep>
                <disposition>https://epcis.tracelink.com/disp/sampled</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:9997777.02449.0</id>
                </readPoint>
                <bizLocation>
                    <id>urn:epc:id:sgln:9997777.02449.0</id>
                </bizLocation>
                <tl:locationId type="GLN">8888882028677</tl:locationId>
                <tl:takeProductSampleEventExtensions>
                    <tl:takeSampleReasonCode>QUALITY_CONTROL</tl:takeSampleReasonCode>
                    <tl:reasonDescription>Released by Quality</tl:reasonDescription>
                    <tl:inspectionCountryCode>US</tl:inspectionCountryCode>
                    <tl:samplingPartyId type="GLN">8888882028677</tl:samplingPartyId>
                </tl:takeProductSampleEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description Inbound / Outbound
Class 1
sbdh:Sender | sbdh:Identifier Source message sender is required !!! The error occurs if the source is empty or null. OB
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!! The error occurs if the source is invalid. IB
Partner type in source type attribute is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
sbdh:Receiver | sbdh:Identifier Source message receiver is required !!! The error occurs if the source is empty or null. OB
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is invalid. IB
Partner type in source type attribute is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
ObjectEvent Object event for take product sample is required !!! The error occurs if the source is empty or null.  
At least one take product sample event is required !!! The error occurs if the source is empty or null. OB
epc Invalid EPC format !!! The error occurs if the source is invalid. IB
Serial number is required !!! The error occurs if the source is empty or null. OB
Valid serial number format is required !!! The error occurs if the source is invalid. OB
bizStep bizStep http://epcis.tracelink.com/bizstep/sampling is required for ObjectEvent take product sample !!! The error occurs if the source does not equal "http://epcis.tracelink.com/bizstep/sampling". IB
disposition Dispositio​n http://epcis.tracelink.com/disp/sampled is required for ObjectEvent take product sample !!! The error occurs if the source does not equal "http://epcis.tracelink.com/disp/sampled". IB
readPoint | id Valid readPoint identifier type is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. IB
Valid event location identifier type is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. OB
cmn:EventLocation Valid readPoint identifier type is required !!! The error occurs if the source is empty or null, or is not a valid value from the enumeration list. IB
tl:takeSampleReasonCode Valid take sample reason code required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
tl:samplingPartyId | @type Valid sampling party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file. IB/OB
Class 2
- - - -
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

ESM Take Product Sample (EPCIS v1.2)

Message Type: SOM_ESM_TAKE_SAMPLE

Info Exchange Display Name: ESM Take Product Sample

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.

Data Element Occurs
Length		 Format Description
epcis:EPCISDocument [1…1]
[–]		 - Required. EPCIS message root element.
  @schemaVersion [1…1]
[0/*]		 Decimal Required. The version of the EPCIS schema used to populate the EPCIS document elements. Must equal 1.2. *69
  @creationDate [1…1]
[1/*]		 DateTime Required. Date the message was created in YYYY-MM-DDTHH:MM:SS:mmZ format. *70
  EPCISHeader [0…1]
[–]		 - Required. The XML file control header.
    sbdh:StandardBusinessDocumentHeader [1…1]
[–]		 - Required. Business header information including EPCIS Header Version, Sender, and Receiver information, along with the document identification.
      sbdh:HeaderVersion [1…1]
[0/*]		 String Required. Version of the Standard Business Document Header (SBDH). The HeaderVersion must be set to 1.0. *71
      sbdh:Sender [1…*]
[–]		 - Required. A unique identification key for the Sender party of the message, representing the organization that created the standard business document. The Sender element must be used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *72

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String Required. The sender identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *73

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:Receiver [1…*]
[–]		 - Required. Indicates a unique identification key for the direct Receiver party of the message, representing the organization that receives the standard business document. The Receiver element is used only once with GS1 XML messages.
        sbdh:Identifier [1…1]
[1/*]		 String Required. The value of the Identifier element may be a GLN, SGLN, or any other supported business party type. *74

Send SGLN and all other party types with the GS1-conformant uri prefix, for example:

  • urn:epc:id:sgln:088202.867701.0
  • http://epcis.gs1us.org/hc/dea/loc/10023141
GLNs do not have an urn/http prefix.

See the MDPartyTypeAttributes enumeration list for valid values.
          @Authority [1…1]
[1/*]		 String Required. The receiver identifier type. The Authority was previously expected to be set to GLN for GS1 XML messages. An update made in December 2016 changed this to accept additional values. *75

See the MDPartyTypeEnums enumeration list for valid values.
      sbdh:DocumentIdentification [1…1]
[–]–]		 - Required. Contains the identification group for the message.
        sbdh:Standard [1…1]
[0/*]		 String Required. Name of the document standard contained in the file or message. The standard value for this field is EPCglobal. *76
        sbdh:TypeVersion [1…1]
[0/*]		 String Required. Reflects the version of the document included. This is the complete version of the document itself and is different from the HeaderVersion as these are hard-coded values. The TypeVersion is set to 1.0. *77
        sbdh:InstanceIdentifier [1…1]
[1/*]		 String Required. Reference information that uniquely identifies this instance of the Standard Business Document between the Sender and the Receiver. This identifier confirms this document as being distinct from others. *78
        sbdh:Type [1…1]
[0/*]		 String Required. Identifies the document type. The Type value is set to Events for a shipment event. *79
        sbdh:CreationDateAndTime [1…1]
[0/*]		 DateTime Required. The date and time of the SBDH document's creation. GMT create date and time for the EPCIS message. The system expects the Z to be appended; however, if it is not included, the system assumes that the time is GMT and therefore appends the Z.
  EPCISBody [1...1]
[–]		 - Required. Contains all of the EPCIS events for this message.
    EventList [1...1]
[–]		 - Required. Includes the ObjectEvent with tl:takeProductSampleEventExtensions.
      choice%1 [1…*]
[–]		 - Required. Choice element. Only the ObjectEvent is present.
      ObjectEvent [1…*]
[–]		 - Required. ObjectEvent is the only choice within choice%1. Indicates a take product sample event when all of the following is true:
  • action = OBSERVE
  • bizStep = https://epcis.tracelink.com/bizStep/sampling
  • disposition = https://epcis.tracelink.com/disp/sampled
        eventTime [1...1]
[1/*]		 DateTime Required. The time stamp of the date/time when the event occurred in YYYY-MM-DDTHH:MM:SS.mm or YYYY-MM-DDTHH:MM:SS.mmm format. Must include a time zone indicator as specified in Section 9.5 of [EPCIS1.0.1]. The system expects the Z to be appendedif it is not included; however, the system assumes that the time is GMT and therefore appends the Z. *80
        eventTimeZoneOffset [1...1]
[1/*]		 String Required. The time zone offset in the place where the event occurred, consistent with what choice was made for eventTime. A time offset is an amount of time subtracted from or added to UTC (Coordinated Universal Time) to get the current civil time, whether it is standard time or Daylight saving time. Per Section 7.2.8 of [EPCIS1.0.1]. *81
        epcList [1...1]
[–]		 - Required. List of the EPCs of the topmost commissioned containers (e.g. pallets, cases).
          epc [0…*]
[0/*]		 String Required. Identifier of the parent container in EPC Pure Identity URI format. *82

See the EPCPureIdentifierFormat enumeration list for valid values.
        action [1...1]
[0/*]		 String Required. The action type of the event. The S value must equal OBSERVE. *83
        bizStep [0…1]
[0/*]		 AnyURI Required. The business step taken in the event. The bizStep value must equal http://epcis.tracelink.com/bizstep/sampling. *84
        disposition [0…1]
[0/*]		 AnyURI Required. The status of the message. The disposition value must equal http://epcis.tracelink.com/disp/sampled. *85
        readPoint [0…1]
[–]		 - The location where the event occurs.
          id [1...1]
[0/*]		 AnyURI The SGLN EPC pure identifier of the location where the event occurs. *86

See the MDBusinessPartyTypeAttributes enumeration list for valid values.
        bizLocation [1...1]
[–]		 - Not used.
          id [1...1]
[1/*]		 AnyURI Not used.
        bizTransactionList [0…1]
[–]		 - Not used.
        tl:locationId [0…1]
[0/*]		 String Serialized Operations Manager External partner location identifier. When an external Serialized Operations Manager partner submits a message, TraceLink uses the subscriber company integration user to perform the action and log this in the audit trail. This causes all messages executed by the external Serialized Operations Manager subscriber to be attributed to that company. *87
          @type [0…1]
[0/*]		 String Attribute identifying the location type. *88

See the LocationIdType enumeration list for valid values.
        tl:takeProductSampleEventExtensions [0…1]
[–]		 - Take product sample event extensions group.
          tl:takeSampleReasonCode [0…1]
[0/*]		 String Required. Reason identifying why a serial number status was updated. *89

See the TakeSampleReasonCode enumeration list for valid values.
          tl:reasonDescription [0…1]
[0/*]		 String Text description of the reason for the status update. *90
          tl:inspectionCountryCode [0…1]
[0/*]		 String The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. *91

See the ISOCountryCode enumeration list for valid values.
          tl:samplingPartyId [0…1]
[0/*]		 String Required. Business or location identifier for the entity performing the sampling. *92
            @type [1…1]
[1/*]		 String Required. Business or location type for the quality control entity identifier. *93

See the BusinessAndLocationId enumeration list for valid values.
 
<?xml version="1.0" encoding="UTF-8"?>
<epcis:EPCISDocument xmlns:tl="http://epcis.tracelink.com/ns" xmlns:sbdh="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader" 
  xmlns:cbvmda="urn:epcglobal:cbv:mda" xmlns:epcis="urn:epcglobal:epcis:xsd:1" schemaVersion="1.2" creationDate="2017-02-20T17:45:20Z">
    <EPCISHeader>
        <sbdh:StandardBusinessDocumentHeader>
            <sbdh:HeaderVersion>1.0</sbdh:HeaderVersion>
            <sbdh:Sender>
                <sbdh:Identifier Authority="GLN">8779891013658</sbdh:Identifier>
            </sbdh:Sender>
            <sbdh:Receiver>
                <sbdh:Identifier Authority="GLN">8811891013778</sbdh:Identifier>
            </sbdh:Receiver>
            <sbdh:DocumentIdentification>
                <sbdh:Standard>EPCglobal</sbdh:Standard>
                <sbdh:TypeVersion>1.0</sbdh:TypeVersion>
                <sbdh:InstanceIdentifier>201907251745200001</sbdh:InstanceIdentifier>
                <sbdh:Type>Events</sbdh:Type>
                <sbdh:CreationDateAndTime>2019-07-25T21:57:20Z</sbdh:CreationDateAndTime>
            </sbdh:DocumentIdentification>
        </sbdh:StandardBusinessDocumentHeader>
    </EPCISHeader>
    <EPCISBody>
        <EventList>
            <ObjectEvent>
                <eventTime>2019-07-25T21:57:20Z</eventTime>
                <eventTimeZoneOffset>-05:00</eventTimeZoneOffset>
                <epcList>
                    <epc>urn:epc:id:sgtin:068202.0401034.11220207024596</epc>
                </epcList>
                <action>OBSERVE</action>
                <bizStep>http://epcis.tracelink.com/bizstep/sampling</bizStep>
                <disposition>http://epcis.tracelink.com/disp/sampled</disposition>
                <readPoint>
                    <id>urn:epc:id:sgln:9297187.01994.0</id>
                </readPoint>
                <bizLocation>
                    <id/>
                </bizLocation>
                <tl:locationId type="GLN">8811891013778</tl:locationId>
                <tl:takeProductSampleEventExtensions>
                    <tl:takeSampleReasonCode>SELECTIVE_CONTROL</tl:takeSampleReasonCode>
                    <tl:reasonDescription>Released by Quality</tl:reasonDescription>
                    <tl:inspectionCountryCode>US</tl:inspectionCountryCode>
                    <tl:samplingPartyId type="GLN">8811891013778</tl:samplingPartyId>
                </tl:takeProductSampleEventExtensions>
            </ObjectEvent>
        </EventList>
    </EPCISBody>
</epcis:EPCISDocument>
Data Element Error Message Description
Class 1
sbdh:Sender | sbdh:Identifier | @Authority Valid Sender/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
sbdh:Receiver | sbdh:Identifier | @Authority Valid Receiver/Identifier Authority is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
ObjectEvent Object event for take product sample is required !!! The error occurs if the source is empty or null.
epc Invalid EPC format !!! The error occurs if the source is invalid.
bizStep bizStep "http://epcis.tracelink.com/bizstep/sampling" is required for ObjectEvent take product sample !!! The error occurs if the source does not equal "http://epcis.tracelink.com/bizstep/sampling".
disposition Dispositio​n "http://epcis.tracelink.com/disp/sampled" is required for ObjectEvent take product sample !!! The error occurs if the source does not equal "http://epcis.tracelink.com/disp/sampled".
readPoint | id Valid readPoint identifier type is required !!! The error occurs if the source is invalid.
tl:takeSampleReasonCode Valid take sample reason code required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
tl:samplingPartyId | @type Valid sampling party identifier type is required !!! The error occurs if the source is present, but there is no matching entry in the lookup file.
Class 2
epc Serial Number <SerialNumber> does not exist. The error occurs if the source is empty or null.
Serial number <Serial Number> is not commissioned. The error occurs if the serial number status is not Commissioned.
Serial number <Serial Number> is not associated with Location <Location Name>. The error occurs if the source is not associated with the correct tl:locationId.
Cannot update the status on serial number <Serial Number> with UOM <PackagingLevelUOM>. Serial numbers must be Eaches. The error occurs if the EPC packaging level being sampled is not an each.
Operation could not be performed because serial number <Serial Number> is not empty. The error occurs if the EPC has child EPCs.
tl:takeSampleReasonCode Reason Code is required for products sampled in Russia The error occurs if tl:inspectionCountryCode = "RU" but the source is empty or null.
tl:SamplingPartyId Field is not populated and Country of Inspection = RU ("Russia") The error occurs if tl:inspectionCountryCode = "RU" but the source is empty or null.
Class 3
The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered.

Take Product Sample (SOAP)

Guidelines

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. Not used.
  soapenv:Body [1...1]
[-]		 - Required. SOAP Message Body.
    urn:TakeSample [1...1]
[-]		 - Required. Request message that sets a Sampled attribute for all provided serial numbers.
      SampleRequest [0...1]
[-]		 - Required. SampleRequest request message.
        Items [1...1]
[-]		 - Required. List of serial numbers (repeating element).
          @sn [1...*]
[1/*]		 String Required. Serial number that is being sampled. See Serial Number Data Examples. *94
          @namespace [0...1]
[1/*]		 String Not supported by TraceLink.
        EventDateTime [0...1]
[-]		 Date The time of the Take Sample event in XSD GMT date format. If omitted, the system records the current date and time. *95
        Location [0...1]
[1/*]		 String Site level SGLN of the location where the event occurred. SGLN format will be numeric component only, with urn prefix stripped (e.g. 8888882.02867.0 instead of urn:epc:id:sgln:8888882.02867.0 typically found in EPCIS events). If it is not specified and the API credentials used in the call are specific to a company location, TraceLink will attempt to default the Location based upon the corresponding Company Location master data entry. *96
        LocationType [0...1]
[1/*]		 String The type of the Location identifier. 97

See the BusinessAndLocationId enumeration list for valid values.
        ReasonDescription [0...1]
[1/100]		 String An explanation for why the serial number is being sampled. If ReasonDescription is longer than 100 characters, only the first 100 characters will be stored. *98
        TakeSampleReasonCode [0...1]
[1/*]		 String Required. Reason code identifying why serial number is being sampled. See the TakeSampleReasonCode enumeration list for valid values.
        InspectionCountryCode [0...1]
[1/*]		 String

Required. The country where the inspection is being performed using the standard two-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code. See the ISOCountryCode enumeration list for valid values.
        SamplingPartyID [0...1]
[-]		   Required. Business or location identifier for the entity performing the sampling.
          @identifiervalue [1...1]
[1/*]		 String Required. Value of the identifier.
          @identifiertype [1...1]
[1/*]		 String

Required. Type of the identifier value. See the BusinessAndLocationId enumeration list for valid values.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:tracelink:soap">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:TakeSample>
         <SampleRequest>
            <Items>
               <Item sn="0100882025030220216370871" namespace="?"/>
            </Items>
            <EventDateTime>2015-06-01T17:10:16</EventDateTime>
            <Location>8888882.02867.0</Location>
            <ReasonDescription>Sample of product given to on-site client</ReasonDescription>
         </SampleRequest>
      </urn:TakeSample>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Exception Code Exception Message
BADITEMSTATE Cannot perform operation on serial number <serial number> with item state <item state>. This operation can only be performed when the serial number is <item state>.
BADSTATETRANSITION Cannot perform operation on serial number <serial number> to change item state/serial number state from <serial number state> to <serial number state>. The allowed new states are <serial number states>.
EVENTTIMEAFTERNOW Event time stamp must not be in the future.
EVENTTIMEBEFORELASTEVENT Event time stamp is earlier than the last event for serial number <serial number>.
INTERNALERROR SerialNumberState for <serial number> is null.
INTERNALERROR Internal error from server: <server information>.
INTERNALERROR ItemStateTransitions.properties did not load correctly.
INTERNALERROR SerialNumberStateTransitions.properties did not load correctly.
NOTCOMMISSIONED Serial number <serial number> is not commissioned.
NOTEACH Cannot perform operation on serial number <serial number> with UOM <unit of measurement>. The operation can only be performed on unit level serial numbers.
NOTEMPTY Operation could not be performed because serial number <serial number> is not empty.
NOTVALIDLOCATION Location <location identifier> was not valid for serial number <serial number>.
SNNOTFOUND Serial number <serial number> does not exist.
VALIDATION Reason Code is required for products sampled in Russia.
VALIDATION Sample Party is required for products sampled in Russia.

Guidelines

The following data is included in the message response:

Data Element Occurs
Length		 Type Description
S:Envelope [1...1]
[-]		 - Required. SOAP Envelope root element.
  S:Body [1...1]
[-]		 - Required. SOAP Message Body.
    ns2:TakeSampleResponse [1...1]
[-]		 - Required. TakeSample response message.
      TLResponse [0...1]
[-]		 - Required. TraceLink response.
        Success [0...1]
[-]		 - Required. Indicates if the request successfully processed. *99
        ExceptionReturn [0...1]
[-]		 - Conditionally required if Success = false. Populated with error information only if Success = false, otherwise omitted.
          CallException [1...*]
[-]		 - Required. Contains error details.
            ExceptionCode [0...1]
[0/*]		 String Required. Error code for exception.
            ExceptionMessage [0...1]
[0/*]		 String Conditionally required if further description of the error condition is available. Message that further describes the error condition, if available.

Example

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:TakeSampleResponse xmlns:ns2="urn:tracelink:soap" xmlns:ns3="http://tracelink.com/som">
         <TLResponse>
            <Success>true</Success>
         </TLResponse>
      </ns2:TakeSampleResponse>
   </S:Body>
</S:Envelope>