The Consumer Environment Service is the gateway to all other services. It scopes the Consumer's possible interactions with the infrastructure and any Provider Services accessible from it. The Environment Service provides the set of (possibly customized) information the Application needs to interoperate successfully.
" }, { "name": "provisionRequest", "description": "If an Environment supports self-provisioning Consumers than either this section must initially contain all the rights the Consumer has to all Services in all Zones, or the provisionRequests Infrastructure Service must be present in the Consumer's Environment to allow additional rights to be obtained.
" }, { "name": "queue", "description": "The Queues Service supports creation, deletion and querying of Queue (Instance) / Queue Messages Service pairs.
" }, { "name": "subscription", "description": "A Consumer uses the Subscriptions Infrastructure Service to subscribe to Events published by one or more Service Providers.
" }, { "name": "job", "description": "All functional services must use this object design to track state. While Events may be published back to the objects creator, they must not be published to the Consumer when the event was generated based on its request (since results were included in the response). Each functional service should define the expectations of how management of the job is managed for both the Consumer and Provider. For instance, certain optional fields may need to be included in-order-to successfully cause a job to be created.
" }, { "name": "state", "description": "For states updatable by the Consumer, it creates a new state much like it would a single object. The actual result (state or error) is included in the response. Each functional service should define the expectations for which Adaptor is responsible for updating the phase status. NOTE The \"states\" collection represented here is reserved for future capabilities.
" }, { "name": "UtilityServicesOverview", "x-displayName": "Utility Services Overview", "description": "", "externalDocs": { "description": "Utility Services Domain in SIF NZ Data Model", "url": "https://sifnzmodel.azurewebsites.net/SIFNZ-v3.3index.html" } }, { "name": "alert", "description": "Alerts form a system wide log that can be protected, as it may contain sensitive data. Ideally an Alert should contain as much identifying information about the problem being reported as possible.
" }, { "name": "codeSet", "description": "The Code Set Registry Service provides a way for all legal codes to be defined outside of the SIF Specification while allowing changes (additions and replacements) of external code set values to be easily verified by the recipient so as not to break existing Consumer / Provider interoperability.
" }, { "name": "namespace", "description": "The Namespaces Registry contains the set of XML namespace URIs and their corresponding schema location URLs that are currently valid within the Environment.
" }, { "name": "provider", "description": "All potentially accessible Services have an entry in the Providers Registry (including the Providers Registry Utility Service itself), although full or even partial Consumer access to that Service is determined by the access rights currently granted in the Consumer's Environment object, and is not guaranteed.
" }, { "name": "xquery", "description": "This collection defines the entire set of named queries that Consumers may legally issue for execution by Service Providers. A Consumer specifies the ID of a Named XQuery in a Query Request to a specific Service Provider, along with a set of values for any associated script parameters.
" }, { "name": "zone", "description": "Zone identifiers are chosen by the administrator and can follow any convention that best meets the needs of the deploying organization. The Zone in which the Service is to be found always qualifies every Consumer request for any Provider Service. Each Service Consumer is assigned a \"default\" Zone at Registration time, which is used whenever a specific Zone is not explicitly included in one of its Provider Service Requests.
" }, { "name": "PrivacyServicesOverview", "x-displayName": "Privacy Services Overview", "description": "", "externalDocs": { "description": "Privacy Services Domain in SIF NZ Data Model", "url": "https://sifnzmodel.azurewebsites.net/SIFNZ-v3.3index.html" } }, { "name": "pod", "description": "This object contains information about privacy obligations.
" } ], "paths": { "/environments/{id}": { "post": { "tags": [ "environment" ], "summary": "Default operation to create a single environment", "operationId": "createenvironment", "requestBody": { "description": "CRUD operation on environment", "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "$ref": "jsonSchema.yaml#/properties/environment" } } }, "example": { "environment": { "fingerprint": "f5688c40-97d2-11e6-ae22-56b6b6499611", "sessionToken": "a579ff69-0148-1000-007f-14109fdcaf83", "solutionId": "production", "defaultZone": { "description": "The zone for the local school district.", "properties": { "property": [ "john.smith@district.k12.wa.us", "(360)555-1234" ] } }, "authenticationMethod": "SIF_HMACSHA256", "instanceId": "1", "userToken": "MmZkMjVmODItYjAxMC00NTFiLWFjZTEtNmRjNTI4MWYwZjdlOmhpdHNAbnNpcA==", "consumerName": "Example Consumer", "applicationInfo": { "applicationKey": "Example", "supportedInfrastructureVersion": "3.1", "dataModelNamespace": "http://www.sifassociation.org/datamodel/na/3.3", "transport": "REST", "applicationProduct": { "vendorName": "SIF Association", "productName": "Fingertips Classroom App", "productVersion": "1.0.4", "iconURI": "https://www.sifassociation.org/PublishingImages/SIF%20Assoc%20symbol_LARGE.png " } }, "infrastructureServices": { "infrastructureService": [ "https://testharness.sifassociation.org/SIFConnector/AdaptorServer/0f 21cf0b-014c-1000-007f-00505686707f/environment/0f21cf0b-014c-1000-007f00505686707f", "https://testharness.sifassociation.org/SIFConnector/AdaptorSer ver/0f21cf0b-014c-1000-007f-00505686707f/requests" ] }, "provisionedZones": { "provisionedZone": { "services": { "service": [ { "rights": { "right": "APPROVED" } }, { "rights": { "right": "APPROVED" } } ] } } } } } }, "application/xml": { "schema": { "type": "object", "properties": { "environment": { "$ref": "jsonSchema.yaml#/properties/environment" } } }, "example": "