Open Menu

© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

Product / SIMS 7 / SIMS 7 Assessment Manager / SIMS 7 - Assessment - Third Party (SIF like) APIs

SIMS 7 - Assessment - Third Party (SIF like) APIs

 

Overview

This document describes the API calls available, both partner specific and SIMS interfaces within the Assessment Area. 

Partners need to be able to exchange Assessment Data with SIMS.  There are typically 3 key parts to this process.

  1. Extracting definitions for Grade Sets, Result Sets and Aspects
  2. Result exchange
  3. The provision of templates created in SIMS, exported from SIMS and provided to mutual customers for import.

Please note that we are unable to support or accredit API access to Mark Sheets and Templates and recommend the use of partner APIs to obtain assessment data and to write back results.

The SIMS Assessment Suite works on the concept of Programmes of Study, Mark Sheets and Templates.

The APIs used internally by SIMS are available to partners to use for Aspects, Grade Sets and Result Sets.  They are however typically more difficult to operate and consume than the partner APIs listed at the beginning of the document.  However for completeness we list the supported internally used SIMS APIs at the end of the document.

Displaying Partner Results in SIMS

SIMS uses Mark Sheets and Programmes of Study to display assessment results and the typically partners need to ensure that these exist before pushing results in to SIMS. Failure to have a result on a mark sheet would render it useless and almost invisible from a SIMS User’s perspective. 

Where necessary, partners should request a script from partner support to change the supplier in a training database.  This allows partners to create Assessment Templates, Grade Sets, Result Sets and Aspects badged to that partner (and not Green Abbey School).

If partners export these from their copy of SIMS, Schools can import them prior to data exchange and create their own mark sheets (just add students).  Please note that where Result Sets are exported, an API call is required post import to set the IDs to match. 

The APIs are based on SIF but are not formally SIF compliant.

Mapping SIF Names to SIMS Names

  • ASSESSMENTRESULTCOMPONENT refers to Aspect
  • ASSESSMENTRESULTGRADESET refers to GradeSets
  • LEARNERASSESSMENTRESULTSET refers to ResultSets
  • LEARNERASSESSMENTRESULT refers to Results in SIMS Assessment Manager

XML Messages Spec

The Root Element of Every Message is

1) SIMSAssessmentMessage :  identifies the Message as destined for or originating from the Third party Assessment manager Interface.

2) Every Message will contain a Header [Whether it is of MessageType ‘REQUEST’ or ‘UPDATE’]

 

Element Name

[Format]

[Purpose]

Header

 

Purpose to Indicate Routing and Instruction

 

MessageID

String

Identification. Provided by originator of Message and returned in all responses to message, for originators correlation purposes. It is recommended to supply a GUID in MessageID.

SourceID

String

Identification of Message Originator. On responses GUID identifier of School represented by MIS.

On Request must match an Agency known to the School System, or request will be rejected.

If Modifications to Assessment Infrastructure Elements are requested, the supplier of those objects must match SourceID

DestinationId

String

Identification of the intended recipient of the message.

On Request this must match the (normalised) GUID identifier of the Establishment the MIS represents or the Request will be rejected.

On response the SourceID of the original request will be provided as the DestinationID

MessageType

string

Valid Values {Request; Response; Error; Update}

 Request Messages can only be {Request  or Update}

Response Messages {Response and Error (in response to request), Error (in response to Update)}

NB Error is always provided and can be checked.

Status

string

Only supplied in response (Valid Values = OK or ERROR)

If fault the Error collection should be obtained.

 

Eg:

 

<SIMSAssessmentMessage>
  <Header>
    <MessageType>REQUEST</MessageType>
     <MessageID>22B4671FC2F14AFDBC7A7019A320EB7C</MessageID>
    <SourceID>PartnerTest</SourceID>
    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601</DestinationID>
  </Header>….
</SIMSAssessmentMessage>
  1.   XML Spec for Message of Type Request

These messages will be sent to SIMS system for export of data from Assessment Manager subsystem to the external system.

Element Name

[Format]

[Purpose]

QueryObject

@Type

String Attribute

Indicates the type of Objects requested.

Valid Values {ASSESSMENTRESULTCOMPONENT, ASSESSMENTRESULTGRADESET, LEARNERASSESSMENTRESULTSET, LEARNERASSESSMENTRESULT}

 

    RequestParameters

 

 

RequestParameter

@Type

String Attribute

The Field that Should match subsequent values in the Query

(see Parameter Options for more details about @Type) eg: RefID

Value

String

The value of the Field that should be matched


 

<QueryObject Type="ASSESSMENTRESULTCOMPONENT">
  <RequestParameters>
    <RequestParameter Type="RefId">
      <Value>BD42E1CDEA13402B8790E24E5C14C46F</Value>
      <Value>AA42E1CDEA1340221790E24E5C14C466</Value>
      <Value>BB42E1CDEA13402C5790E24E5C14C469</Value>
    </RequestParameter>
  </RequestParameters>
</QueryObject >

Parameter Options

QueryObject @Type

Field Options (type) /RequestParameter

Comments

ASSESSMENTRESULTCOMPONENT

None

All AssesssmentResultComponents will be returned from SIMS AM subsystem.

REFID (Guid/ Normalised GUID)

If REFID paramters are supplied no other Parameter Types should be Supplied.  AssesssmentResultComponents with the specified REFID will be returned if they exist.

Name  (string)

AssesssmentResultComponents with the specified names will be returned

SupplierName (string)

AssesssmentResultComponents from the specified suppliers will be returned

Name and SupplierName (string, string)

AssesssmentResultComponents with  the specified names from the specified suppliers will be returned

 

 

 

 

QueryObject @Type

Field Options (type)

Comments

ASSESSMENTRESULTGRADESET

None

All AssessmentResultGradeSets will be returned from SIMS AM subsystem.

REFID (Guid/ Normalised GUID)

If REFID parameters are supplied no other Parameter Types should be Supplied.  AssessmentResultGradeSets with the specified REFID will be returned from SIMS if they exist.

Name  (string)

AssessmentResultGradeSets with the specified names will be returned

SupplierName (string)

AssessmentResultGradeSets from the specified suppliers will be returned.

Name and SupplierName (string, string)

AssessmentResultGradeSets with the specified names from the specified supplier will be returned.

 

QueryObject @Type

Field Options (type)

Comments

LEARNERASSESSMENTRESULTSET

None

All LearnerAssessmentResultSets will be returned from SIMS AM subsystem.

REFID (Guid/ Normalised GUID)

If REFID paramters are supplied no other Parameter Types should be Supplied.  LearnerAssessmentResultSets with the specified REFID will be returned if they exist.

Name  (string)

LearnerAssessmentResultSets with the specified names will be returned.

SupplierName (string)

LearnerAssessmentResultSets from the specified suppliers will be returned.

Name and SupplierName (string, string)

LearnerAssessmentResultSets with the specified names from the specified supplier will be returned.

 

QueryObject @Type

Field Options (type)

Comments

LEARNERASSESSMENTRESULT

None

Option Not Allowed

REFID (Guid/ Normalised GUID)

[Primary Field]

If REFID paramters are supplied no other Parameter Types should be supplied.  LearnerAssessmentResults with the specified REFID will be returned from SIMS AM subsystem, if they exist.

LearnerPersonalRefID

(Guid/ Normalised GUID)

LearnerAssessmentResults for the specified students will be returned. This will be ExternalID of Student/Person exported from Reporting Engine or VLEExport Utility.

AssessmentComponentRefID

 (Guid/ Normalised GUID)

LearnerAssessmentResults for the specified AssessmentComponents will be returned.

AssessmentSessionList

 (Guid/ Normalised GUID)

LearnerAssessmentResults for the specified LearnerAssessmentResultSet will be returned.

AchievementDate

(Date, Date)

Date Range within which ‘Date Result Achieved’ must lie between: Can Only be Used in Conjunction with 1 or more non primary Field Options.

 

Combination

Any combination of Non Primary fields is permitted.

 

XML Spec for Message of Type Update

These messages will be sent to SIMS system for import of data from Assessment Manager subsystem from VLE.

 

DataObject Xml Definition and mapping

 

ASSESSMENTRESULTCOMPONENT

Element / Attribute

Required

Comment

DataType

@RefId

Y

The ID (GUID) of this aspect

Normalised GUID

Name

Y

The name used to identify this aspect.  This will be stored in ‘Name’ and ‘Default Name’ screen of Aspect in SIMS Assessment Manager.

string

LocalId

Y

A Unique string to the Supplier for this Aspect. This will be stored as ‘External ID’ in SIMS AM screen for Aspect

string

ShortDescription

Y

Shorter description used for column headers in Aspect

This will be stored as ‘Column Heading’ and ‘Default Column Heading’ screen for Aspect in SIMS Assessment Manager

string

Description

Y

Longer text describing features of the component.

string

StageList

N

List of the stages that this component can be used to assess. Readonly

 

StageList/Stage

 

Read Only

 

SupplierName

Y

The supplier/originator/designer/owner of the aspect.

string

ResultQualifier

Y

Only valid value is CM

string

AssessmentMethod

Y

Only Valid value is TT

string

ComponentType

Y

Defines the associated result format.{Comment / Grade / Mark}

string

AssessmentResultGradeSetRefId

 

Required if ComponentType is set to Grade

Normalised GUID

MarkSetList

Y

Required if ComponentType is Mark

 

The below element is required only if MarkSetList exists

MarkSetList/MarkSet

Y

A MarksetList requires at least one markset. Markset date ranges should not overlap

 

The below elements are required only if MarkSetList/MarkSet exists

MarkSetList/MarkSet/StartDate

Y

Date from when the marks are assumed to be valid from.

date

MarkSetList/MarkSet/EndDate

Y

Date until when the marks are assumed to be valid.

date

MarkSetList/MarkSet/MinValue

Y

The minimum value in the range of marks.

decimal

MarkSetList/MarkSet/MaxValue

Y

The maximum value in the range of marks.

decimal

 

Eg:

<SIMSAssessmentMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <MessageType>UPDATE</MessageType>
    <MessageID>390820998F7A485D8310B390D5FE39C6</MessageID>
    <SourceID>PartnerTest</SourceID>
    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601</DestinationID>
    <Status>OK</Status>
  </Header>
  <DataObjects>
    <AssessmentResultComponent RefId="BE4E64E1367D4DAA9290333E4DE98F40">
      <Name>ComponentTest1</Name>
      <LocalId>Component1ex</LocalId>
      <ShortDescription>componentTest1-SD</ShortDescription>
      <Description>omponentTest1-Desc</Description>
      <StageList />
      <AssessmentResultGradeSetRefId>B20F2BCD0E9545FF9D2E8FC3582DE18D</AssessmentResultGradeSetRefId>
      <ComponentType>Grade</ComponentType>
      <ResultQualifier>CM</ResultQualifier>
      <AssessmentMethod>TT</AssessmentMethod>
      <SupplierName>PartnerTest</SupplierName>
      <SIF_ExtendedElements />
    </AssessmentResultComponent>
  </DataObjects>
</SIMSAssessmentMessage>

In the above example,

  • ‘PartnerTest’ specified as a SupplierName will be present in SIMS System as an agency.
  • The Gradeset with the GUID ‘B20F2BCD0E9545FF9D2E8FC3582DE18D’ will be present in SIMS System.
  • The GUID in the DestinationID is the GUID/SCHOOL REF ID of the school to which data is being sent.

 

 

 

 

ASSESSMENTRESULTGRADESET

Element / Attribute

Required

Comment

DataType

@RefId

Y

The ID (GUID) of this grade set.

NormalsiedGUID

LocalId

 

Y

The locally assigned identifier for this grade set [Specified as External ID in SIMS AM Gradeset screen]

string

Name

Y

The descriptive identifier for the grade set.

String

SupplierName

Y

The supplier/originator/designer/owner of the gradeset.

String

GradeSets

 

Collection of versions of a grade set (dated, non-overlapping).

 

GradeSets/GradeSet

 

At least one gradeset should exist

 

GradeSets/GradeSet/StartDate

Y

The start date from which this version is valid.

Date

GradeSets/GradeSet/EndDate

Y

The end date until which this version is valid.

Date

GradeSets/GradeSet/Grades

Y

The list of grades in the set.

 

GradeSets/GradeSet/Grades/Grade

Y

Description of an individual grade in the set.

 

GradeSets/GradeSet/Grades/Grade/Title

Y

The visual representation of the grade.

String

GradeSets/GradeSet/Grades/Grade/Description

N

The meaning of the grade.

String

GradeSets/GradeSet/Grades/Grade/RankOrder

Y

The rank position of the grade within the set where the highest value is assumed to be the best. Duplicates not permitted

Integer

GradeSets/GradeSet/Grades/Grade/NumericValue

N

The numeric equivalent value of the grade.

Decimal

 

Eg:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SIMSAssessmentMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <MessageType>UPDATE</MessageType>
    <MessageID>390820998F7A485D8310B390D5FE39C6</MessageID>
    <SourceID>PartnerTest</SourceID>
    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601</DestinationID>
    <Status>OK</Status>
  </Header>
  <DataObjects>
    <AssessmentResultGradeSet RefId="4C8F269D3FC94FE5A0BAF6A371A5D2AC">
      <LocalId>GradeSetTest1.0</LocalId>
      <Name>GradeSetTest1.0</Name>
      <Notes>      </Notes>
      <SupplierName>SIMS</SupplierName>
      <GradeSets>
        <GradeSet>
          <StartDate>1990-08-01</StartDate>
          <EndDate>2003-07-31</EndDate>
          <Grades>
            <Grade>
              <Title>A</Title>
              <Description>              </Description>
              <RankOrder>1</RankOrder>
              <NumericValue>6.00</NumericValue>
            </Grade>
            <Grade>
              <Title>B</Title>
              <Description>              </Description>
              <RankOrder>2</RankOrder>
              <NumericValue>5.00</NumericValue>
            </Grade>
          </Grades>
        </GradeSet>
      </GradeSets>
    </AssessmentResultGradeSet>
  </DataObjects>
</SIMSAssessmentMessage>

In the above example,

  • ‘PartnerTest’ specified as a SupplierName and SourceID will be present in SIMS System as an agency.
  • The GUID in the DestinationID is the GUID/SCHOOL REF ID of the school to which data is being sent.

 

LEARNERASSESSMENTRESULTSET

Element / Attribute

rqd

Comment

DataType

@RefId

Y

The ID (GUID) of this resultset

NormalsiedGUID

Name

Y

The descriptive identifier for the Resultset.

String

SupplierName

Y

The supplier/originator/designer/owner of the Resultset.

String

CreateDate

Y

The date that the Resultset was originally created.

Date

StartDate

N

Start date of validity period for Resultset

Date

EndDate

N

End date of validity period for Resultset

Date

EditDate

Y

Date the Resultset was last modified

Date

 

 

 

 

Eg:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<SIMSAssessmentMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <Header>

    <MessageType>UPDATE</MessageType>

    <MessageID>390820998F7A485D8310B390D5FE39C6</MessageID>

    <SourceID>PartnerTest</SourceID>

    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601</DestinationID>

    <Status>OK</Status>

  </Header>

  <DataObjects>    

<LearnerAssessmentResultset RefId="3BE0FF0854D44D2CBB6BC068C4C7F892">

      <Name>ResultSetTest1</Name>

      <SupplierName>SIMS</SupplierName>

      <CreateDate>2001-01-01</CreateDate>

      <StartDate>2001-01-01</StartDate>

      <EndDate xsi:nil="true">

      </EndDate>

      <EditDate>2007-01-01</EditDate>

    </LearnerAssessmentResultset>

  </DataObjects>   

</SIMSAssessmentMessage>

 

In the above example,

  • ‘PartnerTest’ specified as a SupplierName and SourceID will be present in SIMS System as an agency.
  • The GUID in the DestinationID is the GUID/SCHOOL REF ID of the school to which data is being sent.

 

 

 

 

LEARNERASSESSMENTRESULT

Element / Attribute

Required

Comment

DataType

@RefId

Y

The ID (GUID) of this result.

NormalsiedGUID

@AssessmentComponentRefId

Y

The assessment component that the result is for.

NormalsiedGUID

@LearnerPersonalRefId

Y

The ID (GUID) of the learner achieving the results. (Student.Person.External_id)

NormalsiedGUID

SchoolInfoRefId

Y

The school at which the assessment was taken.

NormalsiedGUID

AchievementDate

Y

The date the results were achieved.

Date

Result

Y

A grade title, a comment, or a mark (dependent on ComponentType of associated aspect). Marks and grades should be valid in the grade set or mark set on the date the assessment was achieved.

 

ResultStatus

Y

Indicates whether the result is estimated, an interim result, provisional, actual result or a target.

String

AssessmentSessionList

N

The Resultsets that this result is associated with (currently this can Only be 1, additional values will be ignored)

 

AssessmentSessionList/AssessmentSessionRefId

Y

The ID (GUID) that uniquely identifies the LearnerAssessmentResultSet associated with the result.

IdRefType

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<SIMSAssessmentMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <Header>

    <MessageType>UPDATE</MessageType>

    <MessageID>390820998F7A485D8310B390D5FE39C6</MessageID>

    <SourceID>PartnerTest</SourceID>

    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601</DestinationID>

    <Status>OK</Status>

  </Header>

  <DataObjects>       

<LearnerAssessmentResult RefId="23AD85A18C56471CBF3390FA9A179DDE" AssessmentComponentRefId="21A91B2F3F4647D786E053193685AEEB" LearnerPersonalRefId="D9166D2F6E194BF6B9D8AD123297CA24">

      <SchoolInfoRefId>C58EB679DE6D44C0B30849348DEE2241</SchoolInfoRefId>

      <AchievementDate>2009-07-24</AchievementDate>

      <Result>B</Result>

      <ResultStatus>R</ResultStatus>

      <AssessmentSessionList>

        <AssessmentSessionRefId>BFADE5D0FC51485BA571987213286008</AssessmentSessionRefId>

      </AssessmentSessionList>

</LearnerAssessmentResult>

  </DataObjects>

</SIMSAssessmentMessage>

 

In the above example,

  • ‘PartnerTest’ specified as a SourceID will be present in SIMS System as an agency.
  • The GUID in the DestinationID is the GUID/SCHOOL REF ID of the school to which data is being sent.
  • The GUID in the SchoolInfoRefId is the GUID for the school for which the results have been taken.

 

The table below explains the conditions for importing results into the SIMS system via AssessmentTP interfaces

The LearnerPersonalRefId is the same value for each of these scenarios and has been omitted for formatting reasons.

‘Matches’ indicates a field value in a row in the sims.asm_result table when looking at the Student/Aspect/Result/ResultSet/AchievementDate combinations.

 

Result GUID

Aspect  GUID

ResultSet GIUD

Date

Action (sims.asm_result)

Matches

Matches

Matches

Matches

Update Result

Matches

Matches

Matches

No Match

Update Result

Matches

Matches

Not Provided

Matches

Update Result

Matches

Matches

Not Provided

No Match

No Update

No Match

Matches

Matches

Matches

Update Result

No Match

Matches

Matches

No Match

Update Result

No Match

Matches

Not Provided

Matches

No Update

No Match

Matches

Not Provided

No Match

Add Result

No Match

Matches

No Match

Matches

Add Result

No Match

Matches

No Match

No Match

Add Result

No Match

No Match

No Match

No Match

Add Result

 

All other combinations are error conditions

 

 

                                                                 

 

Interface Specification

 

There are two third party interfaces exposed via AssessmentTP:

 

 Export()

It retrieves Assessment data out from SIMS system.

              Input: XmlDocument containing a Valid Query. These have been defined in the ‘XmlSpec for Message of Type Request’ in the document above.

              Output: XmlDocument containing the retrieved data. It also contains XmlErrorDocument or XmlErrorString if the document header is not ‘OK’

 

Below example shows how the export can be invoked for getting aspects and the output produced from it:

 

SIMSAssessmentMessage sdo = new SIMSAssessmentMessage();

Dictionary<string, string> paramOptions = sdo.GetParamOptions(SIMSAssessmentMessage.ASSESSMENTRESULTCOMPONENT); // The parameter passed to GetParamOptions will vary depending of what has been requested for export from Assessment WriteBack interfaces.

XmlDocument request = @"<SIMSAssessmentMessage>

                              <Header>

                                <MessageType>REQUEST</MessageType>                                <MessageID>895339910C94496AAD7C8C16C5E8F3CE</MessageID>

                                <SourceID>PartnerTest</SourceID>                                    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601 </DestinationID>

                              </Header>

                              <QueryObject Type=""ASSESSMENTRESULTCOMPONENT"">

                                <RequestParameters />

                              </QueryObject>

                            </SIMSAssessmentMessage>"; 

XmlDocument data = sdo.Export(request);

//The error document is present as sdo.ErrorDocument

//The error string is present as sdo.ErrorString

 

Sample output for this message is as below:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<SIMSAssessmentMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <Header>

    <MessageType>RESPONSE</MessageType>

    <MessageID>3A442037CE1D4951B9FEEA05FA5C644A</MessageID>

    <SourceID>A17DE5D849144D95A4E1C8D1009464E6</SourceID>

    <DestinationID>SIMS</DestinationID>

    <Status>OK</Status>

  </Header>

  <DataObjects>

    <AssessmentResultComponent RefId="E0F053D4C06E4577873A049AC0E8A022">

      <Name>Maths Effort</Name>

      <LocalId>859</LocalId>

      <ShortDescription>Maths Effort</ShortDescription>

      <Description>

      </Description>

      <StageList />

      <AssessmentResultGradeSetRefId>3893D5D0183A450FB6E843B7479FAD1A</AssessmentResultGradeSetRefId>

      <MarkSetList />

      <ComponentType>Grade</ComponentType>

      <ResultQualifier>CM</ResultQualifier>

      <AssessmentMethod>TT</AssessmentMethod>

      <SupplierName>820 4321 Green Abbey School</SupplierName>

      <SIF_ExtendedElements />

    </AssessmentResultComponent>

  </DataObjects>

</SIMSAssessmentMessage>

 

Import ()

 Creates /Updates SIMS Assessment data.

Input: XmlDocument containing a Valid Query. These have been defined in the ‘XmlSpec for Message of Type Update’ in the document above.

              Output: XmlDocument containing Valid Assessment DataObjects. It also contains XmlErrorDocument or XmlErrorString if the document header is not ‘OK’

 

Below example shows how the import can be invoked for saving results:

 

SIMSAssessmentMessage sdo = new SIMSAssessmentMessage();

Dictionary<string, string> paramOptions = sdo.GetParamOptions(SIMSAssessmentMessage. LEARNERASSESSMENTRESULT); // The parameter passed to GetParamOptions will vary depending of what has been requested for importing data using Assessment WriteBack interfaces.

XmlDocument request = @"<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes""?>

                <SIMSAssessmentMessage xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">

                  <Header>

                    <MessageType>UPDATE</MessageType>

                    <MessageID>4F59D43BE9EC41F2A11EBD247352ADC8</MessageID>

                    <SourceID>PartnerTest</SourceID>

                    <DestinationID>A7BCF7D4E4224965A153A3EDA4243601 </DestinationID>

                    <Status>OK</Status>

                  </Header>

                  <DataObjects>

                    <LearnerAssessmentResult RefId=""0BD7DE6C0D824686A751AEA426228303"" AssessmentComponentRefId=""48E292692A8842128D1E69ED707614ED"" LearnerPersonalRefId=""884D121CE6E549F3A67858336FCD3086"">

                      <SchoolInfoRefId>A7BCF7D4E4224965A153A3EDA4243601</SchoolInfoRefId>

                      <AchievementDate>2009-08-26</AchievementDate>

                      <Result>1</Result>

                      <ResultStatus>R</ResultStatus>

                    </LearnerAssessmentResult>

                  </DataObjects>

                </SIMSAssessmentMessage>";

sdo.Import(request);

Permissions

Import and Export Rights:

Export rights

Core System|Assessment Manager|Import and Export|Manage

Core System|Assessment Manager|Individual Attainment|View All

 

Import Rights

Core System|Assessment Manager|Import and Export|Resources Auto Update

Core System|Assessment Manager|Individual Attainment|Edit All

 

Profiles which already hold these rights are:

Export - Assessment Co-ordinator / Assessment Operator

Import - Assessment Co-ordinator

 

Assessment Import Error Codes

AssessmentResultComponents

 

1           The Associated Grade Set failed during import.

5           The Associated Grade Set does not exist.

6           The Aspect's Supplier is blank.

14106       The Maximum and Minimum values are not within the valid range.

14112       The Aspect's Create Date is blank.

14113       The Aspect does not have an associated Marks Set.

14120       The Aspect Type is invalid.

14121       The Aspect's Default Name is blank.

14122       The Aspect's External Id is blank.

14128       The Aspect is not associated with a known Module.

14132       The Aspect's Column Heading is blank.

14133       The Aspect's Column Heading is not unique.

14135       The Aspect's Default Name is not unique.

14136       The incoming Markset for the Aspect is inconsistent.

14139       Either the minimum or maximum values for the Aspect is invalid.

14141       There are invalid dates for the Aspect.

14145       The Markset has an Invalid Start Date.

14147       The Aspect's Edit Date is blank.

14148       An Aspect cannot be modified by an older version.

14149       The following Results could not be imported as the Result is not valid for the current Grade Set version.

14152       The Aspect cannot be associated with a Grade Set from a different Supplier or a different Module.

14914       The Aspect does not have an associated Grade Set.

 

 

 

 

 

AssessmentResultGradeSets

1           Results have been found with dates that are outside the dates of the Aspect's Grade Sets. Existing Grades not available in the import file and Results exists for the same.

2           Grades earmarked for removal have been found within one or more Templates.

3           Grades earmarked for removal have been found within one or more OMR Templates.

4           The Rank order used by the Grade Set History is blank.

5           The Rank Order is not in sequence.

6           A reference has been made to an unknown Module.

7           The Grade Set's Supplier is blank.

8           The following Results have been found with dates that are outside the dates of the Aspect's Grade Sets or existing Grades not available in the import file and Results exists for the same.

9           Aspect and Gradeset Supplier or Module does not match.

14203       The Module associated with the Grade Set is blank.

14206       The Name of the Grade Set is blank.

14207       The Grade Set History does not have a Start Date.

14208       The Grade Set's External Id is blank.

14210       The Grade Set's does not have a Create Date.

14211       The Grade Set's does not have an Edit Date.

14212       A duplicate Grade exists within the Grade Set.

14213       The Grade within a Grade Set is blank.

14214       The Grade Set's Default Name is not unique for the Supplier.

14215       The Values for Grades is not in descending order.

14227       Grade Set Versions are not contiguous.

14229       A Grade Set cannot be modified by an older version.

14230       No Value Set has been setup as the default.

14231       More than one Value Set has been setup as the default.

14310       The Value of the Grade is not within the permissible range.

14901       A Grade Set Version, Valueset or one or more Grades do not exist.

 

LearnerAssessmentResults

 

2           The Aspect Supplier is not known.

2           The Aspect Module is not known.

3           The Supplier of the Result Set is not known.

4           The Module associated with the Result Set is not known.

5           The Module associated with the Result is not known.

6           The Result is blank.

7           The Result Set associated with the Result is locked.

8           The Result is not in a valid format.

9           The Result is not within the valid range for the current Mark Set.

10          The Result is not within the valid range.

11          The Result is not within the valid range.

12          The Result is not valid for the current Grade Set.

13          The Result is not within the valid range.

14          The Aspect associated with the Result failed during import.

15          The Result Set associated with the Result failed during import.

 

LearnerAssessmentResultSets

 

14208       The External ID of the Result Set is blank.

14401       The Name of the Result Set is blank.

14404       The Create Date of the Result Set is blank.

14407       The Default Name of the Result Set is blank.

14415       The Result Set Start Date cannot be after the End Date.

14416       The Edit Date of the Result Set is blank.

14417       A Result Set cannot be modified by an older version.

14426       The  Module Name of the Result Set is blank.

 

 

Glossary

Normalised GUID:  A GUID with hyphen formatting removed.

 

 

 

 

APIs used internally by SIMS

 

 

Assessment Interfaces

Aspects

AspectSummary

This call enables you to get summary aspect information returned dependant on the filter parameters you pass though.  The details below are setup for returning every aspect.

string aspectname = "";

string columnheader = "";

string aspecttype ="u" ;

int owner = 0;

int module = 0;

string category_xml = "<root></root>";                                                    

 

SIMS.Processes.AspectSummary ASMAspectSummary = new AspectSummary();

ASMAspectSummary.PopulateAspects(aspectname, columnheader, aspecttype, owner , module, category_xml);

 

Sample AspectSummary entity Properties

aspectType                      string

ColumnHeader                string

Description                      string

gradesetName                 string

iD                                      int

moduleID                         int

owner                              string

  1.                           int

MaintainAspect

Using the aspect Id returned as a property of the summaryAspect above you can use this call to return enhanced detail about the aspect aswell as for editing and saving.

SIMS.Processes.MaintainAspect ASMMaintainAspect = new MaintainAspect();

ASMMaintainAspect.Populate(new SIMS.Entities.Person(447));

                                               

ASMMaintainAspect.AspectEntity.AspectDescriptionAttribute.Value = "Jon1";

 

 

 

 

 

Sample AspectEntity Entity Properties

AspectDescription           string

AspectType                      string

ColumnHeader                string

CreatorDate                    DateTime          

CreatorID                         int

DefaultDescription          string

DefaultHeading               string

DefaultName                   string

GradeSetName                string

GradeSetId                       int

Id                                      Int

ModuleName                  string

ModuleId                         int

Supplier                           string

Saving an AspectEntity.

To save a change to an aspect you should first call the isValid() method. This returns a Boolean. If this is true then you can call the Save method. If not, correct the errors with the data and then re validate.

 

bool isvalid =  ASMMaintainAspect.Valid();

                if (isvalid == true)

                {

                                ASMMaintainAspect.Save();

                }

 

 

 

GradeSet

MaintainGradesetSummary

This populates a collection of ASMGradeSetSummarys entities. The singular is ASMGradeSetSummary

int moduleID = 0;

string suppliername = "";         

string gradesetName = "";

 

SIMS.Processes.MaintainGradesetSummary ASMMaintainGradeSetSummary = new MaintainGradesetSummary();

ASMMaintainGradeSetSummary.Populate(moduleID, suppliername, gradesetName);

foreach (SIMS.Entities.ASMGradeSetSummary gradeSetSummary in ASMMaintainGradeSetSummary.asmGradeSetSummarys)

                {

                //gradeSetSummary.NameAttribute; 

                }

 

Sample ASMGradesetSummary entity’s properties

ID                                      int        

Module                            string

ModuleID                         int

Name                               string

Supplier                           string

SupplierID                        int

 

MaintainGradeSet

Using the gradeset ID retuned as a property of the ASMGradeSetSummary above you will use this call to return enhanced detail about the aspect as well as for editing and saving.

SIMS.Processes.MaintainGradeSet ASMMaintainGradeSet = new MaintainGradeSet();

ASMMaintainGradeSet.Populate(12);

// ASMMaintainGradeSet.ASMGradeset.DescriptionAttribute.Value = "";

 

 

 

 

Sample ASMGradeSet Entity Properties

CreateDAte                      dateTime

DefaultName                   string

Description                      string

EditDate                           dateTime

GradeSetId                       Int

ModuleId                         Int

ModuleName                  String

SupplierID                        Int

SupplierName                 String

 

Saving an ASMGradeset Entity

To save a change to an aspect you should first call the isValid() method. This returns a Boolean. If this is true then you can call the Save method.

Bool  isvalid = ASMMaintainGradeSet.Valid();

If (isvalid == true)

{

ASMMaintainGradeSet.Save();

}

 

Grades and Values

The individual grades and their respective values are stored underneath the gradeset histories.

SIMS.Processes.MaintainGradeSet ASMMaintainGradeSet = new MaintainGradeSet();

ASMMaintainGradeSet.Populate(12);

foreach (SIMS.Entities.ASMGradeSetHistory asmGradeSetHistory in ASMMaintainGradeSet.ASMGradeset.AsmGradesetHistorys.Value )

       {

//insert code here to extract data

       }

Marksheet & Templates Unsupported Classes

Please note that the use of these APIs are not supported and this applies to any calls on

  • SIMS.Processes.MarksheetBrowse
  • SIMS.Entities.ASMMarksheetSummary
  • SIMS.Processes.ASMMarksheetDetail
  • SIMS.Processes.TemplateBrowse
  • SIMS.Entities.ASMTemplate
  • SIMS.Processes.TPPGridDetail()

 

And related calls.