Contents
1. How to use this guide. ............................................................................................................... 4
1.11.1 Confidentiality ..................................................................................................................... 4
1.2 Purpose of this guide ....................................................................................................... 4
1.3 What’s new and what’s changed ................................................................................... 4
1.4 User Guide name and version number ....................................................................... 4
2. About OneStop ............................................................................................................................ 5
2.1 Who is OneStop? ................................................................................................................ 5
2.2 What does OneStop provide? ......................................................................................... 5
2.3 Why use OneStop Products and Solutions?................................................................. 5
3. About Rail Tagging and Release ........................................................................................... 6
3.1 What is Rail Tagging and Release? ............................................................................... 6
3.1.1 Options for use ........................................................................................................... 6
3.2 Who uses Rail Tagging and Release? ........................................................................... 7
3.3 Why is Rail Tagging and Release used? ...................................................................... 7
4. Terms of use ............................................................................................................................... 8
5. How Rail Tagging and Release works with your system ................................................ 9
5.1 Message Flow ............................................................................................................ 9
5.2 CTO_RELEASE XML Message Schema ....................................................................... 10
5.2.1 What is a CTO_RELEASE XML for? ....................................................................... 10
5.2.2 CTO_RELEASE XML Message Specification ..................................................... 10
5.2.3 Sample CTO RELEASE – CONTAINER TAG ....................................................... 14
5.2.4 Sample CTO RELEASE – CONTAINER RELEASE .............................................. 16
5.3 CTO_RELEASE_SyntaxValidation XML Message Schema (CONTROL) .............. 18
5.3.1 What is a CTO_RELEASE_SyntaxValidation XML for? .................................... 18
5.3.2 CTO_RELEASE_SyntaxValidation XML Message Specification .................... 19
5.3.3 Sample CTO_RELEASE_SyntaxValidation (CONTROL) - REJECTED20....20
5.3.1Sample CTO_RELEASE_SyntaxValidation (CONTROL) -
ACKNOWLEDGED .................................................................................................................... 21
5.4 CTO_RELEASE_RESPONSE XML Message Schema ............................................. 22
5.4.1 What is the CTO_RELEASE_RESPONSE XML Message Schema for?....... 22
5.4.2 CTO_RELEASE_RESPONSE XML Message Specification ............................ 22
5.4.3 Sample CONT_TAGGING RESPONSE ............................................................... 23
5.4.4 Sample RAIL_RELEASE RESPONSE ................................................................... 24
5.4.5 Sample ACCEPTED Email Response ................................................................. 25
5.4.6 Sample REJECTED Email Response................................................................... 26
6. Getting Started................................................................... ....................................................... 27
6.1 Have you read the Customer User Guide................................................................ 27
7. How to… .................................................................................................................................... 28
7.1 How to log in and access........................................................................................... 28
7.2 How to send the XML message ............................................................................. 28
8. Where to get help ................................................................................................................... 29
9 Glossary .................................................................................................................................... 30
APPENDIX A .................................................................................................................................... 31
APPENDIX B .................................................................................................................................... 32
APPENDIX C .................................................................................................................................... 34
1. HOW TO USE THIS GUIDE
1.1 Confidentiality |
The information contained in this document is for Administrators of OneStop services only. Copyright remains with OneStop. No unauthorised copying or distribution of the document or any part of its contents is permitted.
If you have any questions about the use or distribution of this document, Contact the Helpdesk by raising a support ticket here.
1.2 Purpose of this guide |
This guide is for Administrators of OneStop’s services. It is intended as a:
- training resource when you purchase 1-Stop’s services; and
- reference guide, if you need help to perform specific tasks.
Information about solving problems is included at the end of this document. If you need extra help you can:
- check the FAQs in the ‘Help’ tab on our website at www.1-stop.biz; or
- contact the Helpdesk by raising a support ticket here.
1.3 What's new and what's changed |
The information contained in this guide is current as at May 2011 and reflects all changes to the user interface up to that date. If you think you may not have the most up to date User Guide, check the downloads available at www.1-stop.biz
1.4 User Guide name and version number |
Updates to User Guides are made each time a new version of the service is released.
This is: Rail Tagging and Release-ADM-Technical Guide version 1
2. ABOUT ONESTOP
2.1 Who is OneStop? |
OneStop is an Australian based, world leader in innovative software solutions for the global port community. 2 ABOUT ONESTO
Our suite of integrated capabilities and industry specific products deliver proven results through productivity optimization tools and systems for the supply chain community.
Our customers include shipping lines, port and terminal operators, freight forwarders, customs brokers, 3PLs, trucking companies, rail operators, importers, and exporters.
2.2 What does OneStop provide? |
Our solutions permit the exchange of data via the web or by electronic data interchange (EDI), for purposes such as container and vessel tracking, vehicle bookings to collect and deliver cargo at terminals, Electronic Import Delivery Orders (EIDOs), Pre Receival Advices (PRAs), invoice and payments systems, and much more. For a full list of our solutions, go to OneStop Solutions.
2.3 Why use OneStop Products & Solutions |
Our suite of integrated products and solutions are tailored to the specific needs of industry operators has been developed to maximise operating efficiency and cost management throughout the supply chain.
OneStop customers enjoy:
- efficient and ‘real time’ transactions between community members;
- improved data quality;
- clear, visible data about vessel and container movements;
- easy reporting to Australian Customs Services to meet regulatory requirements;
- time and cost savings, thanks to automation of repetitive transactions;
- better ability to respond to their customers; and
- improved business efficiency, due to the ‘one-to-many’ solution — access one system to do business with many providers.
3. ABOUT RAIL TAGGING AND RLEASE
3.1 What is Rail Tagging and Release? |
The OneStop Rail Tagging and Release (RTR) service allows users to notify terminals they wish to move their container cargo by rail. Users log in to the OneStop website and tag their containers for movement by rail before the container is discharged from the vessel. The tag request is submitted to the terminal. The terminal must approve the tagging request.
All cargo that is not tagged for rail is moved by road.
Before the introduction of the OneStop Rail Tagging and Release service, rail tagging and release was managed manually by each terminal.
3.1.1 Options for use |
OneStop offers users options for using the Rail Tagging and Release service; that is,
either by EDI (EDIFACT or XML) or online via the OneStop website. Please refer to our
website for the EDIFACT Message Specifications.
This guide provides help for the XML Message only.
3.2 Who use Rail Tagging and Release? |
The Rail Tagging and Release service is designed for;
• shipping lines;
• intermodal rail terminals; and
• importers, freight forwarders and agents.
However, use of the service by rail terminal operators, importers, freight forwarders
and agents requires permission from the shipping lines.
Shipping lines require permission from the terminals to allow users to tag with the
OneStop RTR method.
3.3 Who use Rail Tagging and Release? |
Automated rail tagging and release procedures have replaced procedures that were previously carried out by the terminals. Now all industry participants manage the process themselves.
4. TERMS OF USE
All OneStop products have Terms and Conditions of use. If you are a new user of web-based services, you’ll be asked to agree to these when you sign in.
Downloadable copies of some of our Terms and Conditions are available on our website.
5. HOW RAIL TAGGING AND RELEASE WORKS WITH YOUR SYSTEM
5.1 XML Message Flow |
The messaging flow for XML is as follows.
- Client sends the TAG request using CTO_RELEASE XML for container Tagging to OneStop.
- OneStop sends the TAG Control XML Response back to the client (this isoptional).
- OneStop sends the TAG request to the Terminal.
- The terminal sends the TAG Response to OneStop.
- OneStop sends the TAG Response using CTO_RELEASE_RESPONSE XML tothe sender of the TAG.
- Client sends in the RELEASE request to OneStop using the CTO_RELEASEXML for the Container Release.
- OneStop sends the RELEASE Control XML Response back to the client (this is optional).
- OneStop sends the RELEASE request to the Terminal.
- Terminal sends the RELEASE response to OneStop.
- OneStop sends the RELEASE response to the sender.
5.2 CTO_Release XML Message schema |
5.2.1 What is a CTO_RELEASE XML for?
CTO_RELEASE is the XML clients send to TAG or RELEASE a Container. The schema shows clients what the required fields are in order for them to send a TAG or RELEASE request to a Specified terminal.
5.2.3 CTO_Release XML Message Specification
XML Fields |
Mandatory /Optional |
Type | Length | Definition |
CTOReleaseHeader | ||||
MessageName | M | String |
CTO RELEASE - CONTAINER TAGGING CTO RELEASE - CONTAINER RELEASE |
|
MessageFunction | M | String |
ORIGINAL CHANGE CANCELLATION |
|
ResponseTypeCode | O | String |
Acknowledgement ALWAYS
ACCEPTED Rail Release Instructions only
CONDITIONALLY ACCEPTED Rail Release Instructions only
REJECTED Rail Release |
Instructions only | ||||
MessageEventDateTime | M | String | 14 |
The Date/Time when Message is sent to OneStop Gateway OR from OneStop Gateway to the Terminal System. Format - CCYYMMDDHHMMSS |
Sender | ||||
SenderCode | M | String |
ACOS Trading Code or OneStop Registered Code. |
|
SenderRole | M | String |
LINE(Shippint Line) BUREAU CARRIER(Transport Carrier) IMPORTER RAILOP(Rail Operator) CONTRACTOR(CTO Terminal) |
|
SendersPassword | M | String | A valid Password is required for those Parties sending Messages to OneStop Message Gateway | |
SendersMessageReferenc eID | M | String |
Must be Unique - Combination of SenderCode and 6 Digit Number, eg HSD123456 |
|
SendersMessageVersion | M | Integer | Original Message will always have Version 1, Version Number must be incremented (2,3,4,5...) for subsequent Updates or Withdraw | |
SendersEventDateTime | M | String | 14 |
Date/Time the message created in the Sender's System. Format - CCYYMMDDHHMMSS |
Receiver | ||||
ReceiverCode | M | String | Terminal code from where Container is available for Collection (ACOS Code) | |
ReceiverRole | M | String | CONTRACTOR | |
CTOReleaseDepartureDetails | ||||
On-CarriageTransportDetails | ||||
TransportMode | M | String |
RAIL ROAD |
|
TransportID | O | String | Train Number or Truck Number | |
ServiceNumber | O | String | Rail or Road Service Number | |
CarrierCode | M | String | Road or Rail Operator Code | |
CarrierName | M | String | Road or Rail Operator Name | |
Location |
PlaceOfDepartureCode | M | String | Departure Terminal Code | |
PlaceOfDepartureName | M | String | Departure Terminal Code | |
PlaceOfDestinationCode | M | String | Destination Code | |
PlaceOfDestinationName | M | String | Rail or Road Destination Name | |
DepartureDateTime – OPTIONAL | ||||
RequestedDepartureDateT O String 14 Requested Rail or Road Departure ime Date/time - Format - CCYYMMDDHHMMSS |
||||
Requester | ||||
RequesterCode | M | String | Requester Code | |
RequesterRole | M | String |
LINE(Shippint Line) CARRIER(Transport Carrier) IMPORTER RAILOP(Rail Operator) |
|
RequesterName | O | String | Requester Name | |
ContactName | O | String | Contact Name | |
ContactEmail | O | String | Email Address to forward the Rail Release Instructions Responses if required | |
PlaceOfAvailability | ||||
PlaceOfAvailabilityCode | M | String |
Terminal code from where Container is available for Collection (from NAD+SF - ACOS Code) SF – (Ship From) Place where Cargo is available for Collection – in this instance, the Discharge Terminal. |
|
PlaceOfAvailabilityName | O | String |
Terminal Name from where container is available for Collection (from NAD+SF) SF – (Ship From) Place where Cargo is available for Collection – in this instance, the Discharge Terminal. |
|
CTOReleaseCargoLines | ||||
ConsignmentItemNumber | M | Integer | 1, 2, 3, etc... Starting with 1 and increment by 1 | |
ImportDeliveryNumber | O | String |
E-IDO Pin -> CRN Commercial Release Number -> MANDATORY for CONTAINER RELEASE MESSAGE |
|
ImportVesselDetails | ||||
LloydsNumber | M | String | Lloyds Number of the Discharge Vessel. |
Name | O | String | Vessel Name | |
VoyageNumber | M | String | Inbound Voyage Number -> Leading Zeros and Trailing Letters should be removed | |
DischargePort | M | String | Cargo Discharge Port | |
VesselOperatorCode | M | String | Vessel Operator Code | |
VesselOperatorName | M | String | Vessel Operator Name | |
VesselEstimateArrivalDate | O | String | 8 | Format - CCYYMMDD |
VesselActualArrivalDate | O | String | 8 | Format - CCYYMMDD |
ContainerDetails | ||||
ContainerNumber | M | String | 11 | Container Number |
ContainerSize | O | String | ISO Code | |
FullEmpty | O | String | 5 |
FullEmptyStatus=indicates if Container is Full or Empty FULL EMPTY |
GrossWeight | O | String | Gross Weight of the Container in Kilogram | |
DimensionWidth | O | Decimal | Width in Centimetres | |
DimensionHeight | O | Decimal | Height in Centimetres | |
SealNumber | O | String | Seal Number | |
HandlingInstructionsCode | O | String | 3 |
General Cargo or Hazardous Cargo GEN HAZ |
HazardousMaterialClassCo de | O | String | IMDG Code | |
HazardousMaterialClass | O | String | IMDG Class | |
EmptyReturnPark - OPTIONAL | ||||
EmptyReturnParkCode | O | String | 35 | ACOS Code |
EmptyReturnParkLocation | String | 35 | Empty Container Return Park Name and Address | |
EmptyReturnDueDateTime | String | 14 | From SG62 DTM+397 Segment. Format - CCYYMMDDHHMMSS |
5.2.3 Sample CTO Release - Container Tag
Item | Value |
Message Type | TAG |
Container Number | STOP7654321 and STOP7654322 |
Lloyds number | 8914001 |
Voyage number | 045S |
Departure Terminal | ASLPB |
Rail Destination | MIST |
Intermodal Rail Terminal | INDR |
Response Email Address | test@1-stop.biz |
<CTO_RELEASE xsi:noNamespaceSchemaLocation="CTO_Release-Version1.1.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CTOReleaseHeader>
<MessageName>CTO RELEASE - CONTAINER TAGGING</MessageName>
<MessageFunction>ORIGINAL</MessageFunction>
<MessageEventDateTime>20110524123745</MessageEventDateTime>
<Sender>
<SenderCode>ABCD</SenderCode>
<SenderRole>CONTRACTOR</SenderRole>
<SendersPassword>test</SendersPassword>
<SendersMessageReferenceID>1STOP000034952</SendersMessageReferenceID>
<SendersMessageVersion>1</SendersMessageVersion>
<SendersEventDateTime>20110524123745</SendersEventDateTime>
</Sender>
<Receiver>
<ReceiverCode>ASLPB</ReceiverCode>
<ReceiverRole>CONTRACTOR</ReceiverRole>
</Receiver>
</CTOReleaseHeader>
<CTOReleaseDepartureDetails>
<On-CarriageTransportDetails>
<TransportMode>RAIL</TransportMode>
<CarrierCode>INDR</CarrierCode>
<CarrierName>INDEPENDENT RAILWAYS AUST PTY LTD</CarrierName> </
On-CarriageTransportDetails>
<Location>
<PlaceOfDepartureCode>ASLPB</PlaceOfDepartureCode>
<PlaceOfDepartureName>PATRICK, NS, PORT BOTANY</PlaceOfDepartureName>
<PlaceOfDestinationCode>MIST</PlaceOfDestinationCode>
<PlaceOfDestinationName>MACARTHUR INTERMODAL SHIPPING TERMINAL
LT</PlaceOfDestinationName>
</Location>
<Requester>
<RequesterCode>INDR</RequesterCode>
<RequesterRole>RAILOP</RequesterRole>
<ContactEmail>test@1-stop.biz</ContactEmail>
</Requester>
<PlaceOfAvailability>
<PlaceOfAvailabilityCode>ASLPB</PlaceOfAvailabilityCode>
<PlaceOfAvailabilityName>PATRICK, NS, PORT BOTANY</PlaceOfAvailabilityName> </
PlaceOfAvailability>
</CTOReleaseDepartureDetails>
<CTOReleaseCargoLines>
<ConsignmentItemNumber>1</ConsignmentItemNumber>
<ImportVesselDetails>
<LloydsNumber>8914001</LloydsNumber>
<Name>KITANO</Name>
<VoyageNumber>045S</VoyageNumber>
<DischargePort>AUSYD</DischargePort>
<VesselOperatorCode>XYZ</VesselOperatorCode>
<VesselOperatorName>XYZ</VesselOperatorName>
<VesselEstimateArrivalDate>20101130</VesselEstimateArrivalDate>
</ImportVesselDetails>
<ContainerDetails>
<ContainerNumber>STOP7654322</ContainerNumber>
<HandlingInstructionsCode>GEN</HandlingInstructionsCode>
</ContainerDetails>
</CTOReleaseCargoLines>
<CTOReleaseCargoLines>
<ConsignmentItemNumber>2</
ConsignmentItemNumber> <ImportVesselDetails>
<LloydsNumber>8914001</LloydsNumber>
<Name>KITANO</Name>
<VoyageNumber>045S</VoyageNumber>
<DischargePort>AUSYD</DischargePort>
<VesselOperatorCode>XYZ</VesselOperatorCode>
<VesselOperatorName>XYZ</VesselOperatorName>
<VesselEstimateArrivalDate>20101130</VesselEstimateArrivalDate>
</ImportVesselDetails>
<ContainerDetails>
<ContainerNumber>STOP7654321</ContainerNumber>
<HandlingInstructionsCode>GEN</HandlingInstructionsCode>
</ContainerDetails>
</CTOReleaseCargoLines>
</CTO_RELEASE>
5.2.4 Sample CTO Release - Container Release
Item | Value |
Message Type | RELEASE |
Container Number | STOP7654321 |
Lloyds number | 9261748 |
Voyage number | 024S |
Departure Terminal | ASLPB |
Rail Destination | MIST |
Intermodal Rail Terminal | INDR |
Response Email Address | test@1-stop.biz |
EIDO PIN | ABCDEFG |
<CTO_RELEASE xsi:noNamespaceSchemaLocation="CTO_Release-Version1.1.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CTOReleaseHeader>
<MessageName>CTO RELEASE - CONTAINER RELEASE</MessageName>
<MessageFunction>ORIGINAL</MessageFunction>
<MessageEventDateTime>20110524102108</MessageEventDateTime>
<Sender>
<SenderCode>ABCD</SenderCode>
<SenderRole>CONTRACTOR</SenderRole> <SendersPassword>test</SendersPassword> <SendersMessageReferenceID>1STOP000033883</SendersMessageReferenceID>
<SendersMessageVersion>1</SendersMessageVersion>
<SendersEventDateTime>20110524102108</SendersEventDateTime>
</Sender>
<Receiver>
<ReceiverCode>ASLPB</ReceiverCode>
<ReceiverRole>CONTRACTOR</ReceiverRole>
</Receiver>
</CTOReleaseHeader>
<CTOReleaseDepartureDetails>
<On-CarriageTransportDetails>
<TransportMode>RAIL</TransportMode>
<CarrierCode>INDR</CarrierCode>
<CarrierName>INDEPENDENT RAILWAYS AUST PTY LTD</CarrierName>
</On-CarriageTransportDetails>
<Location>
<PlaceOfDepartureCode>ASLPB</PlaceOfDepartureCode>
<PlaceOfDepartureName>PATRICK, NS, PORT BOTANY</PlaceOfDepartureName>
<PlaceOfDestinationCode>MIST</PlaceOfDestinationCode>
<PlaceOfDestinationName>MACARTHUR INTERMODAL SHIPPING TERMINAL
LT</PlaceOfDestinationName>
</Location>
<Requester>
<RequesterCode>INDR</RequesterCode>
<RequesterRole>RAILOP</RequesterRole>
<ContactEmail>test@1-stop.biz</ContactEmail>
</Requester>
<PlaceOfAvailability>
<PlaceOfAvailabilityCode>ASLPB</PlaceOfAvailabilityCode>
<PlaceOfAvailabilityName>PATRICK, NS, PORT BOTANY</PlaceOfAvailabilityName> </
PlaceOfAvailability>
</CTOReleaseDepartureDetails>
<CTOReleaseCargoLines>
<ConsignmentItemNumber>1</ConsignmentItemNumber>
<ImportDeliveryNumber>ABCDEFG</ImportDeliveryNumber>
<ImportVesselDetails>
<LloydsNumber>9261748</LloydsNumber>
<Name>MOL ENTERPRISE</Name>
<VoyageNumber>024S</VoyageNumber>
<DischargePort>AUSYD</DischargePort>
<VesselOperatorCode>XYZ</VesselOperatorCode>
<VesselOperatorName>XYZ</VesselOperatorName>
<VesselEstimateArrivalDate>20101130</VesselEstimateArrivalDate>
</ImportVesselDetails>
<ContainerDetails>
<ContainerNumber>STOP7654321</ContainerNumber>
<HandlingInstructionsCode>HAZ</HandlingInstructionsCode>
</ContainerDetails>
</CTOReleaseCargoLines>
</CTO_RELEASE>
5.3 CTO_RELEASE_SyntaxValidation XML Message Schema (CONTROL) |
5.3.1 What is a CTO_RELEASE_SyntaxValidation XML for?
This schema is the Control XML message clients receive as an acknowledgement whether the TAG/RELEASE request send has passed the validation. In EDI terminology CONTROL messages gives clients the description if the REQUEST received will be processed and which part of the message did not conform to the message specification.
5.3.2 CTO_RELEASE_SyntaxValidation XML Message Specification
XML Fields |
Mandatory /Optional |
Type | Length | Definition |
SyntaxValidationHeader | ||||
MessageName | M | String | CTO RELEASE - SYNTAX VALIDATION RESPONSE | |
MessageReferenceID | M | String | The Syntax Validation Message Reference Number | |
MessageResponseDateTi me | M | String | 14 |
OneStop Messaging Gateway Message Response Date/Time. Format -CCYYMMDDHHMMSS |
Sender | ||||
SenderCode M String OneStop Registered Code | ||||
Receiver | ||||
ReceiverCode M String ACOS Trading Code of CTO Rail Release Message Sender |
||||
SyntaxValidationDetails | ||||
SyntaxValidationStatus | ||||
RailReleaseMessageRefer enceID | M | String | The Message Reference Number in the Rail Release Message received | |
RailReleaseMessageVersi on | M | Integer | The Message Version Number in the Rail Release Message received | |
MessageResponseType | M | Sting |
CONTAINER RELEASE - CONTAINER RELEASE CONTAINER RELEASE – CONTAINER TAGGING |
|
MessageResponseStatus | O | String |
REJECTED ACKNOWLEDGED |
|
SyntaxValidationErrors | ||||
ElementTagName | M | String | XML Element Tag Name with Errors | |
ParentElementTagName | O | String | PARENT Element Tag Name (COMPLEX ELEMENT) | |
ErrorDescription | M | String | Please refer to Appendix C |
5.3.3 Sample CTO_RELEASE_SyntaxValidation (CONTROL)- REJECTED
Item | Value |
Message Type | TAG |
Sender Message Reference | TEST1234567 |
Message Status | REJECTED |
Error Description | Duplicate Message Reference Number Detected |
<CTO_RELEASE_SyntaxValidation>
<SyntaxValidationHeader>
<MessageName>CTO RELEASE - SYNTAX VALIDATION RESPONSE</MessageName>
<MessageReferenceID></MessageReferenceID>
<MessageResponseDateTime>20110627114917</MessageResponseDateTime>
<Sender>
<SenderCode>1STOP</SenderCode>
</Sender>
<Receiver>
<ReceiverCode>XYZ</ReceiverCode>
</Receiver>
</SyntaxValidationHeader>
<SyntaxValidationDetails>
<SyntaxValidationStatus>
<RailReleaseMessageReferenceID>TEST1234567</RailReleaseMessageReferenceID>
<RailReleaseMessageVersion></RailReleaseMessageVersion>
<MessageResponseType>CTO RELEASE - CONTAINER TAGGING</MessageResponseType>
<MessageResponseStatus>REJECTED</MessageResponseStatus>
</SyntaxValidationStatus>
<SyntaxValidationErrors>
<ElementTagName>SendersMessageReferenceID</ElementTagName>
<ParentElementTagName>Sender</ParentElementTagName>
<ErrorDescription>Duplicate Message Reference Number Detected</ErrorDescription>
</SyntaxValidationErrors>
</SyntaxValidationDetails>
</CTO_RELEASE_SyntaxValidation>
5.3.4 Sample CTO_RELEASE_SyntaxValidation (CONTROL)- ACKNOWLEDGED
Item | Value |
Message Type | TAG |
Sender Message Reference | TEST1234568 |
Message Status | ACKNOWLEDGED |
<CTO_RELEASE_SyntaxValidation>
<SyntaxValidationHeader>
<MessageName>CTO RELEASE - SYNTAX VALIDATION RESPONSE</MessageName>
<MessageReferenceID></MessageReferenceID>
<MessageResponseDateTime>20110627130334</MessageResponseDateTime>
<Sender>
<SenderCode>1STOP</SenderCode>
</Sender>
<Receiver>
<ReceiverCode>EXPWL</ReceiverCode>
</Receiver>
</SyntaxValidationHeader>
<SyntaxValidationDetails>
<SyntaxValidationStatus>
<RailReleaseMessageReferenceID>TEST1234568</RailReleaseMessageReferenceID>
<RailReleaseMessageVersion></RailReleaseMessageVersion>
<MessageResponseType>CTO RELEASE - CONTAINER TAGGING</MessageResponseType>
<MessageResponseStatus>ACKNOWLEDGED</MessageResponseStatus> </SyntaxValidationStatus>
</SyntaxValidationDetails>
</CTO_RELEASE_SyntaxValidation>
5.4 CTO_RELEASE_RESPONSE XML Message schema |
5.4.1 What is the CTO_RELEASE_RESPONSE XML Message schema for?
CTO_RELEASE_RESPONSE is the XML clients receive to confirm if the TAG/RELEASE request has been processed by the terminal.
5.4.2 CTO_RELEASE_RESPONSE XML Specification
XML Fields |
Mandatory /Optional |
Type | Length | Definition |
CTOReleaseResponseHeader | ||||
MessageName | M | String |
CTO RELEASE RESPONSE CONT_TAGGING RESPONSE |
|
MessageFunction | M | String | ORIGINAL | |
MessageEventDateTime | M | String | 14 |
The Actual Date/Time the Message is sent from the System - OneStop Messaging Gateway or Terminal Systems. Format - CCYYMMDDHHMMSS (OneStop Usage only) |
OriginalDocumentDetails | ||||
OriginalDocumentName | M | String |
CTO RELEASE - CONTAINER TAGGING CTO RELEASE - CONTAINER RELEASE |
|
OriginalDocumentNumber | M | String | Original Message Reference Number | |
OriginalDocumentVersion | M | Integer | Original Message Version Number | |
OriginalDocumentIssueDat eTime | M | String | 14 |
Original Document Date/Time of Issue. Format - CCYYMMDDHHMMSS |
Sender | ||||
SenderCode | M | String | ONESTOP Registered Code “1STOP” | |
SenderRole | M | String |
BUREAU(for OneStop) CONTRACTOR(for CTO Terminal) |
|
SendersMessageReferenc eID | M | String | Senders Message Reference ID | |
SendersEventDateTime | M | String | 14 |
Date/Time the message created in the Sender's System. Format - CCYYMMDDHHMMSS |
Receiver | ||||
ReceiverCode | M | String | ACOS Code of the Terminal or Trading Code | |
ReceiverRole | M | String |
LINE(Shippint Line) BUREAU CARRIER(Transport Carrier) IMPORTER RAILOP(Rail Operator) |
|
CTOReleaseResponseLines | ||||
ResponseCode | M | String | Please refer to Appendix B | |
ResponseDescription | M | String | CTO Release Response Description | |
CargoIdentifier | M | String | 11 | Container Number |
5.4.3. Sample CONT_TAGGING RESPONSE
Item | Value |
Message Type | TAG RESPONSE |
Container Number | STOP7654321 |
RESPONSE CODE | RR000 |
<CTO_RELEASE_RESPONSE>
<CTOReleaseResponseHeader>
<MessageName>CONT_TAGGING RESPONSE</MessageName>
<MessageFunction>ORIGINAL</MessageFunction>
<MessageEventDateTime>20110524101401</MessageEventDateTime> <OriginalDocumentDetails>
<OriginalDocumentName>CTO RELEASE - CONTAINER TAGGING</OriginalDocumentName>
<OriginalDocumentNumber>1STOP000034933</OriginalDocumentNumber>
<OriginalDocumentVersion>1</OriginalDocumentVersion>
<OriginalDocumentIssueDateTime>20110524100601</OriginalDocumentIssueDateTime>
</OriginalDocumentDetails>
<Sender>
<SenderCode>1STOP</SenderCode>
<SenderRole>BUREAU</SenderRole>
<SendersMessageReferenceID>1STOP000034933</SendersMessageReferenceID>
<SendersEventDateTime>20110524100601</SendersEventDateTime>
</Sender>
<Receiver>
<ReceiverCode>ABCD</ReceiverCode>
<ReceiverRole>CONTRACTOR</ReceiverRole>
</Receiver>
</CTOReleaseResponseHeader>
<CTOReleaseResponseLines>
<ResponseCode>RR000</ResponseCode>
<ResponseDescription>CONTAINER ACCEPTED BY TERMINAL</ResponseDescription>
<CargoIdentifier>STOP7654321</CargoIdentifier>
</CTOReleaseResponseLines>
</CTO_RELEASE_RESPONSE>
5.4.4. Sample RAIL_RELEASE RESPONSE
Item | Value |
Message Type | RELEASE RESPONSE |
Container Number | STOP7654321 |
RESPONSE CODE | RR000 |
<CTO_RELEASE_RESPONSE>
<CTOReleaseResponseHeader>
<MessageName>RAIL_RELEASE RESPONSE</MessageName>
<MessageFunction>ORIGINAL</MessageFunction>
<MessageEventDateTime>20110524132348</MessageEventDateTime>
<OriginalDocumentDetails>
<OriginalDocumentName>CTO RELEASE - CONTAINER RELEASE</OriginalDocumentName>
<OriginalDocumentNumber>1STOP000034319</OriginalDocumentNumber>
<OriginalDocumentVersion>5</OriginalDocumentVersion>
<OriginalDocumentIssueDateTime>20110524131317</OriginalDocumentIssueDateTime>
</OriginalDocumentDetails>
<Sender>
<SenderCode>1STOP</SenderCode>
<SenderRole>BUREAU</SenderRole>
<SendersMessageReferenceID>1STOP000034319</SendersMessageReferenceID>
<SendersEventDateTime>20110524131317</SendersEventDateTime>
</Sender>
<Receiver>
<ReceiverCode>ABCD</ReceiverCode>
<ReceiverRole>CONTRACTOR</ReceiverRole>
</Receiver>
</CTOReleaseResponseHeader>
<CTOReleaseResponseLines>
<ResponseCode>RR000</ResponseCode>
<ResponseDescription>CONTAINER ACCEPTED BY TERMINAL</ResponseDescription>
<CargoIdentifier>STOP7654321</CargoIdentifier>
</CTOReleaseResponseLines>
</CTO_RELEASE_RESPONSE>
5.4.5 Sample ACCEPTED Email Response
5.4.6 Sample REJECTED Email Response
6. GETTING STARTED
6.1 Have you read the Customer User Guide? |
We recommend that Administrators read the Rail Tagging and Release Customer
User Guide before reading about the Administrator functions of each service. The Customer User Guide will demonstrate how the end-user operates the service. It will be easier to understand the Administrator functions if you also understand the customer context.
If you didn’t receive the Rail Tagging and Release Customer User Guide when you received this, you can download it from www.1-Stop.biz.
7. HOW TO...
To send XML messages for Rail, you need to first log in to Rail Release and Tagging web application and then compose the XML messages.
7.1 How to log in and access |
To log in and access Rail Release and Tagging web application, follow the steps outlined in the Help Centre.
7.2 How to send the XML message |
You will have to send the XML message as a plain text email attachment with the following details:
Environment | Subject | Email address |
Test (UAT) | RR_XML | stop20@test.1-stop.biz |
Production | RR_XML | railrelease@edi.1-stop.biz |
8. WHERE TO GET HELP
Help is available:
- check out our range of resources in the 'Rail Tagging & Release' tab on our Help Centre or
- Contact the Helpdesk by raising a support ticket here.
9. GLOSSARY
See the Glossary in the Customer User Guide.
APPENDIX A
These are the acceptable Loading terminal codes used by OneStop.
Terminal | Location | Code |
Patrick | Brisbane – Fisherman Island | PTFIT |
Fremantle | ASLFR | |
Melbourne – East Swanson | ASES1 | |
Sydney – Port Botany | ASLPB | |
DP World | Brisbane | DPBNE |
Fremantle | CONFR | |
Melbourne – West Swanson | CONWS | |
Sydney – Port Botany | CTLPB | |
AAT | Brisbane – Fisherman Island | AATFI |
Sydney – Port Kembla | AATPK | |
Adelaide | AATAD | |
QUBE Ports | Tasmania – Bell Bay | CONBE |
Northern Territory - POAG Darwin | CONDW | |
Western Australia - ESPERANCE | QBESP | |
Western Australia - PORT HEDLAND | QBPHD | |
Western Australia - DAMPIER | QBDAM | |
Hutchison Ports | Brisbane – Fisherman Island | HPAFI |
Sydney – Port Botany | HPAPB | |
VICT | Melbourne – Victoria International Container Terminal | VICTM |
LINX Terminals | Northern Territory - Darwin | LNXDW |
Western Australia - ESPERANCE | LNXEP | |
APPENDIX B
Here is the list of Response Codes
Response Code | Description |
RR000 |
CONTAINER ACCEPTED BY TERMINAL (To be used when the CTO Release Instructions are validated and accepted by the Terminals) |
RR001 |
INVALID MSG TYPE – 127 CONT TAGGING AND 129 CONT RELEASE – CORRECT AND RE-SUBMIT (To be used when the Message Type specified in the CTO Release Instructions is not 127 Container Tagging or 129 Container Release) |
RR002 |
INVALID MSG VERSION OR FUNCTION – 9 ORIGINAL, 4 CHANGE AND 1 CANCEL – CORRECT AND RE-SUBMIT (To be used when the Message Function specified in the CTO Release Instructions is not 9 Original, 4 Change nor 1 Cancellation) |
RR003 |
INVALID RESPONSE REQUEST TYPE – AB, AP, CA, RE OR BLANK ONLY – CORRECT AND RE-SUBMIT (To be used when Response Request Type specified in the CTO Release Instructions is not AB Message Acknowledge Always, AP Message Acknowledgement for Accepted CTO Release Instruction, RE Message Acknowledgement for Rejected CTO Release Instruction) |
RR004 |
CONTAINER NOT FOUND – CORRECT AND RE-SUBMIT (To be used when Container Number specified is not found at the Terminal) |
RR005 | CONTAINER DEPARTURE NOT RAIL – CORRECT AND RE-SUBMIT |
RR006 |
COMMERCIAL RELEASE NUMBER NOT FOUND – CORRECT AND RE-SUBMIT (To be used when the E-IDO Pin has not been provided) |
RR007 |
COMMERCIAL RELEASE NUMBER INCORRECT – CORRECT AND RE-SUBMIT (To be used when E-IDO Pin given is incorrect) |
RR008 |
WRONG TERMINAL – CORRECT AND RE-SUBMIT (To be used when the specified Discharge Terminal is incorrect) |
RR009 |
NO DESTINATION SPECIFIED – CORRECT AND RE-SUBMIT (To be used when there is no Rail Destination specified) |
RR010 | DESTINATION NOT FOUND – CORRECT AND RE-SUBMIT |
RR011 |
CONTAINER HAS NOT BEEN TAGGED – CORRECT AND RE-SUBMIT (To be used when User sends in a Container Release Message without the prior Container Tagging Message) |
RR012 | BAYPLAN NOT FOUND FOR SPECIFIED CONTAINER - CONTACT TERMINAL |
(To be used when No Bay Plan for specified Container has not been received) | |
RR013 |
CONTAINER HAS BEEN DISCHARGED - CONTACT TERMINAL (To be used when Container has already been discharged and the Container Tagging Requester will have to contact the relevant Terminal directly) |
RR014 |
CONTAINER HAS ALREADY BEEN TAGGED (To be used when the specified Container has already been tagged by other User, no further action required) |
RR015 |
MAX 150 CONTAINERS CAN BE TAGGED PER MSG (To be used when User wants to tag or release more than 150 Containers) |
RR016 |
RAIL OPERATOR MANDATORY FIELD MISSING – CORRECT AND RE-SUBMIT (To be used when the Mandatory Rail Operator Field is not provided) |
RR017 |
RAIL OPERATOR NOT FOUND – CORRECT AND RE-SUBMIT (To be used when the Rail Operator specified cannot be found in the System) |
RR018 |
RAIL DESTINATION NOT FOUND – CORRECT AND RE-SUBMIT (To be used when Rail Destination specified is not found) |
RR019 |
SENDER PASSWORD INCORRECT – CORRECT AND RE-SUBMIT (To be used when the Sender Password Validation fails) |
RR020 |
CONTAINER ALREADY DEPARTED TERMINAL - CONTACT TERMINAL (To be used when the Sender Password Validation fails) |
RR999 |
CTO SYSTEM ERROR – AWAIT RESPONSE BEFORE RE-PROCESSING (To be used when the Sender Password Validation fails) |
APPENDIX C
Error Code | Description |
07 | Invalid Recipient |
12 | Invalid Value Atribute |
13 | Tag Missing |
14 | Value Attribute not Supported in this Position |
15 | Tag not Supported in this Position |
18 | Unspecified Syntax Error |
21 | Invalid Character |
23 | Unknown Sender |
26 | Duplicate Message Reference Number Detected |
33 | Invalid Occurence of Element |
35 | Too Many Data Element Repetitions |