providers
http://www.sifassociation.org/infrastructure/3.2
Documentation
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.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath | Format |
---|---|---|---|---|---|---|
@id | uuidType | /providers/provider/@id | [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} | |||
serviceType | * | M | serviceTypeType | The generic type of Service being provided. | /providers/provider/serviceType | UTILITY, OBJECT, FUNCTIONAL, SERVICEPATH, XQUERYTEMPLATE |
serviceName | * | M | token | The name of the Service or the Service Path being provided. | /providers/provider/serviceName | |
contextId | * | M | token | The name of the Service Context being provided. | /providers/provider/contextId | |
zoneId | * | M | token | The Zone in which the Service Context is being provided. | /providers/provider/zoneId | |
providerName | * | M | token | The name of the Service Provider as it would be referred to by the administrator of the Zone (ex: RamseySIS). | /providers/provider/providerName | |
dynamicQuery | O | boolean | True if this service is capable of honoring the "where" parameter. | /providers/provider/querySupport/dynamicQuery | ||
queryByExample | O | boolean | True if this service is capable of honoring query by example payloads. | /providers/provider/querySupport/queryByExample | ||
changesSinceMarker | O | boolean | True if this service is capable of supporting Changes Since Queries. | /providers/provider/querySupport/changesSinceMarker | ||
paged | O | boolean | True if this service is capable of responding to Paged Query Requests (both Interactive and Batch). | /providers/provider/querySupport/paged | ||
maxPageSize | MC | unsignedInt | If Paged Queries are supported, this is the maximum number of Objects that will be returned on a Page of Query results. | /providers/provider/querySupport/maxPageSize | ||
totalCount | boolean | /providers/provider/querySupport/totalCount | ||||
vendorName | O | string | The name of the company supplying this Product. | /providers/provider/querySupport/applicationProduct/vendorName | ||
productName | * | M | string | The name of the Product | /providers/provider/querySupport/applicationProduct/productName | |
productVersion | O | string | 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. | /providers/provider/querySupport/applicationProduct/productVersion | ||
iconURI | O | anyURI | 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). | /providers/provider/querySupport/applicationProduct/iconURI | ||
vendorName | O | string | The name of the company supplying this Product. | /providers/provider/querySupport/adapterProduct/vendorName | ||
productName | * | M | string | The name of the Product | /providers/provider/querySupport/adapterProduct/productName | |
productVersion | O | string | 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. | /providers/provider/querySupport/adapterProduct/productVersion | ||
iconURI | O | anyURI | 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). | /providers/provider/querySupport/adapterProduct/iconURI | ||
mediaType | * | M | token | An Internet Media Type supported by this adaptor (for this service). | /providers/provider/mimeTypes/mediaType | |
location | * | M | anyURI | The URL to use when sending Requests to a Provider | /providers/provider/endPoint/location | |
@name | * | M | string | Name/Value pair. | /providers/provider/endPoint/properties/property/@name | |
property | * | M | string | Name/Value pair. | /providers/provider/endPoint/properties/property |
Download: .xlsx
XML Structure
Download: .xml