M146 Containerstatus melding Road planning (xml-out) Version: Author: A.Fischer / P.Kloosterman (last edited)

Transcription

1 M146 Containerstatus melding Road planning (xml-out) Version: Author: A.Fischer / P.Kloosterman (last edited) Page 1 of 8

2 Goal This document describes the structure and contents of the XML Status-out message. This message is sent by the PCS to the road haulier after an APERAK has been received from terminal/depot and was successfully processed by the PCS. Glossary of terms - Response messages - Page 2 of 8

3 Message definition Global - The maximum allowed file size of an interchange is 4 MB. - Empty tags will be left away. Message header (Standard Business Document) Definitions of the header tags can be found in the table beneath. Remark: the number of pipeline characters ( ) before each tag indicates the level (Lv) of the tag in the message header. Header prolog: <?XML version="1.0" encoding="utf-8"?> Lv Header tag Occurrence Description Remarks <StandardBusinessDocument> 1x (M) The name of the XML tag required to wrap the SBDH and the SBD. <StandardBusinessDocument Header> 1x (M) The name of the XML tag that contains the tags and contents of the SBDH. When the separate MIME part packaging approach is used this tag becomes the root of the generated XML Instance Document. <HeaderVersion> 1x (M) Descriptor which contains versioning information or number of the standard that is used in the SBDH only. This version information is not the same as the version information of the document. Header version: 2.2 <Sender> 1x (M) Logical party representing the organization that has created the standard business document. III <Identifier> Descriptor with information to identify this party Identifier: NLRTM <Identifier Authority="[party name]"> 1x (M) Identifier: NLRTMPCS Descriptor with information to identify the sending party. Authority (tag attribute): Portbase <ContactInformation> 0-1x (O) Information about the contact for this document <Contact> 0-1x (O) Contact for business < Address> 0-1x (O) address of the contact <FaxNumber> 0-1x (O) Fax number of the contact <TelephoneNumber> 0-1x (O) Telephone number of the contact <ContactTypeIdentifier> 0-1x (O) Role of the contact in this business process Page 3 of 8

4 Lv Header tag Occurrence Description Remarks Identifier: Servicedesk <Receiver> 1x (M) Logical party representing the organization that has created the standard business document. <Identifier Authority="[party name]"> 1x (M) Authority (tag attribute): Portbase Descriptor with information to identify the receiving party. The identifying PCS short name of the party, char(25). This short name will be defined at configuration of the party in the PCS. In case the reason of rejection was an invalid message sender identifier (error code 143), then the original value of the identifier must be returned here. <DocumentIdentification> 1x (M) Characteristics containing identification about the document. <Standard> 1x (M) The originator of the type of the Business Data standard. Standard: <TypeVersion> 1x (M) Descriptor which contains versioning information or number of the standard that defines the document which is specified in the Type data element. Type version: 1.0 <InstanceIdentifier> 1x (M) Descriptor which contains reference information which uniquely identifies this instance of the SBD between the sender and the receiver. This identifier identifies this document as distinct from others. There is only one SBD instance per Standard Header. <Type> 1x (M) A logical indicator representing the type of Business Data being sent or the named type of business data. This attribute identifies the type of document and not the instance of that document. The instance document or interchange can contain one or more business documents of a single document type or closely related types. The industry standard body (as referenced in the Standard element) is responsible for defining the Type value to be used in this field (e.g. Order ). To be assigned to message by the message sender, (char(35)) Page 4 of 8

5 Lv Header tag Occurrence Description Remarks Type: ROAD Container status <CreationDateAndTime> 1x (M) Descriptor which contains date and time of SBDH/document creation. To be set by message sender (PCS). Type xs:datetime <BusinessScope> 1x (O) The business scope of the SBD. Not used. <Scope> 1x (M) Indicates the type of scope, the identifiers for the scope, other supporting information and the scope content itself. The importance of the Scope is that it allows the SBDH to operate under auspices of an agreement <Type> 1x (M) Indicates the kind of scope Type: production test <InstanceIdentifier> 1x (M) A unique descriptor that identifies the "contract" or "agreement" that this instance relates to. To be assigned to message by the message sender (PCS), (char(35)). Page 5 of 8

6 Message body (Document Content) The message body contains the following tags: Lv Body tag Occurrence Description Remarks <documentcontent totalnumberofcontentbodies= [#]> 1x (M) Start of the actual content of the document. The tag attribute contains the number of contentbodies sent in the documentcontent. <contentheader> 1x (M) Start of the header information for the body. <contenttype> 1x (M) Identification of the content type. Content type: Status <contentversion> 1x (M) Descriptor which contains versioning information or number of the document. Content version: 1.0 <contentstandard> 1x (M) Reference to the XSD describing the document structure. Content standard:./rha_acknowledgement.xsd Number of content bodies is always 1 <contentreference> 1x (M) Reference uniquely identifying the document. <contentaction> 1x (M) Function of the documentcontent. Message function: Original <previouscontentreference> 1x (O) Reference to the previous related document contentreference <contentbody> 1x (M) Start of the document. III <Acknowledgement> 1x (M) Beginning of the acknowledgment <messageacceptancecode> 1x (M) The type of acknowledgment, coded. To be assigned to message by message sender (PCS). Not used Acceptance codes: Code specifying the type of acknowledgement. Values: AP if status = ACC, CAC, CAN (after processing APERAK-in) RE if status = REJ, URJ, CRJ (after processing APERAK-in) IIII <messagecreationdatetime> 1x (M) Date/time of creation of the APERAKout message, generated by the PCS. Format: CCYY-MM-DDTHH:MM:SS Page 6 of 8

7 Lv Body tag Occurrence Description Remarks IIII <messagereferenceofpreviou 1x (M) smessage> Message reference of the XML upload or COPINO-in message this acknowledgement relates to. This is the latest successfully processed Pre- Arrival Notice which has been accepted by the Terminal. IIII <messagesenderid> 1x (M) EAN number of the terminal/operator that has acknowledged the pre-arrival notice. IIII <messagerecipientid> 1x (M) EAN number of the road haulier that is the receiver of the acknowledgement IIII <timeslotreference> 0-1x (O) Timeslot reference number as provided by the terminal. IIII <offeredarrivaldatetime> 0-1x (O) Date/time the offered timeslot at the terminal starts. Format: CCYY-MM-DDTHH:MM:SS IIII <offereddeparturedatetime> 0-1x (O) Date/time the offered timeslot at the terminal ends. Format: CCYY-MM-DDTHH:MM:SS IIII <messagestatus messagestatuscode= messagestatuscode messagestatusdescription= "messagestatusdescription additionalstatusremarks= additinalstatusremarks/> 0-999x (O) Message status details. Page 7 of 8

8 Lv Body tag Occurrence Description Remarks Occurrences: Occurs x per acknowledgement (for an acceptance acknowledgement the maximum of message statuses will be 5) Used status codes en related descriptions for messagefunction AP : messagestatuscode messagestatusdescription BLO Blocked BLO-OK Not blocked BCO Before cargo opening BCO-OK Not before cargo opening CDM Customs documents missing CDM-OK Customs documents available COA Container not available COA-OK Container available COR Container not released by carrier COR-OK Container released by carrier ORN Booking number unknown ORN-OK Booking accepted QQQ Conditionally accepted Used status codes en related descriptions for messagefunction RE BCO Prearrival notice offered too early. ORA ORN DUP RUB20 RUB168 RUB44 RUB51 RUB59 RUB76 OTH CTV Andere codes This prearrival notice is already in process. The booking is not yet sent by the carrier or an incorrect delivery reference has been added to this prearrival notice. A prearrival notice is already present for this container. The enclosed bookingnumber has been found for a different carrier in the terminalsystem.. Temperature information is not correct or temperature information has been added vor a non-reefer container. The carrier has ordered a different container type for this booking/container at the terminal. The full/empty information of this prearrival notice is not equal to the information known at the terminal. The container number of this prearrival notice is not a valid container number of does not comply to the container number which is already known at the terminal for this boeking. The dangerous goods class (IMDG) is not valid. Other Cancelled from Terminal Visit The received error code [foutcode] is unknown within Road planning. IIII <containerprefixandnumber> 0-1x (O) Prefix+number of the container. III </Acknowledgment> End of acknowledgement. Page 8 of 8