Appendix 3 ERINOT response and receipt message (APERAK) — ERIRSP
United Kingdom
1.
APERAK GENERAL RESPONSE AND RECEIPT MESSAGE
This message shall be used to provide where required answering and response functions to sent messages.
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.
1.1.
Field of application
The application error and acknowledgement message can be used for both national and international applications. It is not dependent on the type of business or industry, neither it is a legal requirement: it is based on business practices related to administration and transport.
1.2.
Principles
A message can first be controlled at system level (e.g. the CONTRL message) to detect syntax errors and to acknowledge its receipt. It shall be then transmitted to the application process to be processed.
When an acknowledgement is necessary an APERAK message shall be sent specifying the reasons of acknowledgement. If an error is detected at the application level, which prevents its complete processing, an APERAK message shall be sent to the original message issuer providing details of the error(s) encountered. In case of application error, the APERAK message shall be transmitted manually.
In case of acknowledgement the APERAK message shall be processed automatically or manually, at recipient’s discretion.
2.
ERI RESPONSE MESSAGE ERIRSP
The ERIRSP message is derived from the UN/EDIFACT APERAK message. The response messages to the functions (new, modification or cancellation) of the notification message ERINOT have all the same structure. The response to a ‘modification’ or a ‘cancellation’ contains information whether or not the ‘modification’ or ‘cancellation’ has been processed by the receiving system. A response is required only if the NAD (1)/COM segment, with qualifier ‘EI’, contains the mailbox number, or with qualifier ‘EM’, contains the email address where the response is to be returned to.
2.1
Segment index (alphabetical sequence by tag)
Beginning of message
Communication contact
Date/time/period
Application error information
Free text
Name and address
Reference
Message header
Message trailer
2.2.
Segment table
| Pos | Tag | Name | S | R |
|---|---|---|---|---|
| UNB | M | 1 | ||
| 0010 | UNH | Message header | M | 1 |
| 0020 | BGM | Beginning of message | M | 1 |
| 0030 | DTM | Date/time/period | M | 1 |
| 0060 | Segment group 1 | C | 2 | |
| 0070 | RFF | Reference | M | 1 |
| 0090 | Segment group 2 | C | 1 | |
| 0100 | NAD | Name and address | M | 1 |
| 0120 | COM | Communication contact | C | 3 |
| 0130 | Segment group 3 | D[1] | 9 | |
| 0140 | ERC | Application error information | M | 1 |
| 0150 | FTX | Free text | M | 1 |
| 0190 | UNT | Message trailer | M | 1 |
| Business rules | |
|---|---|
| D[1] | This segment-group is to be used if any application error(s) occur. |
2.3
Branching Diagram
2.4
ERIRSP message structure
Table 2 defines the segments of the ERI response messages.
Table 2: ERI response message ERIRSP
| Segment Group | SegmentComposite data element (C)Data elementTAG | Level | Status | Format | Name | DescriptionQualifiers in quotation marks |
|---|---|---|---|---|---|---|
| 1 | 2 | 3 | 4 | 5 | 6 | 7 |
| UNB | 0 | M | INTERCHANGE HEADER | |||
| S001 | M | SYNTAX IDENTIFIER | ||||
| 0001 | M | a4 | Syntax identifier | ‘UNOA’ Controlling agency | ||
| 0002 | M | n1 | Syntax version number | ‘2’ | ||
| S002 | M | INTERCHANGE SENDER | ||||
| 0004 | M | an..35 (an25) | Sender identification | Mailbox number or unique name or the unique identifier of a RIS-centre or traffic post | ||
| 0007 | an..4 | Partner identification code qualifier | n.a. | |||
| 0008 | an..14 | Address for reverse routing | n.a. | |||
| S003 | M | INTERCHANGE RECIPIENT | ||||
| 0010 | M | an..35 (an25) | Recipient identification | Mailbox number or unique name or the unique identifier of a RIS-centre or traffic post | ||
| 0007 | an..4 | Partner identification code qualifier | n.a. | |||
| 0014 | an..14 | Routing address | n.a. | |||
| S004 | M | DATE/TIME OF PREPARATION | ||||
| 0017 | M | n6 | Date | Generation date, YYMMDD | ||
| 0019 | M | n4 | Time | Generation time, HHMM | ||
| 0020 | M | an..14 | Interchange control reference | First 14 positions of the message reference number | ||
| S005 | RECIPIENTS REFERENCE, PASSWORD | |||||
| 0022 | an..14 | Recipient’s reference/password | n.a. | |||
| 0025 | an2 | Recipient’s reference, password qualifier | n.a. | |||
| 0026 | an..14 | Application reference | n.a. | |||
| 0029 | a1 | Processing priority code | n.a. | |||
| 0031 | n1 | Acknowledgement request | n.a. | |||
| 0032 | an..35 | Communications agreement id | n.a. | |||
| 0035 | C | n1 | Test indicator | ‘1’ = the interchange relates to a test message | ||
| UNH | 0 | M | MESSAGE HEADER | Identification, specification and heading of a message | ||
| 0062 | M | an..14 | Message reference number | First 14 positions of the message reference number | ||
| S009 | M | MESSAGE IDENTIFIER | ||||
| 0065 | M | an..6 | Message type | ‘APERAK’, message type | ||
| 0052 | M | an..3 | Message version number | ‘D’ | ||
| 0054 | M | an..3 | Message release number | ‘98B’ | ||
| 0051 | M | an..2 | Controlling agency | ‘UN’ | ||
| 0057 | M | an..6 | Association assigned code | ‘ERI13’, ERI Version 1.3 | ||
| 0068 | an..35 | Common access reference | n.a. | |||
| S010 | STATUS OF THE TRANSFER | |||||
| 0070 | n..2 | Sequence of transfers | n.a. | |||
| 0073 | a1 | First and last transfer | n.a. | |||
| BGM | 0 | M | BEGINNING OF MESSAGE | Identification of the type and function of the message | ||
| C002 | M | DOCUMENT/MESSAGE NAME | ||||
| 1001 | M | an..3 | Document/message name code | Type of message received for which this message contains the acknowledgement information: ‘VES’, from vessel to RIS authority message ‘CAR’, from carrier to RIS authority message ‘PAS’, passage report from RIS authority to RIS authority | ||
| 1131 | an..3 | Code list qualifier | n.a. | |||
| 3055 | an..3 | Code list responsible agency | n.a. | |||
| 1000 | an..35 | Document/message name | n.a. | |||
| C106 | M | DOCUMENT/MESSAGE IDENTIFICATION | ||||
| 1004 | M | an..35 (an15) | Document identifier | Message reference number. This number shall be as unique as possible, both for sender and for receiver. If a message is received and then passed on to another receiver, the original message reference number shall be used. The transitional system shall in this case not generate another message reference number. | ||
| 1056 | an..9 | Version | n.a. | |||
| 1060 | an..6 | Revision number | n.a. | |||
| 1225 | M | an..3 | Message function code | Function of message: ‘9’ = new message (original) | ||
| 4343 | M | an..3 | Response type code | ‘AP’ accepted ‘RE’ rejected. The notification is rejected if the transport is already arrived at its destination. | ||
| DTM | 1 | M | DATE/TIME/PERIOD | The date/time that the receiving application encounters the approval or rejection | ||
| C507 | M | DATE/TIME/PERIOD | ||||
| 2005 | M | an..3 | Date or time or period function code qualifier | ‘137’ for document/message date/time | ||
| 2380 | M | an..35 | Date or time period value | Value of arrival time: YYMMDDHHMM | ||
| 2379 | M | an..3 | Date or time or period format code | ‘201’ for YYMMDDHHMM | ||
| GRP 1 | RFF (1) | 1 | C | REFERENCE | Reference to previous message | |
| C506 | M | REFERENCE | ||||
| 1153 | M | an..3 | Reference qualifier | ‘ACW’ for reference number to previous message | ||
| 1154 | M | an..35 | Reference number | Message reference number from BGM, TAG 1004 of the message this message refers to | ||
| 1156 | an..6 | Line number | n.a. | |||
| 4000 | an..35 | Reference version number | n.a. | |||
| 1060 | an..6 | Revision number | n.a. | |||
| GRP 1 | RFF (2) | 1 | C | REFERENCE | Reference to transaction/invoice number | |
| C506 | M | REFERENCE | ||||
| 1153 | M | an..3 | Reference qualifier | ‘AAY’ for reference number to transaction | ||
| 1154 | M | an..35 | Reference number | Reference number assigned by the receiving authority. The reference number shall start with the UN country code followed by three positions for the assigning system. The final part is the actual reference number. | ||
| 1156 | an..6 | Line number | n.a. | |||
| 4000 | an..35 | Reference version number | n.a. | |||
| 1060 | an..6 | Revision number | n.a. | |||
| GRP 2 | NAD | 1 | M | NAME and ADDRESS | Name and address of the sender of the notification | |
| 3035 | M | an..3 | Party function code qualifier | ‘MS’ for message sender | ||
| C082 | PARTY IDENTIFICATION DETAILS | n.a. | ||||
| 3039 | an..35 | Party identification | n.a. | |||
| 1131 | an..3 | Code list qualifier | n.a. | |||
| 3055 | an..3 | Code list responsible agency | n.a. | |||
| C058 | NAME AND ADDRESS | n.a. | ||||
| 3124 | an..35 | Name and address line | n.a. | |||
| 3124 | an..35 | Name and address line | n.a. | |||
| 3124 | an..35 | Name and address line | n.a. | |||
| 3124 | an..35 | Name and address line | n.a. | |||
| 3124 | an..35 | Name and address line | n.a. | |||
| C080 | M | PARTY NAME | ||||
| 3036 | M | an..35 | Party name | Name of the sender of the notification | ||
| 3036 | an..35 | Party name | n.a. | |||
| 3036 | an..35 | Party name | n.a. | |||
| 3036 | an..35 | Party name | n.a. | |||
| 3036 | an..35 | Party name | n.a. | |||
| 3045 | an..3 | Party name format, coded | n.a. | |||
| C059 | C | STREET | ||||
| 3042 | M | an..35 | Street and number/PO box | Street and number or post office box | ||
| 3042 | an..35 | Street and number/PO box | n.a. | |||
| 3042 | an..35 | Street and number/PO box | n.a. | |||
| 3042 | an..35 | Street and number/PO box | n.a. | |||
| 3164 | C | an..35 | City name | City | ||
| 3229 | an..9 | Country sub-entity identification | n.a. | |||
| 3251 | C | an..9 | Postcode identification | Postal identification code | ||
| 3207 | C | an..3 | Country | ISO 3166-1 two alpha country code, see Annex, Chapter 2.3.8 | ||
| NAD | COM | 2 | C | COMMUNICATION CONTACT | Sender communication contact details (maximum 3 times) | |
| C076 | M | COMMUNICATION CONTACT | ||||
| 3148 | M | an..70 | Communication number | Communication number | ||
| 3155 | M | an..3 | Communication channel qualifier | ‘TE’ for telephone number ‘FX’ for fax number ‘EM’ for Email address | ||
| GRP 3 | ERC | 1 | C | APPLICATION ERROR INFORMATION | ||
| C901 | M | APPLICATION ERROR DETAIL | ||||
| 9321 | M | an..8 | Application error | Application error code | ||
| 1131 | an..3 | Code list qualifier | n.a. | |||
| 3055 | an..3 | Code list responsible agency | n.a. | |||
| ERC | FTX | 2 | M | FREE TEXT | To communicate the reason for rejection | |
| 4451 | M | an..3 | Text subject code qualifier | ‘AAO’ for free text error description | ||
| 4453 | an..3 | Free text function code | n.a. | |||
| C107 | TEXT REFERENCE | |||||
| 4441 | an..17 | Free text identification | n.a. | |||
| 1131 | an..3 | Code list qualifier | n.a. | |||
| 3055 | an..3 | Code list responsible agency | n.a. | |||
| C108 | C | TEXT LITERAL | Text | |||
| 4440 | M | an..70 | Free text | Further description | ||
| 4440 | C | an..70 | Free text | Further description | ||
| 4440 | C | an..70 | Free text | Further description | ||
| 4440 | C | an..70 | Free text | Further description | ||
| 4440 | C | an..70 | Free text | Further description | ||
| 3453 | an..3 | Language, coded | n.a. | |||
| 4447 | an..3 | Text formatting, coded | n.a. | |||
| UNT | M | MESSAGE TRAILER | End and control of completeness of the message | |||
| 0074 | M | n..6 | Number of segments in a message | |||
| 0062 | M | an..14 | Message reference number | First 14 positions of the message reference number | ||
| UNZ | M | INTERCHANGE TRAILER | End and control of the interchange | |||
| 0036 | M | n..6 | Interchange control count | ‘1’ for number of messages contained in the interchange | ||
| 0020 | M | an..14 | Interchange control reference | First 14 positions of the message reference number |
3.
ERROR CODES
For data attribute: MESSAGE REFERENCE ANSWERED TO ERROR DESCR CODE, the error codes available electronically in the European Reference Data Management System (ERDMS) operated by the European Commission shall be used in in segment ERC, data element 9321.