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. O Unique environment identifier that can be safely shared with others. In order to not compromise security it MUST NOT match the environment's refId, sessionToken, userToken, or applicationKey. O O The solution the Application would like to participate in. This is optional only, is advisory, and may be ignored by the Administrator. If processed it may be reflected in the URLs of the infrastructure services which are provided in the consumerEnvironment. O O Defines the way in which the applicationKey can be used to enforce security. O O O A descriptive name for the application that will be readily identifiable to Zone Administrators if it becomes a Registered Consumer O O O O O 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. M A specific Zone defined for this environment. O Low O The Queues Service supports creation, deletion and querying of Queue (Instance) / Queue Messages Service pairs. O Determines, when no messages are queued, whether the Consumer will have to periodically reissue Polling Requests at timed intervals or can reissue a Polling Request immediately. C The Environment ID of the owning Consumer for which this Queue is buffering messages. It is not specified at Queue create time, but is returned as part of the response to a query operation, and serves to allow an administrative application to identify which application the Queue instance is assigned to. O A name which the Consumer assigns to the Queue. It is useful for reporting purposes, but is not guaranteed to be unique. O The URI of the Messages Service associated with the Queue instance. This is the endpoint where the 'get next message' requests are issued. O When present, this contains the URL which the Queue instance will use when it determines the owner needs to be asynchronously alerted that a new message has arrived in the Queue. O Is the maximum time in seconds the Messages Service will wait for a message to arrive, before returning an HTTPS Response of 'no message seen' to the Consumer. C indicates the minimum time in seconds that the Consumer should wait after receiving a 'no message seen' response to a previous query, before posting another. O Number of (properly identified) concurrent connections supported by (the consumer, if suggested, and) the queue. O Time that Queue Instance was Created O Time that Queue Instance was last Accessed and a message was dequeued. O Time that Queue Instance was last Modified by receiving a new incoming message. O The number of messages currently residing in the Queue. O A Consumer uses the Subscriptions Infrastructure Service to subscribe to Events published by one or more Service Providers. M O The unique identity of a context element, which is associated with a Provider of this name and type operating in a Zone with this ID. M The type of the service O The subtype of the Service O The type of the message M The name of the Service. For utilities, this is fixed to one of the defined set of Utility Service Names. For objects and functions, it is defined by the Data Model. M Specifies which queues you want data associated with this subscription published to. O 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. M The name of the job, e.g. "grading" or "sre". O A description of the job, e.g. "Bowers Elementary School Final Marks" O The current enumerable state of the job. O A descriptive message elaborating on the current state, e.g. if the current state is "FAILED" the stateDescription may be "Timeout occured". O The datetime this job was created. O The datetime this job was last modified. O The ammount of time after creation before this job is automatically deleted. O The phases that make up this job. O O 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. 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. M External identification of the Application (Consumer or Provider) reporting this Alert. O External identification of the cause of the Alert. M The exchange (or lack of exchange) responsible for generating the Alert. M The level of the Alert. O A description of the reason for the Alert. C If available, the ID of the Message causing the problem. O The internals of the offending message or a more complete description of the information or state change. Usage of the CDATA designation is recommended in order to make the XML contents more readable to humans. O Detailed error results such as a stack trace. O An indicator of the specific element that was in error (or contributed to the problem. [NEEDS TO BE CHANGED TO the SIF XPATH TYPE] C If the Alert Level is an error, this value must be the SIF 3.0.1 Error Category corresponding to the type of Error being reported C If the Alert Level is an error, this value must be the SIF 3.0.1 Error Code corresponding to the type of Error being reported. O Code internal to the reporter. O 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. M If this is tied to a specific zone it is specified here, otherwise "environment-global" indicates applicability to all zones in the Environment. M The official major, minor, and revision version of the code set. M The date and time of the last change to this code set. So that only updates can be queried efficiently (where applicable). C URL to an external code set whose values are not (yet) present in the system. O O The Namespaces Registry contains the set of XML namespace URIs and their corresponding schema location URLs that are currently valid within the Environment. M If this namespace is tied to a specific zone it is specified here. M The namespace URI of the retrieved URL. M The URL of the specified namespace URI. O 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. M The generic type of Service being provided. M The name of the Service or the Service Path being provided. M The name of the Service Context being provided. M The Zone in which the Service Context is being provided. M The name of the Service Provider as it would be referred to by the administrator of the Zone (ex: RamseySIS). M O C In a Brokered Environment, this element contains the URL where all requests for this Service Provider should be re-invoked by the Connector O O 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. M Determines if the query may be sent to a data provider or if it requires the extended XQuery mechanism. M Communicates if the query has been inspected for data hiding and the results of that assessment. O If status is DISALLOWED this element optionally contains the reason. O Human readable description of the XQuery's intended behavior. M The text of the XQuery which MAY accept parameters. Usage of the CDATA designation is recommended. An empty value indicates the query is implimented wihtout XQuery or its logic is not disclosed M M The fully qualified name of the root element returned by this service. Example: http://www.sifassociation.org/datamodel/na/3.3:students C The unique ID of the XQuery Template, which is contained in the Query Request URL when this template is being utilized. "Suggested" by the Consumer issuing the create Request, or pre-set in accordance with the binding requirements of a particular SIF release. This is NOT required to be a UUID, and must be provided as the Service Identifier in every Query URL which invokes this Template. Ex: "StudentSnapshot". 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. O A short (possibly multi-sentence) description of the Zone O O Low This object contains information about privacy obligations. M Low The status value for this POD. M Low The token reference for the POD, also conveyed as the dataPrivacyMarker header. M Low The POD version number. PODs are expected to change over time. M Low The name of the party (typically the data processor) which will receive the data from the school, district or state and has entered into an agreement to process the data and respect the privacy obligations of the data. M Low The set of privacy controls, laws and obligations which apply in this POD. There may be multiple sets which apply. M Low The ID (GUID) that uniquely identifies this object. A "deleteRequest" element, which consists of multiple, "delete" object ids. Since REST conventions do not support payloads on HTTP DELETE messages, all multi-object Delete Requests are conveyed via an HTTP PUT message containing an additional HTTP Header Field value of methodOverride set to DELETE. M An HTTP Response with a status of 200 and a payload consisting of a single "createResponse" element. This includes, for each requested object successfully created, an internal status of 201 and the service-assigned refId. Any requested object that failed to be created is indicated by an error statusCode and a corresponding error payload. M An HTTP Response with a status of 200 (success). It contains a payload consisting of a single "deleteResponse" element. M An HTTP Response with a status of 200 (success) and a location corresponding to the URL of the first successfully modified object. It contains a payload consisting of a single "updateResponse" element. M Admin Directives, empowers endpoint providers to “inform” or “direct” endpoint consumers what needs to happen. This opens the possibility to prompt the resending of data, expose what objects have been updated, initiate functional services etc. Some common use-cases and details on Admin Directive functionality can be found on the respective Admin Directives section. M Timestamp when request was issued. M When should the request expire if not fulfilled. M The name of the Service. For utilities, this is fixed to one of the defined set of Utility Service Names. For objects and functions, it is defined by the Data Model. M Unique ID/Name or requested method. O O A list of e-mail addresses associated with an individual or organization. MR The email address. M This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc.. Lists phone numbers associated with an entity. MR This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc. M Phone number. Free-form, but typical Australian formats include: O Phone number extension. O Indicates whether or not the phone number is available to the public. O Preference number indicating an order in which phone numbers should be used when contacting person. Core Name Type or Name elements, primarily to allow structure to be leveraged with different Type attribute values. O A title or prefix associated with the name. If any of: Mr, Mrs, Ms, Miss, Rev, Fr, Dr, Prof, Hon, Sir, Lord, Lady - these must be as shown, otherwise free text. Note that title is not applicable to learners. C Family name. That part of the person`s name which is used to describe family, clan, tribal group, or marital association. Note that this element is required when known. However, it may not be possible to know the family name in which case you should add the available information to the FullName element. C Given name of the person. Note that this element is required if known. However, it may not be possible to know the given name in which case you should add the available information to the FullName element. O All other given or middle names, each separated with a single space character. O An indicator used to identify the naming conventions used by some predominantly non-European, ethnic or language groups and related to the display nature of a name. O The given name preferred most by the person (as written). List of Contacts associated with an entity. MR Common element used to supply information for a contact person at a school, LEA, or other institution. M O The contact person`s position title. O Role played by this contact in this instance. O Registration Details of the Contact. O Qualifications of the Contact. O Address of the contact. O List of Email elements. O List of PhoneNumber elements. M This element contains address data. O Date the address became valid. O Date the address ceases to be valid. M Address line 1. O Address line 2. O Address line 3. M The city or Suburb part of the address. C The state or province or county. O The country code. M The ZIP/postal code. A list of Address elements. MR A country code or name. This is a common element used to define the locally assigned identifier associated with an entity. The identifier for this entity as assigned by the state or province. A state or province code. Note: When dealing with countries other than Australia, state/province codes/values other than those referenced here can be used. OR . M Is this the default privacy template? O The list of applications in this contract. O A list of fingerprints. O A list zones and contexts where this POD applies. O A list of endpoints that are covered by this POD. O Namespace associated with the relevant datamodel. O Minimum data model version. O Maximum data model version. O The legal and technical requirements that are required to be met to satisfy privacy and security concerns. O The details of the contract the POD has been derived from. O Legal Requirements Container. O Technical Requirements Container. O The data controller, means the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data, see GDPR. O The data processor, means a natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller, see GDPR. O The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor. O The details of the contract the POD has been derived from. M URI associated with contract. This may be a resolvable URL or just a unique identifier. M Name associated with contract M The initial date that the contract is enforceable. O The date the contract expires and is no longer enforcable. O The version of the contract being represented by the associated elements. M List of laws covered referenced by the contract. O Who owns the intellectual property for any student under this contract. A list of parties and data sharing permissions. OR A law that applies to this contract. Information about the specific law. M The name of the law support is being included for. M A simplified representation of a law, designed to communicate its intent to any member of the public. Contains a list of the legal clauses within the contract. M A list of the legal clauses within the contract. A list of the legal clauses within the contract. OR Details of a legal clause within the contract. Details of a legal clause within the contract. O A human friendly handle for refering to the associated clause. O An exact reference within the contract to a specific clause. O The actual detailed content of the clause. O List of obligations. A List of benchmarks - where a benchmark is a set of technical or process standards to ensure the clause is met. OR A benchmark is a set of technical or process standards to ensure the clause is met. A set of technical or process standards to ensure the clause is met. O A name given to the evidence against which privacy obligations or requirements may be assessed or measured. O A unique identifier assigned to an instance of the evidence against which privacy obligations or requirements may be assessed or measured. O A description of the evidence against which privacy obligations or requirements may be assessed or measured. O A URL pointing to the evidence against which privacy obligations or requirements may be assessed or measured. A list of requirements imposed by the contract. OR A requirement imposed by the contract. A requirement imposed by the contract. O The narrative of an individual requirement imposed by the contract. O The URL pointing to the official definition of a requirment imposed by the contract. O A list of benchmarks associated with the obligation. Details of technical requirements that need to be met to achieve the POD. O A list of the data that can be accessed and any rules that specifically apply. O O The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent. O Details and requirements for data deletion. O A list of the data that can be accessed and any rules that specifically apply. O A list of clauses that specifically apply to these technical requirements. O A list of fields that can be accessed under this POD. Equivalent to a green list. The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent. O O O A list of fields that can be accessed under this POD. Equivalent to a green list. O Maximum response time, number of days, for information regarding this data. O Flag indicating that the rules surrounding this data must be ported with applicable data that is transmitted. Details and requirements for data deletion. O Flag indicating that the data must be deleted when no longer requred for the primary purpose. O If allowed, the length of time the data be retained when no longer required for the primary purpose. O The specific date should this data be removed from the systems. O Who is responsible for deletion of this data? O Maximum response time, number of days, for information regarding this data. O Flag indicating that the rules surrounding this data must be ported with applicable data that is transmitted. Who is responsible for deletion of this data? O The group responsible for ensuring the data is removed when required. O OR O O The name of the technology being utilized. O The narrative as to what the technology`s role is in providing security. O O The version at which the technology is considered sufficient to supply security for its applicable area. A list of fields that can be accessed under this POD. Equivalent to a green list. OR Details of a field that can be accessed under this POD, equivalent to an element in a green list. Details of a field that can be accessed under this POD, equivalent to an element in a green list. O The full unique path for the data field being granted access to. O The level of access being granted to the data. The data controller, means the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data, see GDPR. O The name of the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data. M URL Associated with contract O The details of the privacy contact. O The details of the individual to be contacted if there are issues in fulfilling the obligations of the contract. The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor. OR A data sub-Processors who are the bodies that process data on behalf of the Data Processor. The data processor, means a natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller, see GDPR. O The label for the vendor who will be accessing, consuming and/or providing information back to the controller. M URL Associated with contract O The details of the privacy contact. O Indicates if the processor needs to advise the controller of access requests. O The details of the person to contact for access requests. O A list or purposes for which the data may be used. O A purpose for which the data may be shared beyond its orginal uses. O The purposes for which deidentified data is able to be used (if any). O Determines whether the data may be used for marketing purposes. O The frequency at which personal information is to be updated from source systems, including deletions. O Determines if notification of those in the breach contact list is required. O Contact details for the individual/s to be notified in the event of a data breach. O Determines whether the data controller and their staff must also comply with the privacy agreement. O Determines whether the data controller and their staff must also comply with the confidentiality agreement. O A list of the data controller employee’s training requirements. O A list of the data controller employee’s password access standards. O A list of security testing required to be completed by the data controller. O List of impacted countries in or through which the data transits or is stored. Details of organisations who process data on behalf of the data processor. O The name of the natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller. M URL Associated with contract O Details of the data sub processor`s privacy contact. O The purpose for which data is supplied to the data sub processor by the data processor. List of application identifiers. OR The name of the software providing the services for a particular data source. OR An opaque marker that represents the amalgam of all underlying PODs tied to a specific DataProcessor-DataController relationship. A purposes for which deidentified data may be used. OR A purpose for which deidentified data may be used. A list of the purposes for which data is may be used. OR The purpose for which data may be used. Purposes for which the data may be shared beyond its orginal uses. OR A purpose for which the data may be shared beyond its orginal uses. OR O The name of the parameter used fo enforce the privacy condition. O The name of the parameter used to enforce the privacy condition. O The explanation of what the related privacy conditions combine to do in plain terms. O OR A Zone and/or Context related to a POD. O Identifies the collection of appropriate data providers. O Identifies the data scope within the zone. OR An endpoint covered by the POD. A type of endpoint. O The url of the endpoint. O The name of the provider of the endpoint. OR O The label of the training being given to employees to teach privacy requirements and practices. O The URL of the training being given to employees to teach privacy requirements and practices. O The label of rule set for the proceessor used to define valid passwords. O A link to an authoritative source for this standard. List of impacted countries in or through which the data transits or is stored. OR Name of a country impacted in or through which the data transits or is stored. O Name of a country impacted in or through which the data transits or is stored. O Country specific details about how the processor handles the data. OR Details of the security test required. Details of the security test required. O Type of the test. O How often does this test need to be performed? O Number of days allowed to remediate any inadequacies discovered during testing. O Determines whether the results of a security test may be made publicly known. OR O A short label meant to convey quick meaning of the machine readable expression. O A machine readable expression designed to specify one aspect of the condition for machine enforcement. The transport protocols defined in SIF. MR A specific Zone defined for this environment. O M The unique id of the Zone, and the key to the Zone element in the Zone Registry. MR O O M O M Corresponds to the value contained in the HTTPS Header Status-Code" field in which the Error Object is the payload. M Attempted operation. Ex: "Modify Student" O Indicator if the error relates to infrastructure or data. O Machine readable second code used to eliminate ambiguity. M A simple, easy to understand, compact description of the error. The primary consumer of this message is the application user. Example: "Unable to open database." O An optional error description that is more complete and technical in nature. It is to be used as a diagnostic message in trouble-shooting procedures. Example: "The 'Students' table is opened in exclusive mode by user 'ADM1' (dbm.cpp, line 300)." O O O Indicator if the error relates to infrastructure or data. O Machine readable second code used to eliminate ambiguity. M A simple, easy to understand, compact description of the error. The primary consumer of this message is the application user. Example: "Unable to open database." O An optional error description that is more complete and technical in nature. It is to be used as a diagnostic message in trouble-shooting procedures. Example: "The 'Students' table is opened in exclusive mode by user 'ADM1' (dbm.cpp, line 300)." O O OR MR M The type of this State object. O The datetime this job was created. O The datetime this job was last modified. O A descriptive message ellaborating the condition of this state, e.g. if the state is "FAILED" the stateDescription may be "Timeout occured". O MR 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. O A short (possibly multi-sentence) description of the Zone O O O O MR M The name of the Phase unique within the context of the owning job. M A collection of the states the Phase has been through, must initially contain a NOTAPPLICABLE or NOTSTARTED state. M Whether or not this phase is required for the job to complete successfully. M Access rights given to the consumer for this phase. M Access rights given to the consumer for each state. O Name of initialization phase the payload corresponds to. M Information matching the initialization phase, should result in corresponding phase having an INPROGRESS, COMPLETED, or FAILED state. O MR Individual setting M An acceptable parameter value for this query. C If enumerated value has an equivalent code, this field may be used for conversion. OR Individual setting M The name of the query parameter to be passed in. Note: Must not conflict with any other query parameter name. O A well understood type that MAY be used for parameter validation. Example: xs:unsignedInt. O Value to be supplied for this parameter if the submitter omits it. O An explanation of what this parameter represents. O Indicator as to if this parameter is required. If omitted, the parameter is assumed to be required!. O O O The minimum length for values of this parameter. If omitted, zero. May be functionally different because of other restrictions. O The maximum length for values of this parameter. If omitted, unbounded. May be functionally different because of other restrictions. MR Individual setting M If a numeric range is used, this holds the inclusive starting value. M If a numeric range is used, this holds the inclusive ending value. M Name/Value pair. O An opaque (to the SIF standard) element which contains any required Consumer authentication information. The content of this element is site-specific. For a Direct Environment which accepts Consumer Registration Requests from a mobile application, this element might contain a combination of the User ID and Password. O The version of the SIF infrastructure which the Consumer supports. O The namespace of the data payloads conveyed by this environment. Returns may be of a diffrent minor version. Utility payloads will be of the infrastructure namespace. O The transport which the Consumer expects the infrastructure to use to interoperate with it. The default is whichever transport the create request was issued on O O O The name of the company supplying this Product. M The name of the Product O The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. O HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). MR M M O M The name of the Service. For utilities, this is fixed to one of the defined set of Utility Service Names. For objects and functions, it is defined by the Data Model. M The unique identity of a context element, which is associated with a Provider of this name and type operating in a Zone with this ID. All Services with the same name in the same Zone must have different Context IDs. Only one such Service can have no Context. MR M The type of the requested Access Right O O MR There must be an InfrastructureService element present for each defined Infrastructure Service. The value of each InfrastructureService Property value subelement defines the URL location of that Infrastructure Service. O O O O O MR O True if this service is capable of honoring the "where" parameter. O True if this service is capable of honoring query by example payloads. O True if this service is capable of supporting Changes Since Queries. O True if this service is capable of responding to Paged Query Requests (both Interactive and Batch). C If Paged Queries are supported, this is the maximum number of Objects that will be returned on a Page of Query results. O C Application Vendor Identification O Adapter Vendor Identification M O URL where the related abbreviation comes from. O Namespace where the related abbreviation comes from. M Official abbreviation for the given value. O URL where the related abbreviation comes from. O Namespace where the related abbreviation comes from. M What the code represents. O Human readable explanation of what the code represents. O Human readable explanation provided by the source! O M The last action to be taken for this code item. M The date and time of the last action taken on this code item. So that only updates can be queried efficiently (where applicable). M Indicates the alias code has been deprecated or deleted, even if it no longer appears in the register. M Indicates the alias code is an official one; however the locale uses this one to represent that concept, at least in part. M Alternate abbreviation that might need to be more specific or correct. MR MR O O O M MR An Internet Media Type supported by this adaptor (for this service). M The URL to use when sending Requests to a Provider O May contain zero or more property elements containing name/value pairs describing any protocol settings required to ensure proper communication MR O O O MR Individual setting M The name of the parameter being passed in. M The value of the parameter being passed in. O The operation used to make the comparison. If not provided EQUAL is assumed. MR The request type and supported operations available for the related service as provided by the named provider. O Relay an delayed request or turn it into an immediate call. M The list of operations a request can target, such as CREATE. MR O