Fetch Serial Number Hierarchy Result Response 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.
If the response contains less than 100,000 serial numbers, use the Get Serialized Hierarchy request.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. |
|||||||||
| ns3:FetchSerialNumberHierarchyResultResponse | 1...1 – |
– |
Required. Get Serialized Hierarchy response message with hierarchical data. |
|||||||||
| SerialNumberHierarchyResponse | 0...1 – |
– |
Required. Response. |
|||||||||
| Success | 0...1 – |
– |
Indicates whether Get Serialized Hierarchy request message had success in processing. |
|||||||||
| ExceptionReturn | 0...1 – |
– |
Conditionally required if Success = |
|||||||||
| CallException | 1...* – |
– |
Required. Contains any available exception information. |
|||||||||
| ExceptionCode | 0...1 0/* |
String |
Required. The error exception code. |
|||||||||
| ExceptionMessage | 0...1 0/* |
String |
Conditionally required if exception message exists. Message that further describes the error. |
|||||||||
| SerialNumberHierarchyList | 1...1 – |
– |
Required. Contains the successful response to the request. |
|||||||||
| SerialNumberHierarchies | 0...1 – |
– |
Required. Contains a list of one or more SerialNumberHierarchy elements in response to the request. Each SerialNumberHierarchy element contains one hierarchy. |
|||||||||
| SerialNumberHierarchy | 1...* – |
– |
Required. Each SerialNumberHierarchy element contains one hierarchy. If there are loose items returned, they are returned in this element with no ChildSerialNumbers populated. |
|||||||||
| SerialNumber | 1...1 – |
– |
Required. Parent Container Serial Number or a loose item. |
|||||||||
| @sn | 1...1 1/* |
String |
Required. Serial Number that was queried. |
|||||||||
| @namespace | 0...1 1/* |
String |
Serial Number format. For more information see Serial Number Data Examples. See the Encoding enumeration list for valid values. |
|||||||||
| @isUpdated | 1...1 1/* |
Boolean | Required. Records whether the serial number is updated, which TraceLink uses for system processing. | |||||||||
| PackagingCode | 0...1 – |
String |
Required. Packaging level item code and type associated with the serial number. |
|||||||||
| ItemCodeType | 0...1 1/* |
String |
Required. Identifies the packaging level item code type of the serial number. See the ItemCodeType enumeration list for valid values. |
|||||||||
| ItemCode | 0...1 1/* |
String |
Required. Packaging level item code value (e.g. GTIN-14, CN-ResCode, or GS1 Company Prefix value). |
|||||||||
| CountryDrugCodeType | 0...1 1/* |
String |
Conditionally required if CountryDrugCode is populated. Country Drug Code type and value or InternalMaterialNumber are specified if neither delivery number nor packaging code information was specified in initial call. See the CountryDrugCode enumeration list for valid values. |
|||||||||
| CountryDrugCode | 0...1 1/* |
String |
Country Drug Code associated with the serial number at time of commissioning. |
|||||||||
| InternalMaterialNumber | 0...1 1/* |
String |
Internal Material Number associated with the serial number at time of commissioning. |
|||||||||
| LotNumber | 0...1 1/* |
String |
Lot Number associated with the serial number at time of commissioning. |
|||||||||
| ExpirationDate | 0...1 10/10 |
Date |
Expiration date in xsd:date format (YYYY-MM-DD) associated with serial number at time of commissioning. |
|||||||||
| PackagingLevel | 0...1 1/* |
String |
Packaging level associated with queried serial number. |
|||||||||
| SerialNumberState | 0...1 1/* |
String |
Required. Serialization state of the queried serial number. See the SNState enumeration list for valid values. |
|||||||||
| ItemState | 0...1 1/* |
String |
Required. Business process state of the physical item associated with the serial number. See the ItemState enumeration list for valid values. |
|||||||||
| ChildSerialNumbers | 0...* – |
– |
List of child serial numbers associated with container serial number or lot number. |
|||||||||
| ChildSerialNumber | 1...1 – |
– | – | |||||||||
| SerialNumber | 1...1 – |
– |
Required. Child serial number affixed to the queried container/lot. Only the direct descendant (child) for a given parent is reported. If that child itself also has children, it will be recognized as another top-level element. Each-level serials are not reported if they are part of a hierarchy as top-level elements. |
|||||||||
| @sn | 1...1 1/* |
String |
Required. Child serial number that is affixed to the queried container/lot. |
|||||||||
| @namespace | 0...1 1/* |
String |
Not supported by TraceLink. |
|||||||||
| @isUpdated | 1...1 1/* |
Boolean | Required. Records whether the serial number is updated, which TraceLink uses for system processing. | |||||||||
| PackagingCode | 0...1 – |
String |
Conditionally required if CountryDrugCode and InternalMaterialNumber are not provided and delivery number was not used. |
|||||||||
| ItemCodeType | 0...1 1/* |
String |
Required. Identifies the packaging-level item code type of the serial number. See the ItemCodeType enumeration list for valid values. |
|||||||||
| ItemCode | 0...1 1/* |
String |
Packaging level item code value (e.g. GTIN-14, CN-ResCode, or GS1 Company Prefix value). |
|||||||||
| CountryDrugCodeType | 0...1 1/* |
String |
Conditionally required if CountryDrugCode is populated. Country drug code type and value of the internal material number will be specified if neither the delivery number nor packaging code information was specified. See the CountryDrugCode enumeration list for valid values. |
|||||||||
| CountryDrugCode | 0...1 1/* |
String |
Conditionally required with InternalMaterialNumber if PackagingCode is not populated and delivery number was not used. Country Drug Code associated with the child serial number. |
|||||||||
| InternalMaterialNumber | 0...1 1/* |
String |
Conditionally required with CountryDrugCode if PackagingCode is not populated and delivery number was not used. Internal Material Number associated with the serial number at time of commissioning. |
|||||||||
| LotNumber | 0...1 1/* |
String |
Lot Number associated with the child serial number. |
|||||||||
| ExpirationDate | 0...1 10/10 |
Date |
Not supported by TraceLink. |
|||||||||
| PackagingLevel | 0...1 1/* |
String |
Packaging-level associated with child serial number. See the PackLevel enumeration list for valid values. |
|||||||||
| SerialNumberState | 0...1 1/* |
String |
Required. Serialization state of the child serial number. See the SNState enumeration list for valid values. |
|||||||||
| ItemState | 0...1 1/* |
String |
Required. Business process state of the physical item associated with the child serial number. See the ItemState enumeration list for valid values. |
|||||||||
| RequestId | 0...1 1/* |
String |
Returned if TraceLink is still processing the original Get Serialized Entity message. |
|||||||||
