SIF Infrastructure (Global) 3.2

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

providers0@id1serviceType2serviceName3contextId4zoneId5providerName6dynamicQuery7queryByExample8changesSinceMarker9paged10maxPageSize11totalCount12vendorName13productName14productVersion15iconURI16applicationProduct16--1216--1316--1416--1517vendorName18productName19productVersion20iconURI21adapterProduct21--1721--1821--1921--2022querySupport22--622--722--822--922--1022--1122--1622--2123mediaType24mimeTypes24--2325location26@name27property27--2628properties28--2729endPoint29--2529--2830provider30--030--130--230--330--430--530--2230--2430--2931providers31--30

Download: .dot .svg .png

Table

Name Mandatory Characteristics Type Description XPath Format
@id uuid​Type ​/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 service​Type​Type 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 unsigned​Int 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 any​URI 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 any​URI 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 any​URI 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

<providers xmlns="http://www.sifassociation.org/infrastructure/3.2"> <provider id=""> <serviceType/> <serviceName/> <contextId/> <zoneId/> <providerName/> <querySupport> <dynamicQuery/> <queryByExample/> <changesSinceMarker/> <paged/> <maxPageSize/> <totalCount/> <applicationProduct> <vendorName/> <productName/> <productVersion/> <iconURI/> </applicationProduct> <adapterProduct> <vendorName/> <productName/> <productVersion/> <iconURI/> </adapterProduct> </querySupport> <mimeTypes> <mediaType/> </mimeTypes> <endPoint> <location/> <properties> <property name=""/> </properties> </endPoint> </provider> </providers>

Download: .xml