Take Product Sample Guidelines (XML)

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

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	Conditionally required if cmn:InspectionCountryCode = "RU". 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	Conditionally required if cmn:InspectionCountryCode = "RU". 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.