Appendix A: Common Types

Common and supporting types referenced in this specification are included here as a reference.

A.1 adapterFingerprintListType

adapterFingerprintListType
Figure A.1-1: adapterFingerprintListType adapterFingerprintListType adapterFingerprint
 Element/@AttributeCharDescriptionType
 adapterFingerprintListType 

 

List
 adapterFingerprintOR

An opaque marker that represents the amalgam of all underlying PODs tied to a specific DataProcessor-DataController relationship.

 
xs:normalizedString
Table A.1-1: adapterFingerprintListType

A.2 aliasesType

aliasesType
Figure A.2-1: aliasesType aliasesType alias
 Element/@AttributeCharDescriptionType
 aliasesType  List
 aliasMR aliasType
Table A.2-1: aliasesType

A.3 aliasType

aliasType
Figure A.3-1: aliasType aliasType code source namespace
 Element/@AttributeCharDescriptionType
 aliasType   
 codeM codeType
 sourceO

URL where the related abbreviation comes from.

 
uriType
 namespaceO

Namespace where the related abbreviation comes from.

 
uriType
Table A.3-1: aliasType

A.4 alternatePurposeListType

Alternate purposes for which the data may be used.

alternatePurposeListType
Figure A.4-1: alternatePurposeListType alternatePurposeListType alternatePurpose
 Element/@AttributeCharDescriptionType
 alternatePurposeListType 

Alternate purposes for which the data may be used.

 
List
 alternatePurposeOR

Alternate purpose for which the data may be used.

 
xs:normalizedString
Table A.4-1: alternatePurposeListType

A.5 appIDListType

List of application identifiers.

appIDListType
Figure A.5-1: appIDListType appIDListType appID
 Element/@AttributeCharDescriptionType
 appIDListType 

List of application identifiers.

 
List
 appIDOR

An application identifier.

 
xs:normalizedString
Table A.5-1: appIDListType

A.6 applicationInfoType

applicationInfoType
Figure A.6-1: applicationInfoType applicationInfoType applicationKey supportedInfrastructureVersion dataModelNamespace transport applicationProduct adapterProduct
 Element/@AttributeCharDescriptionType
 applicationInfoType   
 applicationKeyOnillable="false"

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.

 
xs:string
 supportedInfrastructureVersionOnillable="false"

The version of the SIF infrastructure which the Consumer supports.

 
xs:string
 dataModelNamespaceOnillable="false"

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.

 
xs:anyURI
 transportOnillable="false"

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

 
xs:string
 applicationProductOnillable="false" productIdentityType
 adapterProductOnillable="false" productIdentityType
Table A.6-1: applicationInfoType

A.7 benchmarkListType

A List of benchmarks - where a benchmark is a set of technical or process standards to ensure the clause is met.

benchmarkListType
Figure A.7-1: benchmarkListType benchmarkListType benchmark
 Element/@AttributeCharDescriptionType
 benchmarkListType 

A List of benchmarks - where a benchmark is a set of technical or process standards to ensure the clause is met.

 
List
 benchmarkOR

A benchmark is a set of technical or process standards to ensure the clause is met.

 
benchmarkType
Table A.7-1: benchmarkListType

A.8 benchmarkType

A set of technical or process standards to ensure the clause is met.

benchmarkType
Figure A.8-1: benchmarkType benchmarkType benchmarkName benchmarkId benchmarkDescription benchmarkURL
 Element/@AttributeCharDescriptionType
 benchmarkType

A set of technical or process standards to ensure the clause is met.

 
 
 benchmarkNameO

The name of the Benchmark

 
xs:normalizedString
 benchmarkIdO

The local id of the benchmark.

 
gCoreLocalIdType
 benchmarkDescriptionO

A description of what the benchmark is and how it should be applied.

 
xs:normalizedString
 benchmarkURLO

A link to any authoritative source of the benchmark.

 
xs:anyURI
Table A.8-1: benchmarkType

A.9 clauseListType

A list of the legal clauses within the contract.

clauseListType
Figure A.9-1: clauseListType clauseListType clause
 Element/@AttributeCharDescriptionType
 clauseListType 

A list of the legal clauses within the contract.

 
List
 clauseOR

Details of a legal clause within the contract.

 
clauseType
Table A.9-1: clauseListType

A.10 clauseType

Details of a legal clause within the contract.

clauseType
Figure A.10-1: clauseType clauseType clauseLabel clauseReference clauseContent obligationList
 Element/@AttributeCharDescriptionType
 clauseType

Details of a legal clause within the contract.

 
 
 clauseLabelO

The label which should include a brief description.

 
xs:normalizedString
 clauseReferenceO

The formal clause reference.

 
xs:normalizedString
 clauseContentO

The actual detailed content of the clause.

 
xs:normalizedString
 obligationListO

List of obligations.

 
obligationListType
Table A.10-1: clauseType

A.11 codeItemsType

codeItemsType
Figure A.11-1: codeItemsType codeItemsType codeItem
 Element/@AttributeCharDescriptionType
 codeItemsType  List
 codeItemMR codeItemType
Table A.11-1: codeItemsType

A.12 codeItemType

codeItemType
Figure A.12-1: codeItemType codeItemType code source namespace value description definition aliases action timestamp
 Element/@AttributeCharDescriptionType
 codeItemType   
 codeM

Official abbreviation for the given value.

 
xs:string
 sourceO

URL where the related abbreviation comes from.

 
uriType
 namespaceO

Namespace where the related abbreviation comes from.

 
uriType
 valueMnillable="true"

What the code represents.

 
xs:token
xs:minLength0
xs:maxLength128
 descriptionOnillable="false"

Human readable explanation of what the code represents.

 
xs:normalizedString
xs:minLength0
xs:maxLength1024
 definitionOnillable="false"

Human readable explanation provided by the source!

 
xs:normalizedString
xs:minLength0
xs:maxLength4096
 aliasesOnillable="false" aliasesType
 actionM

The last action to be taken for this code item.

 
values:
ADD
CHANGE
DEPRECATED
DELETE
 timestampM

The date and time of the last action taken on this code item. So that only updates can be queried efficiently (where applicable).

 
xs:dateTime
Table A.12-1: codeItemType

A.13 codeType

codeType
Figure A.13-1: codeType codeType old official value
 Element/@AttributeCharDescriptionType
 codeType   
 oldM

Indicates the alias code has been deprecated or deleted, even if it no longer appears in the register.

 
xs:boolean
 officialM

Indicates the alias code is an official one; however the locale uses this one to represent that concept, at least in part.

 
xs:boolean
 valueM

Alternate abbreviation that might need to be more specific or correct.

 
xs:string
Table A.13-1: codeType

A.14 conditionListType

conditionListType
Figure A.14-1: conditionListType conditionListType condition
 Element/@AttributeCharDescriptionType
 conditionListType 

 

List
 conditionOR

 

conditionType
Table A.14-1: conditionListType

A.15 conditionType

conditionType
Figure A.15-1: conditionType conditionType typeOfCondition conditionName conditionDescription propertyList
 Element/@AttributeCharDescriptionType
 conditionType

 

 
 typeOfConditionO

 

xs:normalizedString
 conditionNameO

 

xs:normalizedString
 conditionDescriptionO

 

xs:normalizedString
 propertyListO

 

propertyNVListType
Table A.15-1: conditionType

A.16 contractType

The details of the contract the POD has been derived from.
contractType
Figure A.16-1: contractType contractType contractURI contractName dateValidFrom dateValidTo contractVersion lawList studentDataIPRights
 Element/@AttributeCharDescriptionType
 contractTypeOThe details of the contract the POD has been derived from.  
 contractURIM

URI Associated with contract

 
xs:anyURI
 contractNameM

Name associated with contract

 
xs:normalizedString
 dateValidFromM

Date the contract is valid from.

 
xs:date
 dateValidToO

Date the contract is valid to.

 
xs:date
 contractVersionO

Version of contract that this POD applies to.

 
xs:normalizedString
 lawListM

List of laws covered referenced by the contract.

 
lawListType
 studentDataIPRightsO

Who owns the IP rights of this contract?

 
xs:normalizedString
Table A.16-1: contractType

A.17 countryImpactedListType

List of impacted countries in or through which the data transits or is stored.

countryImpactedListType
Figure A.17-1: countryImpactedListType countryImpactedListType countryImpacted
 Element/@AttributeCharDescriptionType
 countryImpactedListType 

List of impacted countries in or through which the data transits or is stored.

 
List
 countryImpactedOR

Name of a country impacted in or through which the data transits or is stored.

 
countryImpactedType
Table A.17-1: countryImpactedListType

A.18 countryImpactedType

countryImpactedType
Figure A.18-1: countryImpactedType countryImpactedType country usage
 Element/@AttributeCharDescriptionType
 countryImpactedType

 

 
 countryO

Name of a country impacted in or through which the data transits or is stored.

 
gCoreCountryType
 usageO

Details of the usage within the country, how the data is handled e.g. stored permanently, operational store, back-up, archived, etc.

 
xs:normalizedString
Table A.18-1: countryImpactedType

A.19 createsType

createsType
Figure A.19-1: createsType createsType create
 Element/@AttributeCharDescriptionType
 createsType  List
 createMR createType
Table A.19-1: createsType

A.20 createType

createType
Figure A.20-1: createType createType id advisoryId statusCode error
 Element/@AttributeCharDescriptionType
 createType   
@idO xs:token
@advisoryIdM xs:token
@statusCodeO xs:token
xs:pattern[24-5][0-9]{2}
 errorOnillable="false" errorType
Table A.20-1: createType

A.21 dataAccessType

A list of the data that can be accessed and any rules that specifically apply.

dataAccessType
Figure A.21-1: dataAccessType dataAccessType clauseList fieldList
 Element/@AttributeCharDescriptionType
 dataAccessType 

A list of the data that can be accessed and any rules that specifically apply.

 
 
 clauseListO

A list of clauses that specifically apply to these technical requirements.

 
clauseListType
 fieldListO

A list of fields that can be accessed under this POD. Equivalent to a "green list".

 
fieldListType
Table A.21-1: dataAccessType

A.22 dataControllerType

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.

dataControllerType
Figure A.22-1: dataControllerType dataControllerType dataControllerName privacyPolicyURL privacyContactList issuesNotificationContactList
 Element/@AttributeCharDescriptionType
 dataControllerType 

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.

 
 
 dataControllerNameO

Name of the data controller.

 
xs:normalizedString
 privacyPolicyURLM

URL Associated with contract

 
xs:anyURI
 privacyContactListO

The details of the privacy contact.

 
gCoreContactListType
 issuesNotificationContactListO

The details of the individual to be contacted if there are issues in fulfilling the obligations of the contract.

 
gCoreContactListType
Table A.22-1: dataControllerType

A.23 dataDeletionType

Details and requirements for data deletion.

dataDeletionType
Figure A.23-1: dataDeletionType dataDeletionType deleteData dataRetention deleteBy partyToDeleteData respondInDays requirePortability
 Element/@AttributeCharDescriptionType
 dataDeletionType 

Details and requirements for data deletion.

 
 
 deleteDataO

Must data be deleted when no longer required to the primary purpose?

 
values:
Y
N
 dataRetentionO

If allowed, how long can the data be retained for when no longer required for the primary purpose?

 
xs:integer
 deleteByO

By which specific date should this data be removed from systems?

 
xs:date
 partyToDeleteDataO

Who is responsible for deletion of this data?

 
partyToDeleteDataType
 respondInDaysO

In how many days should any request for information around this data and it's deletion be responded to?

 
xs:integer
 requirePortabilityO

Do all the rules surrounding this data need to be ported with any data that is transmeitted?

 
values:
Y
N
Table A.23-1: dataDeletionType

A.24 dataProcessorType

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.

dataProcessorType
Figure A.24-1: dataProcessorType dataProcessorType dataProcessorName privacyPolicyURL privacyContactList notifyDataControllerOnAccessRequests dataProcessorContactForAccessRequestsList purposeList alternatePurposeList deidentifiedPurposeList dataUsageMarketingAllowed personalInformationUpdatedFromSource dataBreachNotification dataBreachContactList employeesMustComplyWithAgreement employeeConfidentialityAgreement employeeTrainingList passwordEmployeeAccessStandard securityTestRequiredList countryImpactedList
 Element/@AttributeCharDescriptionType
 dataProcessorType 

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.

 
 
 dataProcessorNameO

Name of the Data Processor.

 
xs:normalizedString
 privacyPolicyURLM

URL Associated with contract

 
xs:anyURI
 privacyContactListO

The details of the privacy contact.

 
gCoreContactListType
 notifyDataControllerOnAccessRequestsO

Do we need to advise the data controller of access requests?

 
values:
Y
N
 dataProcessorContactForAccessRequestsListO

The details of the person to contact for access requests.

 
gCoreContactListType
 purposeListO

A list or purposes for which the data may be used.

 
purposeListType
 alternatePurposeListO

Alternate purposes for which the data may be used.

 
alternatePurposeListType
 deidentifiedPurposeListO

The purposes for which deidentified data is able to be used (if any).

 
deidentifiedPurposeListType
 dataUsageMarketingAllowedO

Can the data be used for marketing purposes?

 
values:
Y
N
 personalInformationUpdatedFromSourceO

The frequency at which personal information is to be updated from source systems.

 
xs:integer
 dataBreachNotificationO

In the event there is a breach event is notification of the breach contact required?

 
values:
Y
N
 dataBreachContactListO

Contact details for the individual/s to be notified in the event of a data breach.

 
gCoreContactListType
 employeesMustComplyWithAgreementO

Must employees of the data controller comply the with agreement?

 
values:
Y
N
 employeeConfidentialityAgreementO

Are employees of the data controller required to comply with a confidentiality agreement?

 
values:
Y
N
 employeeTrainingListO

A list of the data controller employee’s training requirements.

 
employeeTrainingListType
 passwordEmployeeAccessStandardO

A list of the data controller employee’s password access standards.

 
passwordEmployeeAccessStandardType
 securityTestRequiredListO

A list of security testing required to be completed by the data controller.

 
securityTestRequiredListType
 countryImpactedListO

List of impacted countries in or through which the data transits or is stored.

 
countryImpactedListType
Table A.24-1: dataProcessorType

A.25 dataSubjectType

The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent.

dataSubjectType
Figure A.25-1: dataSubjectType dataSubjectType clauseList benchmarkList fieldList respondInDays requirePortability
 Element/@AttributeCharDescriptionType
 dataSubjectType 

The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent.

 
 
 clauseListO

 

clauseListType
 benchmarkListO

 

benchmarkListType
 fieldListO

A list of fields that can be accessed under this POD. Equivalent to a "green list".

 
fieldListType
 respondInDaysO

n how many days should any request for information around this data subject be responded to?

 
xs:integer
 requirePortabilityO

Do all the rules surrounding this data need to be ported with any data that is transmeitted?

 
values:
Y
N
Table A.25-1: dataSubjectType

A.26 dataSubProcessorListType

The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor.

dataSubProcessorListType
Figure A.26-1: dataSubProcessorListType dataSubProcessorListType dataSubProcessor
 Element/@AttributeCharDescriptionType
 dataSubProcessorListType 

The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor.

 
List
 dataSubProcessorOR

A data sub-Processors who are the bodies that process data on behalf of the Data Processor.

 
dataSubProcessorType
Table A.26-1: dataSubProcessorListType

A.27 dataSubProcessorType

Details of organisations who process data on behalf of the data processor.

dataSubProcessorType
Figure A.27-1: dataSubProcessorType dataSubProcessorType subProcessorName privacyPolicyURL privacyContactList purposeList
 Element/@AttributeCharDescriptionType
 dataSubProcessorType 

Details of organisations who process data on behalf of the data processor.

 
 
 subProcessorNameO

Name of the sub processor.

 
xs:normalizedString
 privacyPolicyURLM

URL Associated with contract

 
xs:anyURI
 privacyContactListO

Details of the data sub processor's privacy contact.

 
gCoreContactListType
 purposeListO

The purpose for which data is supplied to the data sub processor by the data processor.

 
purposeListType
Table A.27-1: dataSubProcessorType

A.28 defaultZoneType

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.

defaultZoneType
Figure A.28-1: defaultZoneType defaultZoneType id description properties
 Element/@AttributeCharDescriptionType
 defaultZoneType 

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.

 
 
@idO xs:token
 descriptionOnillable="false"

A short (possibly multi-sentence) description of the Zone

 
xs:normalizedString
 propertiesOnillable="false" propertiesType
Table A.28-1: defaultZoneType

A.29 DefinedProtocolsType

The transport protocols defined in SIF.
DefinedProtocolsType
Figure A.29-1: DefinedProtocolsType DefinedProtocolsType
 Element/@AttributeCharDescriptionType
 DefinedProtocolsType The transport protocols defined in SIF. values:
HTTPS
HTTP
Table A.29-1: DefinedProtocolsType

A.30 deidentifiedPurposeListType

The purposes for which deidentified data is able to be used (if any).

deidentifiedPurposeListType
Figure A.30-1: deidentifiedPurposeListType deidentifiedPurposeListType deidentifiedPurpose
 Element/@AttributeCharDescriptionType
 deidentifiedPurposeListType 

The purposes for which deidentified data is able to be used (if any).

 
List
 deidentifiedPurposeOR

The purpose for which deidentified data is able to be used (if any).

 
xs:normalizedString
Table A.30-1: deidentifiedPurposeListType

A.31 deleteIdCollectionType

deleteIdCollectionType
Figure A.31-1: deleteIdCollectionType deleteIdCollectionType delete
 Element/@AttributeCharDescriptionType
 deleteIdCollectionType  List
 deleteMR deleteIdType
Table A.31-1: deleteIdCollectionType

A.32 deleteIdType

deleteIdType
Figure A.32-1: deleteIdType deleteIdType id
 Element/@AttributeCharDescriptionType
 deleteIdType  EMPTY
@idM xs:token
Table A.32-1: deleteIdType

A.33 deleteStatusCollectionType

deleteStatusCollectionType
Figure A.33-1: deleteStatusCollectionType deleteStatusCollectionType delete
 Element/@AttributeCharDescriptionType
 deleteStatusCollectionType  List
 deleteMR deleteStatusType
Table A.33-1: deleteStatusCollectionType

A.34 deleteStatusType

deleteStatusType
Figure A.34-1: deleteStatusType deleteStatusType id statusCode error
 Element/@AttributeCharDescriptionType
 deleteStatusType   
@idO xs:token
@statusCodeO xs:token
xs:pattern[24-5][0-9]{2}
 errorOnillable="false" errorType
Table A.34-1: deleteStatusType

A.35 employeeTrainingListType

employeeTrainingListType
Figure A.35-1: employeeTrainingListType employeeTrainingListType employeeTraining
 Element/@AttributeCharDescriptionType
 employeeTrainingListType 

 

List
 employeeTrainingOR

 

employeeTrainingType
Table A.35-1: employeeTrainingListType

A.36 employeeTrainingType

employeeTrainingType
Figure A.36-1: employeeTrainingType employeeTrainingType trainingName trainingURL
 Element/@AttributeCharDescriptionType
 employeeTrainingType

 

 
 trainingNameO

 

xs:normalizedString
 trainingURLO

 

xs:anyURI
Table A.36-1: employeeTrainingType

A.37 endpointListType

endpointListType
Figure A.37-1: endpointListType endpointListType endpoint
 Element/@AttributeCharDescriptionType
 endpointListType 

 

List
 endpointOR

An endpoint covered by the POD.

 
endpointType
Table A.37-1: endpointListType

A.38 endpointType

A type of endpoint.

endpointType
Figure A.38-1: endpointType endpointType endpointURL endpointProviderName
 Element/@AttributeCharDescriptionType
 endpointType

A type of endpoint.

 
 
 endpointURLO

The url of the endpoint.

 
xs:anyURI
 endpointProviderNameO

The name of the provider of the endpoint.

 
xs:normalizedString
Table A.38-1: endpointType

A.39 enumerationsType

enumerationsType
Figure A.39-1: enumerationsType enumerationsType enumeration
 Element/@AttributeCharDescriptionType
 enumerationsType  List
 enumerationMR

Individual setting

 
enumerationType
Table A.39-1: enumerationsType

A.40 enumerationType

enumerationType
Figure A.40-1: enumerationType enumerationType value code
 Element/@AttributeCharDescriptionType
 enumerationType   
 valueM

An acceptable parameter value for this query.

 
xs:token
 codeCnillable="false"

If enumerated value has an equivalent code, this field may be used for conversion.

 
xs:token
Table A.40-1: enumerationType

A.41 environmentTypeType

environmentTypeType
Figure A.41-1: environmentTypeType environmentTypeType
 Element/@AttributeCharDescriptionType
 environmentTypeTypeO values:
DIRECT
BROKERED
Table A.41-1: environmentTypeType

A.42 ExtendedContentType

Allows for any mixed XML in an element.
ExtendedContentType
Figure A.42-1: ExtendedContentType ExtendedContentType
 Element/@AttributeCharDescriptionType
 ExtendedContentType Allows for any mixed XML in an element. 
<xs:complexContent mixed="true"> <xs:restriction base="xs:anyType"> <xs:sequence> <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:restriction> </xs:complexContent>
Table A.42-1: ExtendedContentType

A.43 fieldListType

A list of fields that can be accessed under this POD. Equivalent to a "green list".

fieldListType
Figure A.43-1: fieldListType fieldListType field
 Element/@AttributeCharDescriptionType
 fieldListType 

A list of fields that can be accessed under this POD. Equivalent to a "green list".

 
List
 fieldOR

Details of a field that can be accessed under this POD, equivalent to an element in a "green list".

 
fieldType
Table A.43-1: fieldListType

A.44 fieldType

Details of a field that can be accessed under this POD, equivalent to an element in a "green list".

fieldType
Figure A.44-1: fieldType fieldType fieldName controlrights
 Element/@AttributeCharDescriptionType
 fieldType

Details of a field that can be accessed under this POD, equivalent to an element in a "green list".

 
 
 fieldNameO

Name of the "green listed field"

 
xs:normalizedString
 controlrightsO

What are the control rights around this "green listed field"?

 
values:
R
RW
Table A.44-1: fieldType

A.45 gCoreAddressListType

A list of Address elements.

gCoreAddressListType
Figure A.45-1: gCoreAddressListType gCoreAddressListType address
 Element/@AttributeCharDescriptionType
 gCoreAddressListType 

A list of Address elements.

 
List
 addressMR Extension of gCoreAddressType
Table A.45-1: gCoreAddressListType
{"sample": " 1 IBM Plaza Suite 2000 Plaza Square Chicago IL USA 60611 " }
<addressList> <address> <line1>1 IBM Plaza</line1> <line2>Suite 2000</line2> <line3>Plaza Square</line3> <city>Chicago</city> <stateProvince>IL</stateProvince> <country>USA</country> <postalCode>60611</postalCode> </address> </addressList>
Example A.45-1: gCoreAddressList Example

A.46 gCoreAddressType

This element contains address data

gCoreAddressType
Figure A.46-1: gCoreAddressType gCoreAddressType effectiveFromDate effectiveToDate line1 line2 line3 city stateProvince country postalCode
 Element/@AttributeCharDescriptionType
 gCoreAddressTypeM

This element contains address data.

 
 
 effectiveFromDateO

Date the address became active.

 
xs:date
 effectiveToDateO

Date the address ceases to be active.

 
xs:date
 line1M

Address line 1.

 
xs:normalizedString
 line2O

Address line 2.

 
xs:normalizedString
 line3O

Address line 3.

 
xs:normalizedString
 cityM

The city or Suburb part of the address.

 
xs:normalizedString
 stateProvinceC

The state or province or county.

 
gCoreStateProvinceType
 countryO

The country code.

 
gCoreCountryType
 postalCodeM

The ZIP/postal code.

 
xs:normalizedString
Table A.46-1: gCoreAddressType
{"sample": " 1 IBM Plaza Suite 2000 Plaza Square Chicago WA USA 60611 " }
<address> <line1>1 IBM Plaza</line1> <line2>Suite 2000</line2> <line3>Plaza Square</line3> <city>Chicago</city> <stateProvince>WA</stateProvince> <country>USA</country> <postalCode>60611</postalCode> </address>
Example A.46-1: gCoreAddress Example

A.47 gCoreContactInfoType

Common element used to supply information for a contact person at a school, LEA, or other institution.

gCoreContactInfoType
Figure A.47-1: gCoreContactInfoType gCoreContactInfoType name positionTitle role registrationDetails qualifications address emailList phoneNumberList
 Element/@AttributeCharDescriptionType
 gCoreContactInfoType 

Common element used to supply information for a contact person at a school, LEA, or other institution.

 
 
 nameM

 

gCoreNameType
 positionTitleO

The contact person's position title.

Examples
Superintendent

xs:normalizedString
 roleO

Role played by this contact in this instance.

Examples
Report Contact
Primary Contact
Alternate Contact

xs:normalizedString
 registrationDetailsORegistration Details of the Contact. xs:normalizedString
 qualificationsOQualifications of the Contact. xs:normalizedString
 addressO

Address of the contact.

 
gCoreAddressType
 emailListO

List of Email elements.

 
gCoreEmailListType
 phoneNumberListO

List of PhoneNumber elements.

 
gCorePhoneNumberListType
Table A.47-1: gCoreContactInfoType
{"sample": " Woodall Charles William Superintendent drseuss@whoville.k12.state.us (02) 9555-0102 " }
<ContactInfo> <name> <familyName>Woodall</familyName> <givenName>Charles</givenName> <otherGivenNames>William</otherGivenNames> </name> <positionTitle>Superintendent</positionTitle> <emailList> <email>drseuss@whoville.k12.state.us</email> </emailList> <phoneNumberList> <phoneNumber> <number>(02) 9555-0102</number> </phoneNumber> </phoneNumberList> </ContactInfo>
Example A.47-1: gCoreContactInfo

A.48 gCoreContactListType

List of Contacts associated with an entity.

gCoreContactListType
Figure A.48-1: gCoreContactListType gCoreContactListType contact
 Element/@AttributeCharDescriptionType
 gCoreContactListType 

List of Contacts associated with an entity.

 
List
 contactMR gCoreContactInfoType
Table A.48-1: gCoreContactListType
{"sample": " Woodall Charles William Superintendent drseuss@whoville.k12.state.us (02) 9555-0102 " }
<contactList> <contact> <name> <familyName>Woodall</familyName> <givenName>Charles</givenName> <otherGivenNames>William</otherGivenNames> </name> <positionTitle>Superintendent</positionTitle> <emailList> <email>drseuss@whoville.k12.state.us</email> </emailList> <phoneNumberList> <phoneNumber> <number>(02) 9555-0102</number> </phoneNumber> </phoneNumberList> </contact> </contactList>
Example A.48-1: gCoreContactList

A.49 gCoreCountryType

A country code or name.

gCoreCountryType
Figure A.49-1: gCoreCountryType gCoreCountryType
 Element/@AttributeCharDescriptionType
 gCoreCountryType 

A country code or name.

 
xs:normalizedString
Table A.49-1: gCoreCountryType
{"sample": "Australia" }
<country>Australia</country>
Example A.49-1: gCoreCountryType

A.50 gCoreEmailListType

A list of e-mail addresses associated with an individual or organization.

gCoreEmailListType
Figure A.50-1: gCoreEmailListType gCoreEmailListType email
 Element/@AttributeCharDescriptionType
 gCoreEmailListType 

A list of e-mail addresses associated with an individual or organization.

 
List
 emailMR gCoreEmailType
Table A.50-1: gCoreEmailListType
{"sample": " contact@sifinfo.org info@sifinfo.org " }
<emailList> <email>contact@sifinfo.org</email> <email>info@sifinfo.org</email> </emailList>
Example A.50-1: gCoreEmailListType

A.51 gCoreEmailType

This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc..

gCoreEmailType
Figure A.51-1: gCoreEmailType gCoreEmailType
 Element/@AttributeCharDescriptionType
 gCoreEmailTypeM

This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc..

 
xs:normalizedString
Table A.51-1: gCoreEmailType
{"sample": "contact@sifinfo.org" }
<email>contact@sifinfo.org</email>
Example A.51-1: gCoreEmailType

A.52 gCoreGenderType

gCoreGenderType
Figure A.52-1: gCoreGenderType gCoreGenderType
 Element/@AttributeCharDescriptionType
 gCoreGenderType 

 

values:
M
Male
F
Female
X
Non-binary/Intersex
U
Unknown/Not-defined
Table A.52-1: gCoreGenderType

A.53 gCoreLocalIdType

This is a common element used to define the locally assigned identifier associated with an entity.

gCoreLocalIdType
Figure A.53-1: gCoreLocalIdType gCoreLocalIdType
 Element/@AttributeCharDescriptionType
 gCoreLocalIdType 

This is a common element used to define the locally assigned identifier associated with an entity.

 
xs:normalizedString
Table A.53-1: gCoreLocalIdType
{"sample": "123321A" }
<localId>123321A</localId>
Example A.53-1: gCoreLocalId Example

A.54 gCoreNameType

Core Name Type or Name elements, primarily to allow structure to be leveraged with different Type attribute values.

gCoreNameType
Figure A.54-1: gCoreNameType gCoreNameType title familyName givenName otherGivenNames familyNameFirst preferredName
 Element/@AttributeCharDescriptionType
 gCoreNameType 

Core Name Type or Name elements, primarily to allow structure to be leveraged with different Type attribute values.

 
 
 titleO

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.

 
xs:normalizedString
 familyNameC

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.

 
xs:normalizedString
 givenNameC

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.

 
xs:normalizedString
 otherGivenNamesO

All other given or middle names, each separated with a single space character.

 
xs:normalizedString
 familyNameFirstO

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.

 
values:
Y
N
 preferredNameO

The given name preferred most by the person (as written).

 
xs:normalizedString
Table A.54-1: gCoreNameType
{"sample": " Wesson Melanie Joan N Mel Wesson " }
<name> <familyName>Wesson</familyName> <givenName>Melanie</givenName> <otherGivenNames>Joan</otherGivenNames> <familyNameFirst>N</familyNameFirst> <preferredName>Mel Wesson</preferredName> </name>
Example A.54-1: gCoreName

A.55 gCorePhoneNumberListType

Lists phone numbers associated with an entity.

gCorePhoneNumberListType
Figure A.55-1: gCorePhoneNumberListType gCorePhoneNumberListType phoneNumber
 Element/@AttributeCharDescriptionType
 gCorePhoneNumberListType 

Lists phone numbers associated with an entity.

 
List
 phoneNumberMR gCorePhoneNumberType
Table A.55-1: gCorePhoneNumberListType
{"sample": " (03) 9543 2000 " }
<phoneNumberList> <phoneNumber> <number>(03) 9543 2000</number> </phoneNumber> </phoneNumberList>
Example A.55-1: gCorePhoneNumberList

A.56 gCorePhoneNumberType

This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.

gCorePhoneNumberType
Figure A.56-1: gCorePhoneNumberType gCorePhoneNumberType number extension listedStatus preference
 Element/@AttributeCharDescriptionType
 gCorePhoneNumberType 

This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.

 
 
 numberM

Phone number. Free-form, but typical Australian formats include:

  • (###) ####-####
  • ####-####
  • +##### ### ###
 
xs:normalizedString
 extensionO

Phone number extension.

 
xs:normalizedString
 listedStatusO

Indicates whether or not the phone number is available to the public.

 
values:
Y
N
 preferenceO

Preference number indicating an order in which phone numbers should be used when contacting person.

 
xs:unsignedInt
Table A.56-1: gCorePhoneNumberType
{"sample": " (03) 9543 2000 245 1 " }
<phoneNumber> <number>(03) 9543 2000</number> <extension>245</extension> <preference>1</preference> </phoneNumber>
Example A.56-1: gCorePhoneNumber

A.57 gCoreStateProvinceIdType

The identifier for this entity as assigned by the state or province.

gCoreStateProvinceIdType
Figure A.57-1: gCoreStateProvinceIdType gCoreStateProvinceIdType
 Element/@AttributeCharDescriptionType
 gCoreStateProvinceIdType 

The identifier for this entity as assigned by the state or province.

 
xs:normalizedString
Table A.57-1: gCoreStateProvinceIdType

A.58 gCoreStateProvinceType

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.

gCoreStateProvinceType
Figure A.58-1: gCoreStateProvinceType gCoreStateProvinceType
 Element/@AttributeCharDescriptionType
 gCoreStateProvinceType 

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.

 
xs:normalizedString
Table A.58-1: gCoreStateProvinceType
{"sample": "ACT" }
<stateProvince>ACT</stateProvince>
Example A.58-1: gCoreStateProvinceType

A.59 infrastructureServiceNamesType

infrastructureServiceNamesType
Figure A.59-1: infrastructureServiceNamesType infrastructureServiceNamesType
 Element/@AttributeCharDescriptionType
 infrastructureServiceNamesTypeO values:
environment
provisionRequests
requestsConnector
eventsConnector
queues
subscriptions
servicesConnector
Table A.59-1: infrastructureServiceNamesType

A.60 infrastructureServicesType

infrastructureServicesType
Figure A.60-1: infrastructureServicesType infrastructureServicesType infrastructureService
 Element/@AttributeCharDescriptionType
 infrastructureServicesType  List
 infrastructureServiceMRminOccurs="2"

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.

 
infrastructureServiceType
Table A.60-1: infrastructureServicesType

A.61 infrastructureServiceType

infrastructureServiceType
Figure A.61-1: infrastructureServiceType infrastructureServiceType name
 Element/@AttributeCharDescriptionType
 infrastructureServiceType  xs:normalizedString
@nameO infrastructureServiceNamesType
values:
environment
provisionRequests
requestsConnector
eventsConnector
queues
subscriptions
servicesConnector
Table A.61-1: infrastructureServiceType

A.62 initializationType

initializationType
Figure A.62-1: initializationType initializationType phaseName payload
 Element/@AttributeCharDescriptionType
 initializationType   
 phaseNameOnillable="false"

Name of initialization phase the payload corresponds to.

 
xs:token
 payloadM

Information matching the initialization phase, should result in corresponding phase having an INPROGRESS, COMPLETED, or FAILED state.

 
xs:anyType
Table A.62-1: initializationType

A.63 jobStateType

jobStateType
Figure A.63-1: jobStateType jobStateType
 Element/@AttributeCharDescriptionType
 jobStateTypeO values:
NOTSTARTED
INPROGRESS
COMPLETED
FAILED
Table A.63-1: jobStateType

A.64 lawListType

A list of parties and data sharing permissions.

lawListType
Figure A.64-1: lawListType lawListType law
 Element/@AttributeCharDescriptionType
 lawListType 

A list of parties and data sharing permissions.

 
List
 lawOR

A law that applies to this contract.

 
lawType
Table A.64-1: lawListType

A.65 lawType

Information about the specific law.

lawType
Figure A.65-1: lawType lawType lawName lawDescription
 Element/@AttributeCharDescriptionType
 lawType

Information about the specific law.

 
 
 lawNameM

Common name for this law.

 
xs:normalizedString
 lawDescriptionM

Details of the law.

 
xs:normalizedString
Table A.65-1: lawType

A.66 legalRequirementsType

Contains a list of the legal clauses within the contract.

legalRequirementsType
Figure A.66-1: legalRequirementsType legalRequirementsType clauseList
 Element/@AttributeCharDescriptionType
 legalRequirementsType 

Contains a list of the legal clauses within the contract.

 
 
 clauseListM

A list of the legal clauses within the contract.

 
clauseListType
Table A.66-1: legalRequirementsType

A.67 mediaTypesType

mediaTypesType
Figure A.67-1: mediaTypesType mediaTypesType mediaType
 Element/@AttributeCharDescriptionType
 mediaTypesType  List
 mediaTypeMR

An Internet Media Type supported by this adaptor (for this service).

 
xs:token
Table A.67-1: mediaTypesType

A.68 messageTypeType

messageTypeType
Figure A.68-1: messageTypeType messageTypeType
 Element/@AttributeCharDescriptionType
 messageTypeTypeO values:
EVENT
REQUEST
Table A.68-1: messageTypeType

A.69 methodParametersType

methodParametersType
Figure A.69-1: methodParametersType methodParametersType methodParameter
 Element/@AttributeCharDescriptionType
 methodParametersType  List
 methodParameterMR

Individual setting

 
methodParameterType
Table A.69-1: methodParametersType

A.70 methodParameterType

methodParameterType
Figure A.70-1: methodParameterType methodParameterType paramName paramValue comparisonType
 Element/@AttributeCharDescriptionType
 methodParameterType   
 paramNameM

The name of the parameter being passed in.

 
xs:token
 paramValueM

The value of the parameter being passed in.

 
xs:normalizedString
 comparisonTypeOnillable="false"

The operation used to make the comparison. If not provided EQUAL is assumed.

 
xs:token
Table A.70-1: methodParameterType

A.71 obligationListType

A list of requirements imposed by the contract.

obligationListType
Figure A.71-1: obligationListType obligationListType obligation
 Element/@AttributeCharDescriptionType
 obligationListType 

A list of requirements imposed by the contract.

 
List
 obligationOR

A requirement imposed by the contract.

 
obligationType
Table A.71-1: obligationListType

A.72 obligationType

A requirement imposed by the contract.

obligationType
Figure A.72-1: obligationType obligationType obligationDescription obligationURL benchmarkList
 Element/@AttributeCharDescriptionType
 obligationType

A requirement imposed by the contract.

 
 
 obligationDescriptionO

A description of the requirment imposed by the contract.

 
xs:normalizedString
 obligationURLO

A link to any authoritative source of the obligation.

 
xs:anyURI
 benchmarkListO

A list of benchmarks associated with the obligation.

 
benchmarkListType
Table A.72-1: obligationType

A.73 operationsType

operationsType
Figure A.73-1: operationsType operationsType operation
 Element/@AttributeCharDescriptionType
 operationsType  List
 operationMR operationType
values:
QUERY
CREATE
UPDATE
DELETE
Table A.73-1: operationsType

A.74 operationType

operationType
Figure A.74-1: operationType operationType
 Element/@AttributeCharDescriptionType
 operationType  values:
QUERY
CREATE
UPDATE
DELETE
Table A.74-1: operationType

A.75 parametersType

parametersType
Figure A.75-1: parametersType parametersType parameter
 Element/@AttributeCharDescriptionType
 parametersType  List
 parameterOR

Individual setting

 
parameterType
Table A.75-1: parametersType

A.76 parameterType

parameterType
Figure A.76-1: parameterType parameterType name type default description required enumerations range minLength maxLength
 Element/@AttributeCharDescriptionType
 parameterType   
 nameM

The name of the query parameter to be passed in. Note: Must not conflict with any other query parameter name.

 
xs:token
 typeOnillable="false"

A well understood type that MAY be used for parameter validation. Example: xs:unsignedInt.

 
xs:token
 defaultOnillable="false"

Value to be supplied for this parameter if the submitter omits it.

 
xs:token
 descriptionOnillable="false"

An explanation of what this parameter represents.

 
xs:normalizedString
xs:minLength0
xs:maxLength1024
 requiredOnillable="false"

Indicator as to if this parameter is required. If omitted, the parameter is assumed to be required!.

 
xs:boolean
 enumerationsOnillable="false"

 

enumerationsType
 rangeOnillable="false" rangeType
 minLengthOnillable="false"

The minimum length for values of this parameter. If omitted, zero. May be functionally different because of other restrictions.

 
xs:unsignedInt
 maxLengthOnillable="false"

The maximum length for values of this parameter. If omitted, unbounded. May be functionally different because of other restrictions.

 
xs:unsignedInt
Table A.76-1: parameterType

A.77 partyToDeleteDataType

Who is responsible for deletion of this data?

partyToDeleteDataType
Figure A.77-1: partyToDeleteDataType partyToDeleteDataType organisation deletecontactInfo
 Element/@AttributeCharDescriptionType
 partyToDeleteDataType 

Who is responsible for deletion of this data?

 
 
 organisationO

 

gCoreLocalIdType
 deletecontactInfoO

 

gCoreContactInfoType
Table A.77-1: partyToDeleteDataType

A.78 passwordEmployeeAccessStandardType

passwordEmployeeAccessStandardType
Figure A.78-1: passwordEmployeeAccessStandardType passwordEmployeeAccessStandardType standardName standardURL
 Element/@AttributeCharDescriptionType
 passwordEmployeeAccessStandardType

 

 
 standardNameO

Name of the standard used for access.

 
xs:normalizedString
 standardURLO

A link to an authoritative source for this standard.

 
xs:anyURI
Table A.78-1: passwordEmployeeAccessStandardType

A.79 phaseCollectionType

phaseCollectionType
Figure A.79-1: phaseCollectionType phaseCollectionType phase
 Element/@AttributeCharDescriptionType
 phaseCollectionType  List
 phaseMR phaseType
Table A.79-1: phaseCollectionType

A.80 phaseStateType

phaseStateType
Figure A.80-1: phaseStateType phaseStateType
 Element/@AttributeCharDescriptionType
 phaseStateTypeO values:
NOTAPPLICABLE
NOTSTARTED
PENDING
SKIPPED
INPROGRESS
COMPLETED
FAILED
Table A.80-1: phaseStateType

A.81 phaseType

phaseType
Figure A.81-1: phaseType phaseType name states required rights statesRights
 Element/@AttributeCharDescriptionType
 phaseType   
 nameM

The name of the Phase unique within the context of the owning job.

 
xs:token
 statesM

A collection of the states the Phase has been through, must initially contain a NOTAPPLICABLE or NOTSTARTED state.

 
stateCollectionType
 requiredM

Whether or not this phase is required for the job to complete successfully.

 
xs:boolean
 rightsM

Access rights given to the consumer for this phase.

 
rightsType
 statesRightsM

Access rights given to the consumer for each state.

 
rightsType
Table A.81-1: phaseType

A.82 privacyListType

privacyListType
Figure A.82-1: privacyListType privacyListType privacy
 Element/@AttributeCharDescriptionType
 privacyListType 

 

List
 privacyOR

 

privacyType
Table A.82-1: privacyListType

A.83 privacyObligationsDocumentType

privacyObligationsDocumentType
Figure A.83-1: privacyObligationsDocumentType privacyObligationsDocumentType contract legalRequirements technicalRequirements dataController dataProcessor dataSubProcessorList
 Element/@AttributeCharDescriptionType
 privacyObligationsDocumentType

 

 
 contractO

The details of the contract the POD has been derived from.

 
contractType
 legalRequirementsO

Legal Requirements Container.

 
legalRequirementsType
 technicalRequirementsO

Technical Requirements Container.

 
technicalRequirementsType
 dataControllerO

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.

 
dataControllerType
 dataProcessorO

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.

 
dataProcessorType
 dataSubProcessorListO

The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor.

 
dataSubProcessorListType
Table A.83-1: privacyObligationsDocumentType

A.84 privacyType

.

privacyType
Figure A.84-1: privacyType privacyType default appIDList adapterFingerprintList zoneContextList endpointList dataModelNamespace dataModelVersionMin dataModelVersionMax privacyObligationsDocument
 Element/@AttributeCharDescriptionType
 privacyType

.

 
 
 defaultM

Is this the default privacy template?

 
values:
Y
N
 appIDListO

The list of applications in this contract.

 
appIDListType
 adapterFingerprintListO

A list of fingerprints.

 
adapterFingerprintListType
 zoneContextListO

A list zones and contexts where this POD applies.

 
zoneContextListType
 endpointListO

A list of endpoints that are covered by this POD.

 
endpointListType
 dataModelNamespaceO

Namespace associated with the relevant datamodel.

 
xs:anyURI
 dataModelVersionMinO

Minimum data model version.

 
xs:normalizedString
 dataModelVersionMaxO

Maximum data model version.

 
xs:normalizedString
 privacyObligationsDocumentO

The legal and technical requirements that are required to be met to satisfy privacy and security concerns.

 
privacyObligationsDocumentType
Table A.84-1: privacyType

A.85 productIdentityType

productIdentityType
Figure A.85-1: productIdentityType productIdentityType vendorName productName productVersion iconURI
 Element/@AttributeCharDescriptionType
 productIdentityType   
 vendorNameOnillable="false"

The name of the company supplying this Product.

 
xs:string
 productNameM

The name of the Product

 
xs:string
 productVersionOnillable="false"

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.

 
xs:string
 iconURIOnillable="false"

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).

 
xs:anyURI
Table A.85-1: productIdentityType

A.86 propertiesType

propertiesType
Figure A.86-1: propertiesType propertiesType property
 Element/@AttributeCharDescriptionType
 propertiesType  List
 propertyMR

Individual setting

 
propertyType
Table A.86-1: propertiesType

A.87 propertyNVListType

propertyNVListType
Figure A.87-1: propertyNVListType propertyNVListType property
 Element/@AttributeCharDescriptionType
 propertyNVListType 

 

List
 propertyOR

 

propertyNVType
Table A.87-1: propertyNVListType

A.88 propertyNVType

propertyNVType
Figure A.88-1: propertyNVType propertyNVType propertyName propertyValue
 Element/@AttributeCharDescriptionType
 propertyNVType

 

 
 propertyNameO

 

xs:normalizedString
 propertyValueO

 

xs:normalizedString
Table A.88-1: propertyNVType

A.89 propertyType

propertyType
Figure A.89-1: propertyType propertyType name
 Element/@AttributeCharDescriptionType
 propertyType  xs:normalizedString
@nameM

Name/Value pair.

 
xs:string
Table A.89-1: propertyType

A.90 protocolType

protocolType
Figure A.90-1: protocolType protocolType location properties
 Element/@AttributeCharDescriptionType
 protocolType   
 locationM

The URL to use when sending Requests to a Provider

 
xs:anyURI
 propertiesO

May contain zero or more property elements containing name/value pairs describing any protocol settings required to ensure proper communication

 
propertiesType
Table A.90-1: protocolType

A.91 provisionedZonesType

provisionedZonesType
Figure A.91-1: provisionedZonesType provisionedZonesType provisionedZone
 Element/@AttributeCharDescriptionType
 provisionedZonesType  List
 provisionedZoneMR

A specific Zone defined for this environment.

 
provisionedZoneType
Table A.91-1: provisionedZonesType
{"sample": " UNSUPPORTED APPROVED UNSUPPORTED UNSUPPORTED REJECTED APPROVED SUPPORTED SUPPORTED REJECTED APPROVED REJECTED " }
<provisionedZones> <provisionedZone id="environment-global"> <services> <service type="UTILITY" name="alerts" contextId="DEFAULT"> <rights> <right type="QUERY">UNSUPPORTED</right> <right type="CREATE">APPROVED</right> <right type="UPDATE">UNSUPPORTED</right> <right type="DELETE">UNSUPPORTED</right> <right type="SUBSCRIBE">REJECTED</right> </rights> </service> </services> </provisionedZone> <provisionedZone id="SuffolkMiddleSchool"> <services> <service type="OBJECT" name="students" contextId="DEFAULT"> <rights> <right type="QUERY">APPROVED</right> <right type="CREATE">SUPPORTED</right> <right type="UPDATE">SUPPORTED</right> <right type="DELETE">REJECTED</right> <right type="SUBSCRIBE">APPROVED</right> <right type="PROVIDE">REJECTED</right> </rights> </service> </services> </provisionedZone> </provisionedZones>
Example A.91-1: provisionedZones

A.92 provisionedZoneType

provisionedZoneType
Figure A.92-1: provisionedZoneType provisionedZoneType id services
 Element/@AttributeCharDescriptionType
 provisionedZoneType   
@idM

The unique id of the Zone, and the key to the Zone element in the Zone Registry.

 
xs:string
 servicesOnillable="false" servicesType
Table A.92-1: provisionedZoneType

A.93 purposeListType

A list of the purposes for which data is may be used.

purposeListType
Figure A.93-1: purposeListType purposeListType purpose
 Element/@AttributeCharDescriptionType
 purposeListType 

A list of the purposes for which data is may be used.

 
List
 purposeOR

The purpose for which data may be used.

 
xs:normalizedString
Table A.93-1: purposeListType

A.94 querySupportType

querySupportType
Figure A.94-1: querySupportType querySupportType dynamicQuery queryByExample changesSinceMarker paged maxPageSize totalCount applicationProduct adapterProduct
 Element/@AttributeCharDescriptionType
 querySupportType   
 dynamicQueryOnillable="false"

True if this service is capable of honoring the "where" parameter.

 
xs:boolean
 queryByExampleOnillable="false"

True if this service is capable of honoring query by example payloads.

 
xs:boolean
 changesSinceMarkerOnillable="false"

True if this service is capable of supporting Changes Since Queries.

 
xs:boolean
 pagedOnillable="false"

True if this service is capable of responding to Paged Query Requests (both Interactive and Batch).

 
xs:boolean
 maxPageSizeCnillable="false"

If Paged Queries are supported, this is the maximum number of Objects that will be returned on a Page of Query results.

 
xs:unsignedInt
 totalCountOnillable="false" xs:boolean
 applicationProductCnillable="false"

Application Vendor Identification

 
productIdentityType
 adapterProductOnillable="false"

Adapter Vendor Identification

 
productIdentityType
Table A.94-1: querySupportType

A.95 rangeType

rangeType
Figure A.95-1: rangeType rangeType start end
 Element/@AttributeCharDescriptionType
 rangeType   
 startM

If a numeric range is used, this holds the inclusive starting value.

 
xs:long
 endM

If a numeric range is used, this holds the inclusive ending value.

 
xs:long
Table A.95-1: rangeType

A.96 requestTypeValueType

requestTypeValueType
Figure A.96-1: requestTypeValueType requestTypeValueType
 Element/@AttributeCharDescriptionType
 requestTypeValueType  values:
IMMEDIATE
DELAYED
Table A.96-1: requestTypeValueType

A.97 rightsType

rightsType
Figure A.97-1: rightsType rightsType right
 Element/@AttributeCharDescriptionType
 rightsType  List
 rightMR rightType
Table A.97-1: rightsType

A.98 rightType

rightType
Figure A.98-1: rightType rightType type
 Element/@AttributeCharDescriptionType
 rightType  Extension of rightValueType
values:
APPROVED
SUPPORTED
REJECTED
UNSUPPORTED
REQUESTED
@typeM

The type of the requested Access Right

 
values:
QUERY
CREATE
UPDATE
DELETE
SUBSCRIBE
PROVIDE
Table A.98-1: rightType

A.99 rightValueType

rightValueType
Figure A.99-1: rightValueType rightValueType
 Element/@AttributeCharDescriptionType
 rightValueType  rightValueType is the base type for the following data types:values:
APPROVED
SUPPORTED
REJECTED
UNSUPPORTED
REQUESTED
Table A.99-1: rightValueType

A.100 securityTechnologyListType

securityTechnologyListType
Figure A.100-1: securityTechnologyListType securityTechnologyListType securityTechnology
 Element/@AttributeCharDescriptionType
 securityTechnologyListType 

 

List
 securityTechnologyOR

 

securityTechnologyType
Table A.100-1: securityTechnologyListType

A.101 securityTechnologyType

securityTechnologyType
Figure A.101-1: securityTechnologyType securityTechnologyType clauseList technologyName technologyDescription referenceURL versionMin
 Element/@AttributeCharDescriptionType
 securityTechnologyType 

 

 
 clauseListO

 

clauseListType
 technologyNameO

 

xs:normalizedString
 technologyDescriptionO

 

xs:normalizedString
 referenceURLO

 

xs:anyURI
 versionMinO

 

xs:normalizedString
Table A.101-1: securityTechnologyType

A.102 securityTestRequiredListType

securityTestRequiredListType
Figure A.102-1: securityTestRequiredListType securityTestRequiredListType securityTestRequired
 Element/@AttributeCharDescriptionType
 securityTestRequiredListType 

 

List
 securityTestRequiredOR

Details of the security test required.

 
securityTestRequiredType
Table A.102-1: securityTestRequiredListType

A.103 securityTestRequiredType

Details of the security test required.

securityTestRequiredType
Figure A.103-1: securityTestRequiredType securityTestRequiredType testType testFrequency remediationRequiredIn shareResults
 Element/@AttributeCharDescriptionType
 securityTestRequiredType

Details of the security test required.

 
 
 testTypeO

Type of the test.

 
xs:normalizedString
 testFrequencyO

How often does this test need to be performed?

 
xs:normalizedString
 remediationRequiredInO

RNumber of days remediation for any inadequacies has to be completed with in.

 
xs:normalizedString
 shareResultsO

Are the results of this security test allowed to be shared?

 
values:
Y
N
Table A.103-1: securityTestRequiredType

A.104 SelectedContentType

Allows an XML fragment selected from an object to be used in an element with XML validation skipped.
SelectedContentType
Figure A.104-1: SelectedContentType SelectedContentType
 Element/@AttributeCharDescriptionType
 SelectedContentType Allows an XML fragment selected from an object to be used in an element with XML validation skipped. 
<xs:complexContent mixed="true"> <xs:restriction base="xs:anyType"> <xs:sequence> <xs:any processContents="skip" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:restriction> </xs:complexContent>
Table A.104-1: SelectedContentType

A.105 servicesType

servicesType
Figure A.105-1: servicesType servicesType service
 Element/@AttributeCharDescriptionType
 servicesType  List
 serviceMR serviceType
Table A.105-1: servicesType

A.106 serviceSubTypeType

serviceSubTypeType
Figure A.106-1: serviceSubTypeType serviceSubTypeType
 Element/@AttributeCharDescriptionType
 serviceSubTypeTypeO values:
adminDirective
Table A.106-1: serviceSubTypeType

A.107 serviceType

serviceType
Figure A.107-1: serviceType serviceType type subType name contextId rights
 Element/@AttributeCharDescriptionType
 serviceType   
@typeM serviceTypeType
values:
UTILITY
OBJECT
FUNCTIONAL
SERVICEPATH
XQUERYTEMPLATE
SERVICE
@subTypeO serviceSubTypeType
values:
adminDirective
@nameM

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.

 
xs:string
@contextIdM

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.

 
xs:string
 rightsM rightsType
Table A.107-1: serviceType

A.108 serviceTypeType

serviceTypeType
Figure A.108-1: serviceTypeType serviceTypeType
 Element/@AttributeCharDescriptionType
 serviceTypeTypeO values:
UTILITY
OBJECT
FUNCTIONAL
SERVICEPATH
XQUERYTEMPLATE
SERVICE
Table A.108-1: serviceTypeType

A.109 supportedRequestsType

supportedRequestsType
Figure A.109-1: supportedRequestsType supportedRequestsType supportedRequestType
 Element/@AttributeCharDescriptionType
 supportedRequestsType  List
 supportedRequestTypeMR

The request type and supported operations available for the related service as provided by the named provider.

 
supportedRequestType
Table A.109-1: supportedRequestsType

A.110 supportedRequestType

supportedRequestType
Figure A.110-1: supportedRequestType supportedRequestType requestType operations
 Element/@AttributeCharDescriptionType
 supportedRequestType   
 requestTypeOnillable="false"

Relay an delayed request or turn it into an immediate call.

 
requestTypeValueType
values:
IMMEDIATE
DELAYED
 operationsMnillable="false"

The list of operations a request can target, such as CREATE.

 
operationsType
Table A.110-1: supportedRequestType

A.111 technicalRequirementsType

Details of technical requirements that need to be met to achieve the POD.

technicalRequirementsType
Figure A.111-1: technicalRequirementsType technicalRequirementsType dataAccess conditionList dataSubject dataDeletion securityTechnologyList
 Element/@AttributeCharDescriptionType
 technicalRequirementsType 

Details of technical requirements that need to be met to achieve the POD.

 
 
 dataAccessO

A list of the data that can be accessed and any rules that specifically apply.

 
dataAccessType
 conditionListO

 

conditionListType
 dataSubjectO

The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent.

 
dataSubjectType
 dataDeletionO

Details and requirements for data deletion.

 
dataDeletionType
 securityTechnologyListO

 

securityTechnologyListType
Table A.111-1: technicalRequirementsType

A.112 updatesType

updatesType
Figure A.112-1: updatesType updatesType update
 Element/@AttributeCharDescriptionType
 updatesType  List
 updateMR updateType
Table A.112-1: updatesType

A.113 updateType

updateType
Figure A.113-1: updateType updateType id statusCode error
 Element/@AttributeCharDescriptionType
 updateType   
@idO xs:token
@statusCodeO xs:token
xs:pattern[24-5][0-9]{2}
 errorOnillable="false" errorType
Table A.113-1: updateType

A.114 uriType

uriType
Figure A.114-1: uriType uriType
 Element/@AttributeCharDescriptionType
 uriTypeO xs:anyURI
Table A.114-1: uriType

A.115 uuidType

uuidType
Figure A.115-1: uuidType uuidType
 Element/@AttributeCharDescriptionType
 uuidTypeO xs:token
xs:pattern[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
Table A.115-1: uuidType

A.116 versionType

versionType
Figure A.116-1: versionType versionType
 Element/@AttributeCharDescriptionType
 versionTypeO xs:token
xs:pattern[0-9]{1,3}[.][0-9]{1,3}([.][0-9]{1,3})?
Table A.116-1: versionType

A.117 zoneContextListType

zoneContextListType
Figure A.117-1: zoneContextListType zoneContextListType zoneContext
 Element/@AttributeCharDescriptionType
 zoneContextListType 

 

List
 zoneContextOR

 

zoneContextType
Table A.117-1: zoneContextListType

A.118 zoneContextType

A Zone and/or Context related to a POD.

zoneContextType
Figure A.118-1: zoneContextType zoneContextType zoneId contextId
 Element/@AttributeCharDescriptionType
 zoneContextType

A Zone and/or Context related to a POD.

 
 
 zoneIdO

 

gCoreLocalIdType
 contextIdO

 

gCoreLocalIdType
Table A.118-1: zoneContextType

Valid XHTML 1.0 Transitional