ISO/PRF 28005-1

Ships and marine technology — Electronic port clearance (EPC) — Part 1: Message structures and application programming interfaces

1 Scope This part of ISO 28005 specifies necessary guidance information related to electronic port clearance (EPC), such as message transmission requirements, business scenarios, message structures and software requirements. Within the context of this part of ISO 28005, EPC incudes the activities that a user, such as a ship's master, a shipping agency or a ship owner undertakes to submit electronic data to appropriate organizations that approve or reject the clearance for the ship to enter or leave port. Annex A provides implementation advice for a single window (SW). Annex B suggests a methodology for the development of a SW. This part of ISO 28005 defines XML message structures for the transmission of information between a ship or its representatives and certain organizations responsible for the processing of the ship's port clearance request. The information intended to be transferred is that which is defined by the FAL Convention and other related international instruments as identified by ISO 28005-2. These message structures are primary intended for machine -to- machine data transfers. This part of ISO 28005 allows different configurations of the SW, from a minimum solution to support basic clearance requirements to a more complex system to facilitate more extensive cooperation between ship and shore organizations.

Navires et technologie maritime — Opérations portuaires assistées par systèmes électroniques — Partie 1: Structures des messages et interfaces de programmation des applications

General Information

• Status: Not Published
• ICS: 35.240.60 - IT applications in transport
• ICS: 47.020.99 - Other standards related to shipbuilding and marine structures
• Technical Committee: ISO/TC 8/SC 11 - Intermodal and Short Sea Shipping
• Drafting Committee: ISO/TC 8/SC 11 - Intermodal and Short Sea Shipping
• Current Stage: 5020 - FDIS ballot initiated: 2 months. Proof sent to secretariat
• Completion Date: 24-Sep-2024

Relations

• Revises: ISO 28005-1:2013 - Security management systems for the supply chain — Electronic port clearance (EPC) — Part 1: Message structures
• Effective Date: 06-Jun-2022

Standards Content (Sample)

International
Standard
ISO 28005-1
Second edition
Ships and marine technology —
Electronic port clearance (EPC) —
Part 1:
Message structures and application
programming interfaces
Navires et technologie maritime — Opérations portuaires
assistées par systèmes électroniques —
Partie 1: Structures des messages et interfaces de programmation
des applications
PROOF/ÉPREUVE
Reference number
ISO 28005-1:2024(en) © ISO 2024

ISO 28005-1:2024(en)
© ISO 2024
All rights reserved. Unless otherwise specified, or required in the context of its implementation, no part of this publication may
be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on
the internet or an intranet, without prior written permission. Permission can be requested from either ISO at the address below
or ISO’s member body in the country of the requester.
ISO copyright office
CP 401 • Ch. de Blandonnet 8
CH-1214 Vernier, Geneva
Phone: [phone]
Email: [e-mail]
Website: www.iso.org
Published in Switzerland
PROOF/ÉPREUVE
ii
ISO 28005-1:2024(en)
Contents Page
Foreword .ix
Introduction .xi
1 Scope . 1
2 Normative references . 1
3 Terms, definitions, and abbreviated terms . 1
3.1 Terms and definitions .1
3.2 Abbreviated terms .5
4 Structure of XSD data type and object definitions . 6
4.1 General .6
4.2 Principles for XML descriptions in the ISO 28005 series .7
4.2.1 No use of XML attributes .7
4.2.2 Defaults for minOccurs and maxOccurs .7
4.2.3 Signalling empty XML tags .7
4.2.4 Order of child elements in XSD files .7
4.2.5 Character set .7
4.2.6 Principles for defining types with code lists.7
4.2.7 XSD name space for general XSD data types .8
4.2.8 ISO 28005 name space .8
4.2.9 Use of Xpath expressions .8
4.3 Structure of clauses defining data types.8
4.3.1 Clause and data type name .8
4.3.2 Definition .8
4.3.3 Type defined as XSD code .9
4.3.4 Representation .9
4.4 Creating valid XSD schema files .9
4.4.1 File structure .9
4.4.2 Numbering of XSD files and message version code .10
4.4.3 Location of XSD files .11
4.5 Reference to data types defined in ISO 28005-2:2021 .11
5 Adapted XSD data types for ISO 28005 .12
5.1 General . 12
5.2 epc:anyURI – Generalized URI . 12
5.2.1 Definition . 12
5.2.2 Type . 12
5.2.3 Representation . 12
5.3 epc: boolean – Boolean flag . 12
5.3.1 Definition . 12
5.3.2 Type . 12
5.3.3 Representation . 12
5.4 epc:date – General date . 12
5.4.1 Definition . 12
5.4.2 Type . 12
5.4.3 Representation . 13
5.5 epc:dateTime – Time and date, with time zone . 13
5.5.1 Definition . 13
5.5.2 Type . 13
5.5.3 Representation . 13
5.6 epc:decimal – decimal number . 13
5.6.1 Definition . 13
5.6.2 Type . 13
5.6.3 Representation . 13
5.7 epc:duration – Time duration.14
5.7.1 Definition .14
PROOF/ÉPREUVE
iii
ISO 28005-1:2024(en)
5.7.2 Type .14
5.7.3 Representation .14
5.8 epc:int – Integer number.14
5.8.1 Definition .14
5.8.2 Type .14
5.8.3 Representation .14
5.9 epc:string – General string .14
5.9.1 Definition .14
5.9.2 Type .14
5.9.3 Representation . 15
5.10 epc:token – Computer-understandable string . 15
5.10.1 Definition . 15
5.10.2 Type . 15
5.10.3 Representation . 15
5.11 epc:xpath – Identification of an XML data item . 15
5.11.1 Definition .
...

Formatted
...
Style Definition
ISO/DIS 28005--1:2023(E2024(en)
...
Style Definition
...
ISO TC 8/SC 11/WG 2
Style Definition
...
Secretariat: KATS
Style Definition
...
Style Definition
...
Date: 2024-01-3009-10
Style Definition
...
Ships and marine technology — Electronic port clearance (EPC) — Part 1: Message structures
Style Definition
...
and application programming interfaces
Style Definition
...
Systèmes de management de la sécurité pour la chaîne d’approvisionnementNavires et technologie Style Definition
...
maritime — Opérations portuaires assistées par systèmes électroniques —
Style Definition
...
Style Definition
Partie 1: .
DeStructures des messages et interfaces de programmation des applications
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Style Definition
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Formatted
...
Edited DIS - MUST BE USED FOR FINAL DRAFT

ISO/DIS 28005-1:2023(E)
Formatted: Font: 11 pt
Formatted: Justified, Space After: 30 pt, Line spacing:
Exactly 11 pt
Formatted: Left: 2 cm
Formatted: English (United Kingdom)
All rights reserved. Unless otherwise specified, or required in the context of its
implementation, no part of this publication may be reproduced or utilized otherwise in any
Formatted: Default Paragraph Font, English (United
form or by any means, electronic or mechanical, including photocopying, or posting on the
Kingdom)
internet or an intranet, without prior written permission. Permission can be requested from
Formatted: English (United Kingdom)
either ISO at the address below or ISO’sISO's member body in the country of the requester.
Formatted: English (United Kingdom)
ISO copyright officeCopyright Office
CP 401 • Ch. De Blandonnet 8
CH-1214 Vernier, Geneva
Formatted: English (United Kingdom)
Formatted: Indent: Left: 0 cm, First line: 0 cm, Right: 0
Phone: + 41 22 749 01 11
cm, Adjust space between Latin and Asian text, Adjust
space between Asian text and numbers
Email: [e-mail]
Formatted: English (United Kingdom)
Formatted: English (United Kingdom)
Email: [e-mail]
Formatted: English (United Kingdom)
Website: www.iso.orgwww.iso.org
Formatted: Indent: Left: 0 cm, First line: 0 cm, Right: 0
cm, Adjust space between Latin and Asian text, Adjust
Published in Switzerland.
space between Asian text and numbers
ii © ISO 2023 – All rights reserved

ISO/DIS 28005-1:2023(E2024(en)
Formatted: Font: 11.5 pt, Font color: Custom
Color(RGB(33;29;30))
Formatted: Centered
Formatted: Font: 11.5 pt, Font color: Custom
Color(RGB(33;29;30))
Formatted: Font: 11.5 pt, Font color: Custom
Contents
Color(RGB(33;29;30))
Foreword . x
Introduction. xi
1 Scope . 1
2 Normative references . 1
3 Terms, definitions, and abbreviated terms . 2
3.1 Terms and definitions . 2
3.1.1 General terms with specific meaning in this standard . 2
3.1.2 Terms related to message exchanges and sequence diagrams . 3
3.1.3 Other terms . 5
3.2 Abbreviated terms . 5
4 Structure of XSD data type and object definitions . 6
4.1 General . 6
4.2 Principles for XML descriptions in the ISO 28005 series . 6
4.2.1 No use of XML attributes . 6
4.2.2 Defaults for minOccurs and maxOccurs . 6
4.2.3 Signalling empty XML tags . 7
4.2.4 Order of child elements in XSD files . 7
4.2.5 Character set . 7
4.2.6 Principles for defining types with code lists . 7
4.2.7 XSD name space for general XSD data types . 7
4.2.8 ISO 28005 name space . 7
4.3 Structure of clauses defining data types . 8
4.3.1 Clause and data type name . 8
4.3.2 Definition . 8
4.3.3 Type defined as XSD code . 8
4.3.4 Representation . 8
4.4 Creating a valid XSD schema for a message part . 8
4.5 Structure of resulting ISO 28005 XSD files . 9
4.5.1 General structure . 9
4.5.2 The message body definitions: iso28005-i.xsd . 9
4.6 Location of XSD files . 10
4.7 Reference to data types defined in ISO 28005-2 . 10
5 Adapted XSD data types for ISO 28005 . 11
5.1 Introduction . 11
5.2 epc:anyURI – Generalized URI. 11
5.3 epc:boolean – Boolean flag . 11
5.4 epc:date – General date . 11
5.5 epc:dateTime – Time and date, with time zone . 12
5.6 epc:decimal – Decimal number . 12
5.7 epc:duration – Time duration . 13
5.8 epc:int – Integer number . 13
Formatted: Normal, Centered, Space After: 24 pt, Tab
5.9 epc:string – General string . 13
stops: 17.2 cm, Right
iii
Edited DIS - MUST BE USED FOR FINAL DRAFT

ISO/DIS 28005-1:2023(E)
Formatted: Justified, Space After: 30 pt, Line spacing:
Exactly 11 pt
Formatted: Font: 11 pt
5.10 epc:token – Computer-understandable string . 14
6 General ISO 28005 data types . 14
6.1 General . 14
6.2 epc: AuthenticatorType – The authenticator of information . 14
6.3 epc:AuthorizationTokenType – Authorization token . 14
6.4 epc:ContactInfoType – Contact information . 15
6.5 epc:CommunicationNumberType – Communication number information . 15
6.6 epc:CountryCodeContentType – Country identification . 16
6.7 epc:GenderContentType – Enumeration type for Gender . 16
6.8 epc:CrewDutyType – Duty onboard or on shore . 16
6.9 epc:LocationType – Identification of a location . 17
6.10 epc:NameType – Name of person . 18
6.11 epc:OrganisationType – Description of an organization . 18
6.12 epc:PostalAddressType – A postal mail address . 19
6.13 epc:ShipIDType – Ship identity . 19
6.14 epc:ReportingSystemType – Name of a reporting system . 20
6.15 epc:AttachmentType – Reference to an attached document . 21
6.16 epc:ReferenceCodeType – General reference code. 21
6.17 epc:SystemIdType – Identity code for a software system . 21
6.18 epc:SignatureCertificateIdType – Name of digital signature holder . 22
6.19 epc:VersionType – Version code . 22
7 ISO 28005 design principles . 23
7.1 Harmonization with the IMO Reference Data Model . 23
7.2 Fully automated machine to machine . 23
7.3 Using carrier independent and internet-based protocols . 23
7.4 The use of message sequence diagram . 24
7.5 Sender and receiver versus client and server – asynchronous message transfers . 24
7.6 Generalization of service . 25
7.7 Different levels of sessions . 26
7.7.1 Session context . 26
7.7.2 Service session . 26
7.7.3 HTTP session . 27
7.8 One service per request and service session . 27
7.9 Linking receivers to service providers . 27
7.10 Service states . 27
7.11 Use of request timeout . 28
7.12 Send data once only .
...