Take Sample 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. 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. *1
					@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. *2
				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. *3
				LocationType		[0...1] [1/*]	String	The type of the Location identifier. 4 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. *5
				TakeSampleReasonCode		[0...1] [1/*]	String	Conditionally required if cmn:InspectionCountryCode = `RU`. Reason code identifying why serial number is being sampled. See the TakeSampleReasonCode enumeration list for valid values.
				InspectionCountryCode		[0...1] [1/*]	String	Conditionally required to generate the Russia 552 - Withdrawl report. 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] [-]		Conditionally required if cmn:InspectionCountryCode = `RU`. 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.