Central Store API

 

ContentInterface.xsd

ContentTypes.xsd

ContentService.wsdl

 

Web Service: http://ir-dev.air.org/contentservice_v2.asmx?wsdl

 

 

Client Lookup

 

Description:

Used to get all clients.

 

Example Request:

ClientLookup()

 

Example Response:

<Clients>

   <Client Name="CSSC" Key="6" />

   <Client Name="Ohio" Key="3" />

</Clients>

 

 

 

AdminSubject Lookup

 

Description:

Used to lookup administration and subject/grade information for a client.

 

Parameter

Description

Required?

Value

ClientName

The name of the client as stored in the central store.

Yes

Valid Value:

 

String

 

Example Request:

AdminSubjectLookup(“cssc”)

 

Example Response:

<AdminSubjects>

   <AdminSubject AdminKey="3" SubjectKey="6" Year="2006" Season="Fall" Subject="Reading" Grade="3" ITSKey=”4” />

   <AdminSubject AdminKey="4" SubjectKey="7" Year="2005" Season="Fall" Subject="Reading" Grade="3 " ITSKey=”5” />

</AdminSubjects>

 

 


 

Central Store Item Search

 

Description:

Used to search for items based on an administration and subject/grade keys.

 

Parameter

Description

Required?

Value

AdminKey

The central store unique administration key.

Yes

Valid Value:

 

Integer 1 to n

SubjectKey

The central store unique subject key.

Yes

Valid Value:

 

Integer 1 to n

Format

The type of format for the items.

Optional

Valid Value:

 

String (e.x. MC, CR)

Rangefinding

Set this as TRUE if you want to only include items that have “valid” set of rangefinding papers. Otherwise FALSE will include any item.

Optional

Valid Values:

 

  • True
  • False (default)

ResponseGroup

Controls the data returned by the operation. Use this parameter to specify which response group of data elements you would like to be returned to you.

 

Yes

Valid Values:

 

  • Normal (Default)
  • URI

 

 

Example Request 1:

ItemSearch(3, 6)

 

Example Response 1:

<AdminSubject AdminKey="3" SubjectKey="6" Year="2006" Season="Fall" Subject="Reading" Grade="3" ITSKey=”4”>

   <Strands>

      <Strand Name="Acquisition of Vocabulary">

         <Items>

            <Item Key="94" ITSKey="23" Position="1" Format="MC" />

            <Item Key="97" ITSKey="45" Position="2" Format="MC" />

         </Items>

      </Strand>

    </Strands>

</AdminSubject>

 

 

Example Request 2:

ItemSearch(3, 6, “MC”, false, “URI”)

 

Example Response 2:

<AdminSubject AdminKey="3" SubjectKey="6" Year="2006" Season="Fall" Subject="Reading" Grade="3" ITSKey=”4” PathUri=”/ircentral/Ohio/Ohio_K_5/”>

   <Strands>

      <Strand Name="Acquisition of Vocabulary">

         <Items>

            <Item Key="94" ITSKey="23" Position="1" Format="MC">

               <FileUri>item_32_v4.xml</FileUri>

            </Item>

            <Item Key="97" ITSKey="45" Position="2" Format="MC">

               <FileUri>item_123_v2.xml</FileUri>

            </Item>

         </Items>

       </Strand>

    </Strands>

   <Passages>

      <Passage Key="78">

        <FileUri>Passage_1_v3.xml</FileUri>

      </Passage>

      <Passage Key="35">

        <FileUri>Passage_2_v6.xml</FileUri>

      </Passage>

   </Passages>

</AdminSubject>

 

 

 

Central Store Item Lookup

 

Description:

Used to request specific item keys information from the central store.

 

 

Parameter

Description

Required?

Value

AdminKey

The central store unique administration key.

Yes

Valid Value:

 

Integer 1 to n

SubjectKey

The central store unique subject key.

Yes

Valid Value:

 

Integer 1 to n

Items

The central store item keys you would like information about.

Yes

Valid Values:

 

Array of integers 1 to n

ResponseGroup

Controls the data returned by the operation. Use this parameter to specify which response group of data elements you would like to be returned to you.

 

Yes

Valid Values:

 

  • Normal (Default)
  • URI

 

 


 

Sample Request:

ItemLookup(3, [94, 97], “URI”)

 

Sample Response:

<AdminSubject AdminKey="3" SubjectKey="6" Year="2006" Season="Fall" Subject="Reading" Grade="3" ITSKey=”4” PathUri=”/ircentral/Ohio/Ohio_K_5/”>

   <Strands>

      <Strand Name="Acquisition of Vocabulary">

         <Items>

            <Item Key="94" ITSKey="23" Position="1" Format="MC">

               <FileUri>item_32_v4.xml</FileUri>

            </Item>

            <Item Key="97" ITSKey="45" Position="2" Format="MC">

               <FileUri>item_123_v2.xml</FileUri>

            </Item>

         </Items>

       </Strand>

    </Strands>

   <Passages>

      <Passage Key="78">

        <FileUri>Passage_1_v3.xml</FileUri>

      </Passage>

      <Passage Key="35">

        <FileUri>Passage_2_v6.xml</FileUri>

      </Passage>

   </Passages>

 </AdminSubject>



 

ITS Item Lookup

 

Description:

Used to find ITS items based on a client name and ITS administration.

 

Parameter

Description

Required?

Value

ClientName

The name of the client as stored in the central store.

Yes

Valid Value:

 

String

AdminKey

The key of the administration as stored in ITS.

Yes

Valid Value:

 

Integer 1 to n

Items

The ITS item id’s you would like more information about.

Yes

Valid Values:

 

Array of integers 1 to n

ResponseGroup

Controls the data returned by the operation. Use this parameter to specify which response group of data elements you would like to be returned to you.

 

Yes

Valid Values:

 

  • Normal (Default)
  • URI

 


 

 

Sample Request:

ItemITSLookup(“cssc”, 123, [23, 45], “URI”)

 

Sample Response:

<AdminSubject AdminKey="3" SubjectKey="6" Year="2006" Season="Fall" Subject="Reading" Grade="3" ITSKey=”4” PathUri=”/ircentral/Ohio/Ohio_K_5/”>

   <Strands>

      <Strand Name="Acquisition of Vocabulary">

         <Items>

            <Item Key="94" ITSKey="23" Position="1" Format="MC">

               <FileUri>item_32_v4.xml</FileUri>

            </Item>

            <Item Key="97" ITSKey="45" Position="2" Format="MC">

               <FileUri>item_123_v2.xml</FileUri>

            </Item>

         </Items>

       </Strand>

    </Strands>

   <Passages>

      <Passage Key="78">

        <FileUri>Passage_1_v3.xml</FileUri>

      </Passage>

      <Passage Key="35">

        <FileUri>Passage_2_v6.xml</FileUri>

      </Passage>

   </Passages>

 </AdminSubject>

 

 

Response Groups

Normal

Returns basic data.

URI

Returns the basic data and URI locations (path, item and passage filenames).

 

C# API Samples

Client Tree:

IContentProvider content = ContentProviderFactory.Create();

AdminSubjectLookup lookup = new AdminSubjectLookup();

lookup.ClientName = "cssc";

 

AdminSubjectCollection adminSubjects = content.RequestAdminSubjectLookup(lookup);

Scorer Training Tree:

IContentProvider content = ContentProviderFactory.Create();

ItemSearch search = new ItemSearch();

search.AdminKey = 3;

search.SubjectKey = 6;

search.Format = "CR"

search.Rangefinding = TRUE // No RF papers loaded, so doesn’t work yet

 

AdminSubject adminSubjectItems = content.RequestItemSearch(search);

Scorer Training Entry:

ItemLookup lookup = new ItemLookup();

lookup.AdminKey = 3;

lookup.SubjectKey = 6;

 

Int64Collection items = new Int64Collection();

items.Add(94);

items.Add(97);

lookup.Items = items;

lookup.ResponseGroup = ResponseGroup.URI;

 

AdminSubject adminSubjectItems = content.RequestItemLookup(lookup);

Practice Test Entry:

IContentProvider content = ContentProviderFactory.Create();

ItemSearch search = new ItemSearch();

request.AdminKey = 3;

request.SubjectKey = 6;

request.ResponseGroup = ResponseGroup.URI;

 

AdminSubject adminSubjectItems = content.RequestItemSearch(search);

Restore previous Practice Test from saved ITS data:

ItemITSLookup lookup = new ItemITSLookup();

lookup.ClientName = "cssc"

lookup.AdminKey = 1;

lookup.ResponseGroup = ResponseGroup.URI;

 

Int64Collection itsItems = new Int64Collection();

itsItems.Add(2147);

itsItems.Add(2197);

lookup.Items = itsItems;

 

AdminSubject adminSubjectItems = content.RequestItemITSLookup(lookup);