filtering SIF Infrastructure Specification 3.3: Base Architecture www.A4L.org Version 3.3, May 2019 SIF Infrastructure Specification 3.3: Base Architecture Version 3.3, May 2019 1. Introduction .........................................................................................................................4 1.1. Preamble ........................................................................................................................ 4 1.2. Guiding Principles ......................................................................................................... 4 1.3. Disclaimer ...................................................................................................................... 5 1.4. Certification & Compliance Claims .............................................................................. 6 1.5. Permission and Copyright ............................................................................................ 6 1.6. Infrastructure Artifacts Overview ................................................................................ 7 1.7. Organization of Document ........................................................................................... 8 1.8. Document Conventions Definitions ............................................................................ 9 1.8.1. References ..................................................................................................................... 9 1.8.2. Terminology .................................................................................................................. 9 1.8.3. Element Characteristics ............................................................................................... 9 1.9. Assumptions ................................................................................................................ 10 1.10. Version Numbers ........................................................................................................ 10 1.11. SIF 2.6 Infrastructure Functionality not carried forward ......................................... 11 1.12. New functionality introduced in SIF 3.0 .................................................................... 12 1.13. Changes introduced in SIF 3.1 ................................................................................... 14 1.14. Changes introduced in SIF 3.2 ................................................................................... 15 1.15. Changes introduced in SIF 3.2.1 ................................................................................ 15 1.16. Changes introduced in SIF 3.3 ................................................................................... 16 2. Infrastructure Overview ................................................................................................... 17 2.1. Glossary of Terms and Concepts ............................................................................... 17 2.2. Environments .............................................................................................................. 29 3. Conventions, Dependencies & Metrics ............................................................................ 30 3.1. XML Name Spaces ....................................................................................................... 30 3.2. Normative References (Standards, versions and options) ...................................... 30 3.3. Infrastructure Protocol Layer (HTTPS) ...................................................................... 31 3.3.1. HTTPS Guidance ......................................................................................................... 32 Copyright © Access 4 Learning Page 1 of 103 SIF Infrastructure Specification 3.3: Base Architecture Version 3.3, May 2019 3.3.2. Infrastructure Protocol Layer (SIF HTTPS) .............................................................. 33 3.3.3. HTTP Codes ................................................................................................................. 33 3.4. UUIDs ............................................................................................................................ 34 3.5. Message-level element snippets and examples ...................................................... 34 4. Basic Infrastructure Framework ...................................................................................... 36 4.1. Service Hierarchy......................................................................................................... 36 4.1.1. SIF Environment ......................................................................................................... 36 4.1.2. SIF Zone ....................................................................................................................... 38 4.1.3. SIF Context .................................................................................................................. 39 4.2. Message Exchange Patterns (MEPs) .......................................................................... 40 4.2.1. Request / Response ................................................................................................... 40 4.2.2. Event Publish / Subscribe .......................................................................................... 42 4.2.3. Subscriber Error Handling Logic .............................................................................. 43 4.3. Message Parameters .................................................................................................. 44 4.3.1. Design Paradigm ........................................................................................................ 44 4.3.2. Parameter Details Summary .................................................................................... 45 4.3.3. URL Matrix Parameters ............................................................................................. 52 4.3.4. Notation Headers ....................................................................................................... 53 4.4. Request / Response / Event Message Exchange Choreography ............................ 55 Process Table ........................................................................................................................... 55 4.5. Error Handling ............................................................................................................. 59 4.5.1. SIF Error Message ....................................................................................................... 60 4.5.2. SIF HTTP Error Codes ................................................................................................. 61 4.6. Success Handling ......................................................................................................... 62 5. Service Operations ............................................................................................................. 64 5.1. Service Types ............................................................................................................... 64 5.2. Requests ....................................................................................................................... 68 5.3. Service Request Identifiers ......................................................................................... 69 5.4. Object-level Query ....................................................................................................... 70 Copyright © Access 4 Learning Page 2 of 103 SIF Infrastructure Specification 3.3: Base Architecture Version 3.3, May 2019 5.4.1. Object-level Query Options ...................................................................................... 72 5.4.2. Query Response Pages .............................................................................................. 73 5.5. Service Paths ................................................................................................................ 78 5.5.1. Service Paths in Query URLs ..................................................................................... 78 5.5.2. Service Paths in the Provider Registry .................................................................... 79 5.6. eXtended Query Options ............................................................................................ 80 5.6.1. Terminology ................................................................................................................ 80 5.6.2. Static eXtended Query Templates ........................................................................... 81 5.7. Dynamic Query ............................................................................................................ 84 5.8. Result Set Order .......................................................................................................... 86 5.9. Query By Example (QBE) ............................................................................................ 87 5.10. REST Call ....................................................................................................................... 87 5.11. QBE Payload & Query Functionality .......................................................................... 88 5.12. Provider Registry & ACLs ............................................................................................ 89 5.13. “Changes Since” Functionality .................................................................................... 90 5.13.1. REST Call (Consumer)................................................................................................