xquerys
http://www.sifassociation.org/infrastructure/3.2.1
Documentation
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.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath | Format |
---|---|---|---|---|---|---|
@id | OC | token | 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”. | /xquerys/xquery/@id | ||
type | * | M | string | Determines if the query may be sent to a data provider or if it requires the extended XQuery mechanism. | /xquerys/xquery/type | SINGULAR, FORMULA, EXTENDED |
status | * | M | string | Communicates if the query has been inspected for data hiding and the results of that assessment. | /xquerys/xquery/status | PENDING, APPROVED, DISALLOWED |
qualifier | O | string | If status is DISALLOWED this element optionally contains the reason. | /xquerys/xquery/qualifier | ||
description | ON | string | Human readable description of the XQuery's intended behavior. | /xquerys/xquery/description | ||
script | * | MN | string | The text of the XQuery which MAY accept parameters. Usage of the CDATA designation is recommended. | /xquerys/xquery/script | |
name | * | M | token | The name of the query parameter to be passed in. Note: Must not conflict with any other query parameter name. | /xquerys/xquery/parameters/parameter/name | |
type | O | token | A well understood type that MAY be used for parameter validation. Example: xs:unsignedInt | /xquerys/xquery/parameters/parameter/type | ||
default | O | token | Value to be supplied for this parameter if the submitter omits it. | /xquerys/xquery/parameters/parameter/default | ||
description | O | string | An explanation of what this parameter represents. | /xquerys/xquery/parameters/parameter/description | ||
required | OC | boolean | Indicator as to if this parameter is required. If omitted, the parameter is assumed to be required! | /xquerys/xquery/parameters/parameter/required | ||
value | * | M | token | An acceptable parameter value for this query. | /xquerys/xquery/parameters/parameter/enumerations/enumeration/value | |
code | OC | token | If enumerated value has an equivalent code, this field may be used for conversion. | /xquerys/xquery/parameters/parameter/enumerations/enumeration/code | ||
start | * | M | long | If a numeric range is used, this holds the inclusive starting value. | /xquerys/xquery/parameters/parameter/range/start | |
end | * | M | long | If a numeric range is used, this holds the inclusive ending value. | /xquerys/xquery/parameters/parameter/range/end | |
minLength | O | unsignedInt | The minimum length for values of this parameter. If omitted, zero. May be functionally different because of other restrictions. | /xquerys/xquery/parameters/parameter/minLength | ||
maxLength | O | unsignedInt | The maximum length for values of this parameter. If omitted, unbounded. May be functionally different because of other restrictions. | /xquerys/xquery/parameters/parameter/maxLength | ||
returnType | * | Q | anyURI | The fully qualified name of the root element returned by this service.Example: http://www.sifassociation.org/datamodel/na/3.3:students | /xquerys/xquery/returnType |
Download: .xlsx
XML Structure
Download: .xml