Visual Software Online Specification Delivery Service
Overview
This product offering is composed of the following pieces:
- A centralized database that contains definitions of specifications (specification versions, countries, localities supported, code sets, objects, elements, attributes, descriptions of each of these and other pertinent information)
- A web-based application that allows users to maintain this database
- A web service that allows users and applications to query the database, extracting information using oData querying conventions
- An "update" utility that uses these facilities to keep applications up to date by subscribing to "feeds" from the web service
The Central Database
The following tables contain the information delivered by the Specification Delivery Service for the SIF specification.
Name | Description |
sifCodeValues | This table is used to maintain SIF standard and extensions to code values, their values and descriptions. |
sifCountries | This table includes one record for each country (or region) that has its own SIF specification |
sifEntities | This table contains definitions for each element and attribute in the specification (for all versions of the specification) |
sifExtendedElements | This contains definitions for Extended Elements for objects where the provider has chosen to register them with this service. Â The Locality for this EE must be listed in sifLocalities. |
sifLocalities | Records in this table define localities where Extended Elements and local code values are defined |
sifObjects | Records in this table define the names and descriptions for each of the SIF objects in each of the SIF versions. |
sifVersions | Records in this table define the versions available for each of the SIF specifications. |
The Maintenance Application
<documentation to be completed>
The Web Service
Example 1
http://www.vsisupport.com:8080/VSICentralService.svc/sifEntities?$filter=DataModelVersion eq '2.1' and ObjectName eq 'LEAInfo'
Example 2
http://www.vsisupport.com:8080/VSICentralService.svc/sifCodeValues?$filter=LocalityName eq 'MA' and ObjectName eq 'StudentPersonal' and LastUpdated gt datetime'2013-04-09T00:00:00'
Example 3
http://www.vsisupport.com:8080/VSICentralService.svc/sifCodeValues?$filter=LocalityName eq 'MA' and LastUpdated gt datetime'2013-04-09T00:00:00'
Web Service Output
<?xml version="1.0" encoding="utf-8"?> <feed xml:base="http://www.vsisupport.com:8085/VSICentralService.svc/" xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"> <id>http://www.vsisupport.com:8085/VSICentralService.svc/sifEntities</id> <title type="text">sifEntities</title> <updated>2013-12-17T15:47:02Z</updated> <link rel="self" title="sifEntities" href="sifEntities" /> <entry> <id>http://www.vsisupport.com:8085/VSICentralService.svc/sifEntities(2)</id> <category term="VSICentralMasterModel.sifEntity" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> <link rel="edit" title="sifEntity" href="sifEntities(2)" /> <title /> <updated>2013-12-17T15:47:02Z</updated> <author> <name /> </author> <content type="application/xml"> <m:properties> <d:RecordID m:type="Edm.Int32">2</d:RecordID> <d:CountryCode>US</d:CountryCode> <d:DataModelVersion>2.0r1</d:DataModelVersion> <d:InfrastructureVersion>2.0r1</d:InfrastructureVersion> <d:LocalityName m:null="true" /> <d:ObjectName>LEAInfo</d:ObjectName> <d:XML_Sequence m:type="Edm.Int16">100</d:XML_Sequence> <d:ItemType>E</d:ItemType> <d:ItemName>LocalId</d:ItemName> <d:XPATH>LocalId</d:XPATH> <d:Characteristic>M</d:Characteristic> <d:Description>The locally-assigned identifier for this LEA.</d:Description> <d:DateCreated m:type="Edm.DateTime">2012-11-06T11:24:03.843</d:DateCreated> <d:LastUpdated m:type="Edm.DateTime" m:null="true" /> <d:IsDeprecated m:type="Edm.Boolean">false</d:IsDeprecated> <d:LastAction>0</d:LastAction> <d:CreatedBy m:null="true" /> <d:MaintainedBy m:null="true" /> </m:properties> </content> </entry> <entry> <id>http://www.vsisupport.com:8085/VSICentralService.svc/sifEntities(3)</id> <category term="VSICentralMasterModel.sifEntity" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> <link rel="edit" title="sifEntity" href="sifEntities(3)" /> <title /> <updated>2013-12-17T15:47:02Z</updated> <author> <name /> </author> <content type="application/xml"> <m:properties> <d:RecordID m:type="Edm.Int32">3</d:RecordID> <d:CountryCode>US</d:CountryCode> <d:DataModelVersion>2.0r1</d:DataModelVersion> <d:InfrastructureVersion>2.0r1</d:InfrastructureVersion> <d:LocalityName m:null="true" /> <d:ObjectName>LEAInfo</d:ObjectName> <d:XML_Sequence m:type="Edm.Int16">200</d:XML_Sequence> <d:ItemType>E</d:ItemType> <d:ItemName>StateProvinceId</d:ItemName> <d:XPATH>StateProvinceId</d:XPATH> <d:Characteristic>O</d:Characteristic> <d:Description>The state-assigned identifier for this LEA.</d:Description> <d:DateCreated m:type="Edm.DateTime">2012-11-06T11:24:06.753</d:DateCreated> <d:LastUpdated m:type="Edm.DateTime" m:null="true" /> <d:IsDeprecated m:type="Edm.Boolean">false</d:IsDeprecated> <d:LastAction>0</d:LastAction> <d:CreatedBy m:null="true" /> <d:MaintainedBy m:null="true" /> </m:properties> </content> </entry> <entry> <id>http://www.vsisupport.com:8085/VSICentralService.svc/sifEntities(4)</id> <category term="VSICentralMasterModel.sifEntity" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> <link rel="edit" title="sifEntity" href="sifEntities(4)" /> <title /> ...
The Update Utility
<to be written>