APERAK ROAD Application Error and Acknowledgement Message

Transcription

1 APERAK ROAD Application Error and Acknowledgement Message Introduction: The function of this message is: a) to inform a message issuer that his message has been received by the addressee's application and has been rejected due to errors encountered during its processing in the application. b) to acknowledge to a message issuer the receipt of his message by the addressee's application. Notes: Page Pos. Seg. Base User Group Notes and No. No. ID Name Guide Status Max.Use Repeat Comments UNH Message Header M M BGM Beginning of Message M M DTM Date/Time message creation C R Segment Group 1: RFF C R RFF Reference previous message - ACW M M Segment Group 1: RFF-DTM C Used RFF Reference - Timeslot - AEL M M DTM Date/Time/Period - Timeslot arrival - 64 C Used DTM Date/Time/Period - Timeslot departure - 63 C Used Segment Group 2: NAD C R NAD Name and Address - Sender - MS M M Segment Group 2: NAD C R NAD Name and Address - Recipient - MR M M Segment Group 3: ERC-FTX-SG4 C Used ERC Application Error Information M M FTX Free Text - Additional information - ACB C Used Segment Group 4: RFF C Used RFF Reference - Equipment details - EQD M M UNT Message Trailer M M 1 M (D.96B) 1 October 18, 2013

2 LEVEL UNH M 1 BGM M 1 DTM C 1 1C 1 RFF M 1 1C 1 RFF M 1 DTM C 1 DTM C 1 2C 1 NAD M 1 2C 1 NAD M 1 3C 999 ERC M 1 FTX C 1 4C 1 RFF M 1 M (D.96B) 2 October 18, 2013

3 LEVEL UNT M 1 M (D.96B) 3 October 18, 2013

4 Segment: UNH Message Header Position: 0010 Group: Level: 0 Usage: Mandatory Purpose: A service segment starting and uniquely identifying a message. The message type code for the Application error and acknowledgement message is APERAK. Note: Application error and acknowledgement messages conforming to this document must contain the following data in segment UNH, composite S009: Data element 0065 APERAK 0052 D B 0051 UN 0062 MESSAGE REFERENCE NUMBER M an..14 M Unique message reference assigned by the sender. Number will be automatically generated by the terminal system. S009 MESSAGE IDENTIFIER M M Identification of the type, version etc. of the message being interchanged Message type identifier M an..6 M Code identifying a type of message and assigned by its controlling agency. APERAK Application error and acknowledgement message 0052 Message type version number M an..3 M Version number of a message type. D Draft version 0054 Message type release number M an..3 M Release number within the current message type version number (0052). 96B Release B 0051 Controlling agency M an..2 M Code identifying the agency controlling the specification, maintenance and publication of the message type. UN UN/ECE/TRADE/WP Association assigned code C an..6 R Code, assigned by the association responsible for the design and maintenance of the message type concerned, which further identifies the message. INT10 Intis version COMMON ACCESS REFERENCE C an..35 X S010 STATUS OF THE TRANSFER C X Statement that the message is one in a sequence of transfers relating to the same topic Sequence message transfer number M n..2 X Number assigned by the sender indicating that the message is an addition or change of a previously sent message relating to the same topic First/last sequence message transfer indication C a1 X Indication used for the first and last message in a sequence of the same type of message relating to the same topic. M (D.96B) 4 October 18, 2013

5 Segment: BGM Beginning of Message Position: 0020 Group: Level: 0 Usage: Mandatory Purpose: A segment to indicate the type and function of the message and to transmit the identifying number. C002 DOCUMENT/MESSAGE NAME C R Identification of a type of document/message by code or name. Code preferred Document/message name, coded C an..3 R Document/message identifier expressed in code. APE 1131 Code list qualifier C an..3 X 3055 Code list responsible agency, coded C an..3 X 1000 Document/message name C an..35 X C106 DOCUMENT/MESSAGE IDENTIFICATION C R Identification of a document/message by its number and eventually its version or revision Document/message number C an..35 R Reference number assigned to the document/message by the issuer Version C an..9 X 1060 Revision number C an..6 X 1225 MESSAGE FUNCTION, CODED C an..3 R Code indicating the function of the message. 9 Original 4343 RESPONSE TYPE, CODED C an..3 R Code specifying the type of acknowledgment required or transmitted. Message Acceptance Code AP Accepted RE Rejected M (D.96B) 5 October 18, 2013

6 Segment: DTM Date/Time message creation Position: 0030 Group: Level: 0 Usage: Conditional (Required) Purpose: A segment to specify related date/time. C507 DATE/TIME/PERIOD M M Date and/or time, or period relevant to the specified date/time/period type Date/time/period qualifier M an..3 M Code giving specific meaning to a date, time or period. 137 Document/message date/time 2380 Date/time/period C an..35 R an..12 The value of a date, a date and time, a time or of a period in a specified representation. Message creation date/time Remarks: According format as specified in next element Date/time/period format qualifier C an..3 R Specification of the representation of a date, a date and time or of a period. 203 CCYYMMDDHHMM M (D.96B) 6 October 18, 2013

7 Group: RFF Segment Group 1: Reference previous message - ACW Position: 0060 Group: Level: 1 Usage: Conditional (Required) Purpose: A group of segments to specify the document/message to which the current message relates, and related date and time. Segment Summary Pos. Seg. Req. Max. Group: No. ID Name Des. Use Repeat M 0070 RFF Reference previous message - ACW M 1 M (D.96B) 7 October 18, 2013

8 Segment: RFF Reference previous message - ACW Position: 0070 (Trigger Segment) Group: Segment Group 1 (Reference previous message - ACW) Conditional (Required) Level: 1 Usage: Mandatory Purpose: A segment to indicate the reference number of the document/message. C506 REFERENCE M M Identification of a reference Reference qualifier M an..3 M Code giving specific meaning to a reference segment or a reference number. ACW Reference number to previous message 1154 Reference number C an..35 R Identification number the nature and function of which can be qualified by an entry in data element 1153 Reference qualifier. Message reference of previous message This referencenumber will refer to the latest successfully processed Pre-Arrival Notice which has been accepted by the Terminal-Depot Line number C an..6 X 4000 Reference version number C an..35 X M (D.96B) 8 October 18, 2013

9 Group: RFF Segment Group 1: Reference - Timeslot - AEL Position: 0160 Group: Level: 1 Usage: Conditional (Optional) Purpose: A group of segments to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error; further details can be added to identify the error more precisely. Segment Summary Pos. Seg. Req. Max. Group: M No. ID Name Des. Use Repeat 0170 RFF Reference - Timeslot - AEL M 1 Used 0175 DTM Date/Time/Period - Timeslot arrival - 64 C 1 Used 0178 DTM Date/Time/Period - Timeslot departure - 63 C 1 M (D.96B) 9 October 18, 2013

10 Segment: RFF Reference - Timeslot - AEL Position: 0170 (Trigger Segment) Group: Segment Group 1 (Reference - Timeslot - AEL) Conditional (Optional) Level: 1 Usage: Mandatory Purpose: A segment to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error, in this case container. C506 REFERENCE M M Identification of a reference Reference qualifier M an..3 M Determines the kind of reference being given AEL Delivery number (transport) 1154 Reference number C an..35 R Container prefix and number of container where container error status has occurred Timeslot reference number Line number C an..6 X 4000 Reference version number C an..35 X M (D.96B) 10 October 18, 2013

11 Segment: DTM Date/Time/Period - Timeslot arrival - 64 Position: 0175 Group: Segment Group 1 (Reference - Timeslot - AEL) Conditional (Optional) Level: 2 Usage: Conditional (Optional) Purpose: To specify date, and/or time, or period. C507 DATE/TIME/PERIOD M M Date and/or time, or period relevant to the specified date/time/period type Date/time/period qualifier M an..3 M Code giving specific meaning to a date, time or period. 64 Delivery date/time, earliest 2380 Date/time/period C an..35 R an..12 The value of a date, a date and time, a time or of a period in a specified representation. Date/time when the timeslot interval at the terminal starts Date/time/period format qualifier C an..3 R Specification of the representation of a date, a date and time or of a period. 203 CCYYMMDDHHMM M (D.96B) 11 October 18, 2013

12 Segment: DTM Date/Time/Period - Timeslot departure - 63 Position: 0178 Group: Segment Group 1 (Reference - Timeslot - AEL) Conditional (Optional) Level: 2 Usage: Conditional (Optional) Purpose: To specify date, and/or time, or period. C507 DATE/TIME/PERIOD M M Date and/or time, or period relevant to the specified date/time/period type Date/time/period qualifier M an..3 M Code giving specific meaning to a date, time or period. 63 Delivery date/time, latest 2380 Date/time/period C an..35 R an..12 The value of a date, a date and time, a time or of a period in a specified representation. Date/time when the timeslot interval at the terminal ends Date/time/period format qualifier C an..3 R Specification of the representation of a date, a date and time or of a period. 203 CCYYMMDDHHMM M (D.96B) 12 October 18, 2013

13 Group: NAD Segment Group 2: Name and Address - Sender - MS Position: 0090 Group: Level: 1 Usage: Conditional (Required) Purpose: A group of segments to specify the identifications of message sender and message receiver with their contacts and communication channels. Segment Summary Pos. Seg. Req. Max. Group: No. ID Name Des. Use Repeat M 0100 NAD Name and Address - Sender - MS M 1 M (D.96B) 13 October 18, 2013

14 Segment: NAD Name and Address - Sender - MS Position: 0100 (Trigger Segment) Group: Segment Group 2 (Name and Address - Sender - MS) Conditional (Required) Level: 1 Usage: Mandatory Purpose: A segment to specify the identification of the message issuer and message receiver PARTY QUALIFIER M an..3 M Code giving specific meaning to a party. MS Document/message issuer/sender C082 PARTY IDENTIFICATION DETAILS C R Identification of a transaction party by code Party id. identification M an..35 M Code identifying a party involved in a transaction. Message Sender Id 1131 Remarks: EAN Number Code list qualifier C an..3 X 3055 Code list responsible agency, coded C an..3 X C058 NAME AND ADDRESS C X Unstructured name and address: one to five lines Name and address line M an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description. C080 PARTY NAME C X Identification of a transaction party by name, one to five lines. Party name may be formatted Party name M an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name format, coded C an..3 X M (D.96B) 14 October 18, 2013

15 Specification of the representation of a party name. C059 STREET C X Street address and/or PO Box number in a structured address: one to three lines Street and number/p.o. box M an..35 X Street and number in plain language, or Post Office Box No Street and number/p.o. box C an..35 X Street and number in plain language, or Post Office Box No Street and number/p.o. box C an..35 X Street and number in plain language, or Post Office Box No Street and number/p.o. box C an..35 X Street and number in plain language, or Post Office Box No CITY NAME C an..35 X 3229 COUNTRY SUB-ENTITY IDENTIFICATION C an..9 X 3251 POSTCODE IDENTIFICATION C an..9 X 3207 COUNTRY, CODED C an..3 X M (D.96B) 15 October 18, 2013

16 Group: NAD Segment Group 2: Name and Address - Recipient - MR Position: 0090 Group: Level: 1 Usage: Conditional (Required) Purpose: A group of segments to specify the identifications of message sender and message receiver with their contacts and communication channels. Segment Summary Pos. Seg. Req. Max. Group: No. ID Name Des. Use Repeat M 0100 NAD Name and Address - Recipient - MR M 1 M (D.96B) 16 October 18, 2013

17 Segment: NAD Name and Address - Recipient - MR Position: 0100 (Trigger Segment) Group: Segment Group 2 (Name and Address - Recipient - MR) Conditional (Required) Level: 1 Usage: Mandatory Purpose: A segment to specify the identification of the message issuer and message receiver PARTY QUALIFIER M an..3 M Code giving specific meaning to a party. MR Message recipient C082 PARTY IDENTIFICATION DETAILS C R Identification of a transaction party by code Party id. identification M an..35 M Code identifying a party involved in a transaction. Message Recipient Id 1131 Remarks: EAN Number Code list qualifier C an..3 X 3055 Code list responsible agency, coded C an..3 X C058 NAME AND ADDRESS C X Unstructured name and address: one to five lines Name and address line M an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description Name and address line C an..35 X Free form name and address description. C080 PARTY NAME C X Identification of a transaction party by name, one to five lines. Party name may be formatted Party name M an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name C an..35 X Name of a party involved in a transaction Party name format, coded C an..3 X M (D.96B) 17 October 18, 2013

18 Specification of the representation of a party name. C059 STREET C X Street address and/or PO Box number in a structured address: one to three lines Street and number/p.o. box M an..35 X Street and number in plain language, or Post Office Box No Street and number/p.o. box C an..35 X Street and number in plain language, or Post Office Box No Street and number/p.o. box C an..35 X Street and number in plain language, or Post Office Box No Street and number/p.o. box C an..35 X Street and number in plain language, or Post Office Box No CITY NAME C an..35 X 3229 COUNTRY SUB-ENTITY IDENTIFICATION C an..9 X 3251 POSTCODE IDENTIFICATION C an..9 X 3207 COUNTRY, CODED C an..3 X M (D.96B) 18 October 18, 2013

19 Group: ERC Segment Group 3: Application Error Information Position: 0130 Group: Level: 1 Usage: Conditional (Optional) Max Use: 999 Purpose: A group of segments to identify the application error(s) within a specified received message and to give specific details related to the error type or to precise the type of acknowledgement. Segment Summary Pos. Seg. Req. Max. Group: No. ID Name Des. Use Repeat M 0140 ERC Application Error Information M 1 Used 0150 FTX Free Text - Additional information - ACB C Segment Group 4: Reference - Equipment details - C 1 EQD M (D.96B) 19 October 18, 2013

20 Segment: ERC Application Error Information Position: 0140 (Trigger Segment) Group: Segment Group 3 (Application Error Information) Conditional (Optional) Level: 1 Usage: Mandatory Purpose: A segment identifying the type of application error or acknowledgement within the referenced message. In case of an error, the error code may specify the error in detail (e.g. a measurement relating to a piece of equipment is wrong) or as a rough indication (e.g. a measurement is wrong). C901 APPLICATION ERROR DETAIL M M Code assigned by the recipient of a message to indicate a data validation error condition Application error identification M an..8 M The code assigned by the receiver of a message to the identification of a data validation error condition. If BGM,4343 = 'AP' Container Status Code See codelist as mentioned below for used codes. If BGM,4343 = 'RE' Message Rejection Code Codes are transmitted as received from the terminal. BCO Before Cargo Opening [terminal] BCO-OK Not before Cargo Opening [terminal] BLO Blocked [terminal] BLO-OK Not blocked [terminal] CDM Customs documents missing [terminal] CDM-OK Customs documents available [terminal] COA Container not available [terminal] COA-OK Container available [terminal] COR Container not released by carrier [terminal] COR-OK Container released by carrier [terminal] ORN Booking number unknown [terminal] ORN-OK Booking accepted [terminal] QQQ Conditionally accepted [terminal] 1131 Code list qualifier C an..3 X 3055 Code list responsible agency, coded C an..3 X M (D.96B) 20 October 18, 2013

21 Segment: FTX Free Text - Additional information - ACB Position: 0150 Group: Segment Group 3 (Application Error Information) Conditional (Optional) Level: 2 Usage: Conditional (Optional) Purpose: A segment to provide explanation and/or supplementary information related to the specified application error or acknowledgement. For example, the explanation may provide exact details relating to a generic error code TEXT SUBJECT QUALIFIER M an..3 M Code specifying subject of a free text. ACB Additional information 4453 TEXT FUNCTION, CODED C an..3 X C107 TEXT REFERENCE C X Coded reference to a standard text and its source Free text identification M an..17 X Free text in coded form Code list qualifier C an..3 X Identification of a code list Code list responsible agency, coded C an..3 X Code identifying the agency responsible for a code list. C108 TEXT LITERAL C O Free text; one to five lines Free text M an..70 M Free text field available to the message sender for information. Additional state information provided by the terminal Free text C an..70 X 4440 Free text C an..70 X 4440 Free text C an..70 X 4440 Free text C an..70 X 3453 LANGUAGE, CODED C an..3 X M (D.96B) 21 October 18, 2013

22 Group: RFF Segment Group 4: Reference - Equipment details - EQD Position: 0160 Group: Segment Group 3 (Application Error Information) Conditional (Optional) Level: 2 Usage: Conditional (Optional) Purpose: A group of segments to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error; further details can be added to identify the error more precisely. Segment Summary Pos. Seg. Req. Max. Group: No. ID Name Des. Use Repeat M 0170 RFF Reference - Equipment details - EQD M 1 M (D.96B) 22 October 18, 2013

23 Segment: RFF Reference - Equipment details - EQD Position: 0170 (Trigger Segment) Group: Segment Group 4 (Reference - Equipment details - EQD) Conditional (Optional) Level: 2 Usage: Mandatory Purpose: A segment to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error, in this case container. C506 REFERENCE M M Identification of a reference Reference qualifier M an..3 M Determines the kind of reference being given EQD Equipment Details 1154 Reference number C an..35 R Container prefix and number of container where container error status has occurred Containerprefix and number 1156 Line number C an..6 X 4000 Reference version number C an..35 X M (D.96B) 23 October 18, 2013

24 Segment: UNT Message Trailer Position: 0190 Group: Level: 0 Usage: Mandatory Purpose: A service segment ending a message, giving the total number of segments in the message (including UNH & UNT) and the control reference number of the message NUMBER OF SEGMENTS IN A MESSAGE M n..6 M Control count of number of segments in a message MESSAGE REFERENCE NUMBER M an..14 M Unique message reference assigned by the sender. M (D.96B) 24 October 18, 2013