Message Acknowledgement

Implementation Guide
XML

Proprietary Notice

The information disclosed in this document is the property of CargoSmart Limited.

© CargoSmart Proprietary Page 1 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

Document Information
Document Name: Message Acknowledgment Implementation Guideline (XML Format)
Owned By: CargoSmart Limited Document Version 3.0
5/F, Lakeside 2, No.10 Science Park West Avenue No:
Hong Kong Science Park
Shatin, New Territories, Hong Kong
Prepared By: CargoSmart Professional Services Document Version 25 Feb 2009
Date:
Preparation Date: 21 Feb 2006

Version History
Ver. No. Ver. Date Revised By Description
- Section 2.3.1 correct the type for MessageID, FileName and Version
- Section 2.3.1 update the maxlength of DateCreated/[TimeZone] from 10 to 30
CargoSmart
- Section 2.4.1 update the minlength of ReferenceNumber from 1 to 0
3.0 25 Feb 2009 Professional - Section 2.4.2 update the minlength of Description from 1 to 0
Services - Synchronize XSD and sample XML with IG Specification
- Sec 3.4 Update sample XML
CargoSmart
2.1 29 Oct 2008 Professional - Section 2.4.1 extend ReferenceNumber from 1/30 to 1/35
Services
CargoSmart
2.0 23 Oct 2008 Professional - Section 2.4.3(ADD) – Add element AckParties
Services
CargoSmart
1.1 6 Mar 2006 Professional Minor revisions to data elements
Services
CargoSmart
1.0 21 Feb 2006 Professional Initial creation
Services

© CargoSmart Proprietary Page 2 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

Table Of Contents.

1. XML Schema/Structure ............................................................................................................. 4

2. XML Schema/Structure Details .................................................................................................. 4
2.1 Ack_Root....................................................................................................................................... 4
2.2 Ack_Message ................................................................................................................................ 4
2.3 GeneralInfo .................................................................................................................................... 4
2.4 AckDetails ..................................................................................................................................... 6
Appendix ....................................................................................................................................... 8
3.1 Error Codes .................................................................................................................................... 8
3.2 Schema Views ............................................................................................................................. 11
3.3 Sample XML ............................................................................................................................... 21

© CargoSmart Proprietary Page 3 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

1. XML Schema/Structure
See Appendix B for the schema view.

Notes:
1. Interpreting Diagrams – Dotted lines represent optional data elements while solid lines represent
mandatory/required data elements.
2. fieldName/[child] is read as elementName/[attribute of the said elementName].
3. Min and Max refers to minimum and maximum lengths of the field it describes. N/A if the element
does not have a value or a parent element.
4. Type describes what kind of data a certain element holds (e.g AN for Alpha Numeric). N/A if the
element does have a value or a parent element.
5. Req describes if the element is optional (O) or mandatory (M).
6. Refer to Note/s of each section if any for any other additional information.

2. XML Schema/Structure Details

2.1 Ack_Root
- Acts as a root node.
DATA ELEMENTS:
Type Min/ Req Description
Name Max
Ack_Message N/A N/A M See Section 2.2.

DATA ATTRIBUTES:
N/A

2.2 Ack_Message
- Element representing information of each transaction.
DATA ELEMENTS:
Type Min/ Req Description
Name Max
GeneralInfo N/A N/A M See Section 2.3.
AckDetails N/A N/A N/A See Section 2.4

DATA ATTRIBUTES:
N/A

2.3 GeneralInfo
- As the name implies, describes the general information regarding the transaction including the
file/transaction itself.

DATA ELEMENTS:
Type Min/ Req Description
Name Max
TransactionInfo N/A N/A M See Section 2.3.1.
AN 1/11 M Reference number assigned by
CSReferenceNumber CargoSmart.
DataSource AN 0/1 O Indicates the source of data.
TransactionNumber AN 1/14 M Unique reference/control number of
© CargoSmart Proprietary Page 4 of 21
Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

Type Min/ Req Description

Name Max
the message being acknowledged.
AN 1/5 M Status of the message being
MessageStatus acknowledged.
AN 0/10 O Message id/type of the message
MessageType being acknowledged.

DATA ATTRIBUTES:
N/A

Note/s:
MessageStatus should only be:

Code Description
1 Received
A Accepted
E Accepted with errors/warnings noted
W Rejected. Failed validation process
R Rejected. Failed conversion process.

DataSource should only be:

Data Source Description

0 EDI
1 Excel Upload
2 CS Online

MessageType should only be:

Message Type Message
SIXML Shipping Instructions in XML format
BRXML Booking Request in XML format
BCXML Booking Confirmation in XML format
BLXML Bill of Lading Details in XML format
SSXML Sailing schedule in XML format
CTXML Cargo Tracking in XML format
X12 standard
e.g. 310, 301, 300, 315, 323, 304
message
UN EDIFACT e.g. IFTMCS, IFTSTA, IFTMIN, IFTSAI,
standard message IFTMBF

2.3.1 TransactionInfo
- Gives the description of the file itself for identification.

DATA ELEMENTS:
Type Min/ Req Description
Name Max
N 1/14 M System generated running number,
until 99999999999999 and will reset
back to 1.
BatchNumber Serves as a unique control number.
AN 1/15 M Trading partner ID for incoming,
MessageSender “CARGOSMART” for outgoing
© CargoSmart Proprietary Page 5 of 21
Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

Type Min/ Req Description

Name Max
AN 1/15 M Trading partner ID for outgoing,
MessageRecipient “CARGOSMART” for incoming
MessageID AN 1/10 M Type of message. Default to AKXML
N 0/14 O Date the file was created.
DateCreated Format: ccyyMMddHHmmss
FileName AN 0/60 O File name
Version AN 0/5 O schema version used

DATA ATTRIBUTES:
Type Min/ Req Description
Name Max
AN 0/30 O Time Zone where the date it
DateCreated/[TimeZone] describes happened.

Note/s:
1. TimeZone can be set to LOCAL which refers to the local time zone where the file was
processed or the event happened.

2.4 AckDetails
- Shows the detailed description of the error encountered if any, including the external
references of the message being acknowledged.

DATA ELEMENTS:
Type Min/ Req Description
Name Max
ExternalReferences N/A N/A O See section 2.4.1.
Notes N/A N/A C See section 2.4.2.
AckParties N/A N/A O See section 2.4.3

DATA ATTRIBUTES:
N/A

2.4.1 ExternalReferences/References
- Describes the external references attached to the messaged being acknowledged.

DATA ELEMENTS:
Type Min/ Req Description
Name Max
AN 0/5 C Describes the type of Reference
Number used to qualify/identify the
ReferenceType reference number
AN 0/60 C Free-form description (reference
name) of the reference data element.
Required if Reference Type is ZZ or
ReferenceName blank.
ReferenceNumber AN 0/35 C Reference numbers attached to a
© CargoSmart Proprietary Page 6 of 21
Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

Type Min/ Req Description

Name Max
particular shipment. These numbers
were used to identify the shipment as
compared to other shipments
submitted to the carrier.

DATA ATTRIBUTES:
N/A

Note/s:

Accepted ReferenceType and Reference Name are shown below.

Reference Reference Name

Type
SI Shipper’s Identifying Number For Shipment (SID)
CSI Customer’s SI Number
IV Invoice Number
PO Purchase Order
SO Shipping Order Number
FW Forwarder’s Reference
SRN Shipper’s Reference Number
FCN First Carrier B/L Number
BN Booking Number
BM Bill of Lading Number
ZZ Others

2.4.2 Notes/Error
- Describes the error encountered when processing the message being acknowledged.

DATA ELEMENTS:
Type Min/ Req Description
Name Max
AN 1/5 M Error Code encountered when
processing the message. See
Appendix 3.1 for the code and
Code description.
Description AN 0/60 O Description of the error encountered

DATA ATTRIBUTES:
N/A

Note/s:

Notes/Error is required if MessageStatus are E, W, or R.

© CargoSmart Proprietary Page 7 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

2.4.3 AckParties/Party
- Describes the related parties, who acknowledged the message, and who request the
acknowledgement.

DATA ELEMENTS:
Type Min/ Req Description
Name Max
N/A 1/35 M Fill with SCAC code if the party role is
PartyID Carrier.
PartyName N/A 0/35 O

DATA ATTRIBUTES:
Type Min/ Req Description
Name Max
AN 1/15 M Used to indentify the party role,
Party/[Role] carrier or requestor

Note/s:

Accepted value for Party/[Role].

Role
Carrier
Requestor

Appendix
3.1 Error Codes
External
Description
Code
89 THERE IS NO CONTAINER OR BOOKING ASSOCIATED WITH THE CARGO
88 TOTAL CARGO GROSS WEIGHT EXCEEDED THE CONTAINER GROSS WEIGHT
87 REQUESTED ON-BOARD DATE IS INVALID
86 CARGO DESCRIPTION MUST NOT CONTAIN NON-STANDARD KEYBOARD AND/OR CONTROL CHARACTERS
85 GIVEN CARRIER NOT SUPPORTED
84 REQUESTED ACTION NOT SUPPORTED
83 CARGO MARKS & NUMBERS MUST NOT CONSTAIN NON-STANDARD KEYBOARD AND/OR CONTROL CHARACTERS
82 UNSUPPORTED PARTY TYPE
81 MISSING LENGTH OR WIDTH OR HEIGHT
80 INCORRECT HEIGHT
79 INCORRECT LENGTH
78 UNSUPPORTED MEASUREMENT UNIT
77 MISSING MEASUREMENT UNIT
76 INCORRECT WIDTH
75 B/L CARGO SUMMARY DESCRIPTION CONSTAINS NON-STANDARD KEYBOARD AND/OR CONTROL CHARACTERS
74 INVALID DRAFT INDICATOR
73 UNSUPPORTED PAYMENT OPTION
72 REQUESTED DRAFT TRANSMISSION IS NOT SUPPORTED
71 UNSUPPORTED CARGO TYPE

© CargoSmart Proprietary Page 8 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

External
Description
Code
70 NET WEIGHT IS NOT VALID
69 UNSUPPORTED NET WEIGHT UNIT
68 VOLUME IS NOT VALID
67 UNSUPPORTED VOLUME WEIGHT UNIT
66 UNSUPPORTED CERTIFICATION/CLAUSE CODE
65 CERTIFICATION/CLAUSE TEXT CONSTAINS NON-STANDARD KEYBOARD AND/OR CONTROL CHARACTERS
64 EMAIL HAS TO BE IN THE FORMAT OF xxx@xxxxxxx.xxxxx
63 UNSUPPORTED PAYABLE BY TYPE
62 GROSS WEIGHT IS NOT VALID
61 UNSUPPORTED GROSS WEIGHT UNIT
60 UNSUPPORTED CONTAINER REQUEST TYPE
59 UNRECOGNIZED STATUS INDICATOR
58 UNSUPPORTED HAZARDOUS CLASSIFICATION CODE
57 INVALID DG PACKAGING GROUP CODE
56 INVALID DOCUMENT TYPE CODE
55 FAX AREA CODE CAN ONLY CONTAIN NUMERIC CHARACTERS (0-9)
54 FAX COUNTRY CODE CAN ONLY CONTAIN NUMERIC CHARACTERS (0-9)
53 FAX NUMBER CAN ONLY CONTAIN NUMERIC CHARACTERS (0-9)
52 INVALID FREIGHT TYPE
51 NUMBER OF COPIES REQUESTED EXCEEDED THE LIMIT
50 REQUESTED TRANSMISSION MODE FOR THE REQUESTED DOCUMENT TYPE IS NOT SUPPORTED
49 PHONE AREA CODE CAN ONLY CONTAIN NUMERIC CHARACTERS (0-9)
48 PHONE COUNTRY CODE CAN ONLY CONTAIN NUMERIC CHARACTERS (0-9)
47 PHONE NUMBER CAN ONLY CONTAIN NUMERIC CHARACTERS (0-9)
46 UNSUPPORTED SCHEDULE TYPE CODE
45 INVALID TEMPERATURE
44 UNSUPPORTED TEMPERATURE UNIT
43 UNSUPPORTED VENT SETTING CODE
42 UNRECOGNIZED EXT. VESSEL CODE TYPE
41 UNRECOGNIZED LOCATION FUNCTION CODE
40 SI REMARKS CONSTAINS NON-STANDARD KEYBOARD AND/OR CONTROL CHARACTERS
39 SPECIAL B/L HANDLING INSTRUCTIONS CONSTAINS NON-STANDARD KEYBOARD AND/OR CONTROL CHARACTERS
38 THE CONTAINER INFORMATION IS DIFFERENT FROM THE CONTAINER INFORMATION IN THE BOOKING(S).
37 THE PARTY INFORMATION <PartyType> IS DIFFERENT FROM THE PARTY INFORMATION IN BOOKING(S).
36 NON-EXISTING BOOKING NUMBER
35 UNSUPPORTED PACKAGE TYPE
34 NON-ISO CONTAINER SIZE/TYPE
33 CONTAINER IS NOT ASSOCIATED WITH A BOOKING
32 OTHER INFORMATION REQUIRED FOR TRANSMISSION MODE "OT"
31 UNSUPPORTED CARRIER RATE REFERENCE TYPE
30 INVALID CARRIER'S CUSTOMER ID
29 INVALID CARGOSMART CUSTOMER ID
28 NON-EXISTING SCHEDULE K/D CODE
27 MISSING SCHEDULE K/D CODE
26 MISSING SCHEDULE TYPE CODE
25 NON-EXISTING UN/LOCATION CODE
24 REFERENCE NAME REQUIRED FOR REFERENCE TYPE "OTH"

© CargoSmart Proprietary Page 9 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

External
Description
Code
23 UNSUPPORTED REFERENCE TYPE
22 THE TRAFFIC MODE IS DIFFERENT FROM THE TRAFFIC MODE IN BOOKING(S).
21 UNSUPPORTED SEAL TYPE
20 SEAL TYPE NAME REQUIRED FOR SEAL TYPE "OT"

© CargoSmart Proprietary Page 10 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 3.2 Schema Views

Elements Complex types

Ack_Root DateTime
Party

element Ack_Root
diagram

children Ack_Message

element Ack_Root/Ack_Message
diagram

children GeneralInfo AckDetails

element Ack_Root/Ack_Message/GeneralInfo
diagram

children TransactionInfo CSReferenceNumber DataSource TransactionNumber MessageStatus MessageType

© CargoSmart Proprietary Page 11 of 21
Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo
diagram

children BatchNumber MessageSender MessageRecipient MessageID DateCreated FileName Version

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/BatchNumber
diagram

type restriction of xs:long

© CargoSmart Proprietary Page 12 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/MessageSender
Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/MessageSender
diagram

type restriction of xs:string

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/MessageRecipient
diagram

type restriction of xs:string

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/MessageI
Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/MessageIDD
diagram

type restriction of xs:string

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/DateCreated
diagram

type restriction of DateTime

attributes Name Type Use Default Fixed Annotation

TimeZone derived by: optional
xs:string

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/Fil
Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/FileName
eName
diagram

type restriction of xs:string

© CargoSmart Proprietary Page 13 of 21
Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/Version
diagram

type restriction of xs:string

element Ack_Root/Ack_Message/GeneralInfo/CSReferenceNumber
diagram

type restriction of xs:string

xs:string

element Ack_Root/Ack_Message/GeneralInfo/DataSource
diagram

type restriction of xs:string

facets enumeration 0
enumeration 1
enumeration 2

element Ack_Root/Ack_Message/GeneralInfo/TransactionNumber
diagram

type restriction of xs:string

xs:string

element Ack_Root/Ack_Message/GeneralInfo/MessageStatus
diagram

type restriction of xs:string

facets enumeration 1
enumeration A
© CargoSmart Proprietary Page 14 of 21
Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

enumeration E
enumeration W
enumeration R

element Ack_Root/Ack_Message/GeneralInfo/MessageType
diagram

type restriction of xs:string

facets enumeration SIXML

enumeration BRXML
enumeration BCXML
enumeration BLXML
enumeration CTXML
enumeration SSXML
enumeration 310
enumeration 301
enumeration 300
enumeration 315
enumeration 323
enumeration 304
enumeration IFTMCS
enumeration IFTSTA
enumeration IFTMIN
enumeration IFTSAI
enumeration IFTMBF

element Ack_Root/Ack_Message/AckDetails
diagram

children ExternalReferences Notes AckParties

element Ack_Root/Ack_Message/AckDetails/ExternalReferences
Ack_Root/Ack_Message/AckDetails/ExternalReferences
diagram

children References

© CargoSmart Proprietary Page 15 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Ack_Root/Ack_Message/AckDetails/ExternalReferences/References
diagram

children ReferenceType ReferenceName ReferenceNumber

element Ack_Root/Ack_Message/AckDetails/ExternalReferences/References/ReferenceType
diagram

type restriction of xs:string

facets enumeration SI
enumeration CSI
enumeration IV
enumeration PO
enumeration SO
enumeration FW
enumeration SRN
enumeration FCN
enumeration BN
enumeration BM
enumeration ZZ

element Ack_Root/Ack_Message/AckDetails/ExternalReferences/References/ReferenceName
diagram

type restriction of xs:string

© CargoSmart Proprietary Page 16 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Ack_Root/Ack_Message/AckDetails/ExternalReferences/References/ReferenceNumber
diagram

type restriction of xs:string

element Ack_Root/Ack_Message/AckDetails/Notes
diagram

children Error

element Ack_Root/Ack_Message/AckDetails/Notes/Error
diagram

children Code Description

element Ack_Root/Ack_Message/AckDetails/Notes/Error/Code
diagram

type restriction of xs:string

element Ack_Root/Ack_Message/AckDetails/Notes/Error/Description
diagram

type restriction of xs:string

xs:string

© CargoSmart Proprietary Page 17 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Ack_Root/Ack_Message/AckDetails/AckParties
diagram

children Party

element Ack_Root/Ack_Message/AckDetails/AckParties/Party
diagram

type Party

children PartyID PartyName

attributes Name Type Use Default Fixed Annotation

Role derived by: required
xs:string

complexType DateTime
diagram

type extension of xs:string

used by element Ack_Root/Ack_Message/GeneralInfo/TransactionInfo/DateCreated

attributes Name Type Use Default Fixed Annotation

TimeZone derived by: optional
xs:string

© CargoSmart Proprietary Page 18 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

attribute DateTime/@TimeZone
type restriction of xs:string

complexType Party
diagram

children PartyID PartyName

used by element Ack_Root/Ack_Message/AckDetails/AckParties/Party

attributes Name Type Use Default Fixed Annotation

Role derived by: required
xs:string

attribute Party/@Role
type restriction of xs:string

facets enumeration Carrier

enumeration Requestor

element Party/PartyID
diagram

type restriction of xs:string

© CargoSmart Proprietary Page 19 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 Message Acknowledgment Implementation Guideline
(XML Format)

element Party/PartyName
Party/PartyName
diagram

type restriction of xs:string

© CargoSmart Proprietary Page 20 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML
 3.3 Sample XML
<?xml version="1.0" encoding="UTF-8"?>
<Ack_Root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="CS-SYSINT-
STD-IG-AK.xsd">
<Ack_Message>
<GeneralInfo>
<TransactionInfo>
<BatchNumber>1</BatchNumber>
<MessageSender>CARGOSMART</MessageSender>
<MessageRecipient>RECIPIENT</MessageRecipient>
<MessageID>AKXML</MessageID>
<DateCreated TimeZone="HKT">20060222024700</DateCreated>
<FileName>sample_ack.xml</FileName>
<Version>1.1</Version>
</TransactionInfo>
<CSReferenceNumber>CSREFNUM</CSReferenceNumber>
<DataSource>0</DataSource>
<TransactionNumber>1</TransactionNumber>
<MessageStatus>W</MessageStatus>
<MessageType>SIXML</MessageType>
</GeneralInfo>
<AckDetails>
<ExternalReferences>
<References>
<ReferenceType>BN</ReferenceType>
<ReferenceName>Booking Number</ReferenceName>
<ReferenceNumber>SZHG24048</ReferenceNumber>
</References>
</ExternalReferences>
<Notes>
<Error>
<Code>89</Code>
<Description>THERE IS NO CONTAINER OR BOOKING ASSOCIATED WITH THE CARGO</Description>
</Error>
</Notes>
</AckDetails>
</Ack_Message>
</Ack_Root>

© CargoSmart Proprietary Page 21 of 21

Last saved: 23 Apr 2009 CS-SYSINT-STD-IG-AK.XML