B2B Web Service Guidelines V2
RSVZ Enterprise Architecture
Owner
|
Dirk Vaneynde / Gert Driesen
|
Version
|
39
|
Last changed on
|
29/04/2011 11:30
|
Niets uit deze uitgave mag worden verveelvoudigd, openbaar gemaakt, overgeschreven, opgeslagen in een automatisch gegevensbestand, of vertaald in enige menselijke of computertaal, in enige vorm of op enige wijze, hetzij elektronisch, mechanisch, magnetisch, optisch, chemisch, met de hand of op enige andere wijze, zonder uitdrukkelijke schriftelijke toestemming van Cegeka N.V.
Cegeka N.V. behoudt zich het recht voor om de informatie in dit document te wijzigen of te herzien zonder voorafgaande kennisgeving.
Cegeka N.V. 2007-2011
History
Date
|
Description
|
Author
|
22/3/2007
|
Translation to English
|
Dirk Vaneynde
|
22/11/2007
|
Operation naming convention (4.3.1)
ApplHeader: Codes for Origin and Destination, TimestampSent field, FluxID
Rationale on ApplHeader in Body was not clearly explained
TransferOk has timestamp
Error handling – rewritten for clarity (4.3.5)
Path structure of WSDL’s and XML schemas has slightly changed (4.4.3)
Multiple Releases – rewritten for clarity (4.4.5)
Message Security (4.4.8)
Audit Logging (4.4.9).
|
Dirk Vaneynde
|
11/2/2008
|
SOAP faultstring & faultactor specified
Removed FluxID copying in 4.3.3 (bug)
WSDL for Bulk Operations - Removed (5.2)
|
Dirk Vaneynde
|
12/2/2008
|
Updated guideline wrt SOAPAction.
|
Gert Driesen
|
3/12/2008
|
Major rework: fluxes, faults, configuration management, new operation types.
|
Dirk Vaneynde
|
27/1/2009
|
Enumerations – rewritten for clarity (5.2.10)
Code and Description (5.2.11)
URI References (5.2.12)
WSDL Style and Use (5.2.13)
Bulk Operations (5.3.3) – order is not guaranteed
Error handling (5.3.7) – removed BusinesViolation and BcssError
Handling of System Errors / Idempotence – rewritten for clarity (5.3.8)
Interface Documentation (5.4)
|
Gert Driesen
|
29/1/2009
|
Unique Identifiers (5.2.14)
About Downloading Schema & WSDL Files – rewritten for clarity (5.5.8)
|
Gert Driesen
|
5/3/2009
|
Pseudo One-Way (5.3.2) – removed TransferResult requirement
Bulk Operations (5.3.3) – describe updated struct
ApplHeader (5.3.6) – describe updated struct
(5.3.7) – added AuthenticationFault and AuthorizationFault
Support for Fluxes (5.3.9) – describe updated struct
|
Gert Driesen
|
21/4/2009
| |
Gert Driesen
|
27/7/2009
|
WSDL Style and Use (5.2.13) – added information on XmlSerializer for WCF
|
Gert Driesen
|
21/01/2010
|
Bulk Operations (5.3.3) – describe need for unique MessageID for individual chunks.
|
Gert Driesen
|
26/04/2010
|
Certificate Request (6.1) – added
Certificate Renewal (6.2) – added
|
Gert Driesen
|
18/06/2010
|
Pseudo One-Way (5.3.2) – removed information on how to construct the ApplHeader for a POW reply as this information is specific to the version of the MetaInfo XSD
Bulk Operations (5.3.3) – removed specifics on the BlockStruct as this information is now part of the interface documentation for the MetaInfo XSD
ApplHeader (5.3.6) – moved information that is specific to a given version of the MetaInfo XSD to the interface documentation of that XSD
Service Definition Anatomy (5.5.2) – remove references to WS-ReliableMessaging
Versions (5.5.3) – remove distinction between major and minor version
WSDL Templates – removed
Binary content (5.3.10) – added guideline on transferring data
|
Gert Driesen
|
03/12/2010
|
Message Security (5.6.1) – added link to RSVZ certificates URL
Certificate Renewal (6.2.2) – added link to RSVZ certificates URL
|
|
Table of Contents
1.Introduction 6
2.References 7
3.Context 8
4.Glossary 10
5.Guidelines 12
5.1General 12
5.1.1Standards 12
5.2Schema Namespaces 13
5.2.1Always use a Target Namespace in schemas 13
5.2.2elementFormDefault & attributeFormDefault 14
5.2.3Default namespace and qualifiers 15
5.2.4Prefixes 16
5.2.5Reuse & Encapsulation: Local vs. Global Elements, Elements vs. Types 17
5.2.6Schema element & type name conventions 19
5.2.7Substitution groups 20
5.2.8Use of 21
5.2.9Documentation & Comments 22
5.2.10Enumerations 23
5.2.11Code and Description 25
5.2.12URI References 26
5.2.13WSDL Style and Use 27
5.2.14Unique Identifiers 29
5.3Web Services 30
5.3.1Taxonomy of Operations 30
5.3.2Pseudo One-Way 32
5.3.3Bulk Operations 34
5.3.4Operation Names 35
5.3.5SOAPAction 36
5.3.6ApplHeader 37
5.3.7Error Handling 38
5.3.8Handling of System Errors - Idempotence 40
5.3.9Support for Fluxes 44
5.3.10Binary content 45
5.4Interface Documentation 47
5.4.1Identification 47
5.4.2Operations 47
5.4.3Samples 47
5.5Configuraton Management & Release Management 48
5.5.1Introduction of Concepts 48
5.5.2Service Definition Anatomy 50
5.5.3Versions 52
5.5.4Modifications and Version Impact Analysis 55
5.5.5Releases 57
5.5.6Service Implementation Aspects & Versioning 59
5.5.7Life Cycle of Releases 61
5.5.8About Downloading Schema & WSDL Files 63
5.6Security 65
5.6.1Message Security 65
5.6.2Audit Logging 65
6.Appendix 67
6.1Certificate Request 67
6.1.1Server certificate 67
6.1.2Client certificate 69
6.1.3Key Length 70
6.1.4Procedure 70
6.2Certificate Renewal 71
6.2.1Social Insurance Fund 71
6.2.2RSVZ 72
Share with your friends: |
