OpenLegislation

Appendix 3 ERINOT response and receipt message (APERAK) — ERIRSP

United Kingdom

Original text. Later amendments are not shown.

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:

  1. (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;

  2. (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)

BGM
  • Beginning of message

  • COM
  • Communication contact

  • DTM
  • Date/time/period

  • ERC
  • Application error information

  • FTX
  • Free text

  • NAD
  • Name and address

  • RFF
  • Reference

  • UNH
  • Message header

  • UNT
  • Message trailer

  • 2.2.

    Segment table

    PosTagNameSR
    UNBM1
    0010UNHMessage headerM1
    0020BGMBeginning of messageM1
    0030DTMDate/time/periodM1
    0060Segment group 1C2
    0070RFFReferenceM1
    0090Segment group 2C1
    0100NADName and addressM1
    0120COMCommunication contactC3
    0130Segment group 3D[1]9
    0140ERCApplication error informationM1
    0150FTXFree textM1
    0190UNTMessage trailerM1
    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 GroupSegmentComposite data element (C)Data elementTAGLevelStatusFormatNameDescriptionQualifiers in quotation marks
    1234567
    UNB 0 M INTERCHANGE HEADER
    S001MSYNTAX IDENTIFIER
    0001Ma4Syntax identifier‘UNOA’ Controlling agency
    0002Mn1Syntax version number‘2’
    S002MINTERCHANGE SENDER
    0004M

    an..35

    (an25)

    Sender identificationMailbox number or unique name or the unique identifier of a RIS-centre or traffic post
    0007an..4Partner identification code qualifiern.a.
    0008an..14Address for reverse routingn.a.
    S003MINTERCHANGE RECIPIENT
    0010M

    an..35

    (an25)

    Recipient identificationMailbox number or unique name or the unique identifier of a RIS-centre or traffic post
    0007an..4Partner identification code qualifiern.a.
    0014an..14Routing addressn.a.
    S004MDATE/TIME OF PREPARATION
    0017Mn6DateGeneration date, YYMMDD
    0019Mn4TimeGeneration time, HHMM
    0020Man..14Interchange control referenceFirst 14 positions of the message reference number
    S005RECIPIENTS REFERENCE, PASSWORD
    0022an..14Recipient’s reference/passwordn.a.
    0025an2Recipient’s reference, password qualifiern.a.
    0026an..14Application referencen.a.
    0029a1Processing priority coden.a.
    0031n1Acknowledgement requestn.a.
    0032an..35Communications agreement idn.a.
    0035Cn1Test indicator‘1’ = the interchange relates to a test message
    UNH 0 M MESSAGE HEADER Identification, specification and heading of a message
    0062Man..14Message reference numberFirst 14 positions of the message reference number
    S009MMESSAGE IDENTIFIER
    0065Man..6Message type‘APERAK’, message type
    0052Man..3Message version number‘D’
    0054Man..3Message release number‘98B’
    0051Man..2Controlling agency‘UN’
    0057Man..6Association assigned code‘ERI13’, ERI Version 1.3
    0068an..35Common access referencen.a.
    S010STATUS OF THE TRANSFER
    0070n..2Sequence of transfersn.a.
    0073a1First and last transfern.a.
    BGM 0 M BEGINNING OF MESSAGE Identification of the type and function of the message
    C002MDOCUMENT/MESSAGE NAME
    1001Man..3Document/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

    1131an..3Code list qualifiern.a.
    3055an..3Code list responsible agencyn.a.
    1000an..35Document/message namen.a.
    C106MDOCUMENT/MESSAGE IDENTIFICATION
    1004M

    an..35

    (an15)

    Document identifierMessage 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.
    1056an..9Versionn.a.
    1060an..6Revision numbern.a.
    1225Man..3Message function codeFunction of message: ‘9’ = new message (original)
    4343Man..3Response 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
    C507MDATE/TIME/PERIOD
    2005Man..3Date or time or period function code qualifier‘137’ for document/message date/time
    2380Man..35Date or time period valueValue of arrival time: YYMMDDHHMM
    2379Man..3Date or time or period format code‘201’ for YYMMDDHHMM
    GRP 1 RFF (1) 1 C REFERENCE Reference to previous message
    C506MREFERENCE
    1153Man..3Reference qualifier‘ACW’ for reference number to previous message
    1154Man..35Reference numberMessage reference number from BGM, TAG 1004 of the message this message refers to
    1156an..6Line numbern.a.
    4000an..35Reference version numbern.a.
    1060an..6Revision numbern.a.
    GRP 1 RFF (2) 1 C REFERENCE Reference to transaction/invoice number
    C506MREFERENCE
    1153Man..3Reference qualifier‘AAY’ for reference number to transaction
    1154Man..35Reference numberReference 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.
    1156an..6Line numbern.a.
    4000an..35Reference version numbern.a.
    1060an..6Revision numbern.a.
    GRP 2 NAD 1 M NAME and ADDRESS Name and address of the sender of the notification
    3035Man..3Party function code qualifier‘MS’ for message sender
    C082PARTY IDENTIFICATION DETAILSn.a.
    3039an..35Party identificationn.a.
    1131an..3Code list qualifiern.a.
    3055an..3Code list responsible agencyn.a.
    C058NAME AND ADDRESSn.a.
    3124an..35Name and address linen.a.
    3124an..35Name and address linen.a.
    3124an..35Name and address linen.a.
    3124an..35Name and address linen.a.
    3124an..35Name and address linen.a.
    C080MPARTY NAME
    3036Man..35Party nameName of the sender of the notification
    3036an..35Party namen.a.
    3036an..35Party namen.a.
    3036an..35Party namen.a.
    3036an..35Party namen.a.
    3045an..3Party name format, codedn.a.
    C059CSTREET
    3042Man..35Street and number/PO boxStreet and number or post office box
    3042an..35Street and number/PO boxn.a.
    3042an..35Street and number/PO boxn.a.
    3042an..35Street and number/PO boxn.a.
    3164Can..35City nameCity
    3229an..9Country sub-entity identificationn.a.
    3251Can..9Postcode identificationPostal identification code
    3207Can..3CountryISO 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)
    C076MCOMMUNICATION CONTACT
    3148Man..70Communication numberCommunication number
    3155Man..3Communication channel qualifier

    ‘TE’ for telephone number

    ‘FX’ for fax number

    ‘EM’ for Email address

    GRP 3 ERC 1 C APPLICATION ERROR INFORMATION
    C901MAPPLICATION ERROR DETAIL
    9321Man..8Application errorApplication error code
    1131an..3Code list qualifiern.a.
    3055an..3Code list responsible agencyn.a.
    ERC FTX 2 M FREE TEXT To communicate the reason for rejection
    4451Man..3Text subject code qualifier‘AAO’ for free text error description
    4453an..3Free text function coden.a.
    C107TEXT REFERENCE
    4441an..17Free text identificationn.a.
    1131an..3Code list qualifiern.a.
    3055an..3Code list responsible agencyn.a.
    C108CTEXT LITERALText
    4440Man..70Free textFurther description
    4440Can..70Free textFurther description
    4440Can..70Free textFurther description
    4440Can..70Free textFurther description
    4440Can..70Free textFurther description
    3453an..3Language, codedn.a.
    4447an..3Text formatting, codedn.a.
    UNT M MESSAGE TRAILER End and control of completeness of the message
    0074Mn..6Number of segments in a message
    0062Man..14Message reference numberFirst 14 positions of the message reference number
    UNZ M INTERCHANGE TRAILER End and control of the interchange
    0036Mn..6Interchange control count‘1’ for number of messages contained in the interchange
    0020Man..14Interchange control referenceFirst 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.