SuccessMaker Data Services API Guide

Transcription

1 SuccessMaker Data Services API Guide

2 Document last updated August 2014 Copyright Pearson Education, Inc. or one or more of its direct or indirect affiliates. All rights reserved. Pearson and SuccessMaker are registered trademarks, in the U.S. and/or other countries of Pearson Education, Inc. or its affiliates. Other trademarks are the property of their respective owners. Use of trademarks or company names implies no relationship, sponsorship, endorsement, sale, or promotion on the part of Pearson Education, Inc.

3 Table of Contents Introduction Student REST API Create a New Student... 2 Delete a Student... 3 Get Student List... 4 Transfer Student List... 5 Get Student Data... 6 Update a Student... 8 Student Data Fields... 9 Student Validation Rules Teacher REST API Create a New Teacher Delete a Teacher Get Teacher List Get Teacher Data Update a Teacher Teacher Data Fields Teacher Validation Rules Teacher-Student Relationship REST API Create a New Teacher-Student Relationship Delete a Teacher-Student Relationship Teacher-Student Relationship Data Fields Transfer Student REST API Transfer a Student to Another School Student Performance Data REST API Retrieve Student Session Data Student Session Data Fields Retrieve Student Skill Mastery Data Student Skill Mastery Data Fields Error Messages Error Codes Field Names and Display Names XML Schema Definitions Student XSD Teacher XSD Teacher-Student Relationship XSD Student Session XSD Skill Mastery XSD Transfer Student List XSD SuccessMaker Data Services API Guide iii

4 Introduction This guide describes the SuccessMaker application programming interface (API). The SuccessMaker API consists of five parts: the Student API, the Teacher API, the Teacher Student Relationship API, the Transfer Student API, and the Student Performance Data API. The SuccessMaker API allows developers to access core areas of the SuccessMaker application from their own systems. This API was written in a Representational State Transfer (REST)ful manner so that it could be accessed easily by any other system regardless of the programming language or platform deployment. All that is required to execute the API methods is knowledge of HTTP and XML. To learn more about each of the methods and resources available through the APIs, review the detailed chapters of this document. Authentication Schemes Basic Authentication Base URI SuccessMaker Data Services API Guide 1

5 1 Student REST API This chapter describes the Student REST API methods and resources. The Student API provides Create, Read, Update, and Delete operations for student accounts. With the exception of student creation, all methods require a student's globally unique identifier (GUID) to execute. Resource URI {school-id} The organization district number Create a New Student This method creates a new student account in SuccessMaker. If successful, this method will return the newly-created student's GUID in the response body. The HTTP response will also contain a Location header with the new resource's Uniform Resource Identifier (URI). URI URI Parameters {school-id} HTTP Method POST Resource Formats text/xml Authentication required The organization district number SuccessMaker Data Services API Guide 2

6 Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Student> <firstname>rest</firstname> <middlename></middlename> <lastname>student</lastname> <username>student11111_ri</username> <password>student11111_ri</password> <gender>female</gender> <studentdistrictid>student11111_ri</studentdistrictid> <grade>1</grade> <specialservices>plan_504</specialservices> <haseconomicdisadvantage>yes</haseconomicdisadvantage> <hasdisability>yes</hasdisability> <hasenglishproficiency>yes</hasenglishproficiency> <ismigrant>yes</ismigrant> <ethnicity>african_american</ethnicity> </Student> Responses 201 Created Student account was created. The location header contains its URI. 400 Bad Request The provided data is incomplete or invalid. Response Entities xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx This will be the GUID of the newly-created student. Delete a Student This method deletes a student account from SuccessMaker. URI SuccessMaker Data Services API Guide 3

7 URI Parameters {school-id} The organization district number {guid} The student's globally unique identifier HTTP Method DELETE Resource Formats text/xml Authentication required Request Entities n/a Responses 200 OK The student is returned as the response entity. 404 Not Found There is no student with this GUID. Response Entities n/a Get Student List This method returns a listing of students for a given school from SuccessMaker. If successful, this method will return the student list as XML in the response body. URI URI Parameters {school-id} HTTP Method GET The organization district number SuccessMaker Data Services API Guide 4

8 Resource Formats text/xml Authentication required Request Entities n/a Responses 200 OK The student list is returned as the response entity. Response Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <students self="/schools/{school-id}/students/"> <student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx1">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1</student> <student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx2">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2</student> </students> Transfer Student List This method allows for transferring a list of one or more students to the school identified in the URI. If one or more student transfers in the list fail, all successful transfers will be completed and any failed transfers will be reported. URI <student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx3">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx3</student> URI Parameters {to-school-id} transferred to The organization district number of the school the student is being SuccessMaker Data Services API Guide 5

9 HTTP Method PUT Resource Formats text/xml Authentication required Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <students> <student id="student11111_ri"></student> <student id="student22222_ri"></student> </students> The id attribute for the student is their student district identification. Responses 201 Created All students were successfully transferred. The location header contains the URI to get student list. 400 Bad Request The provided data is incomplete or invalid. Some or all of the student transfers may have failed. Response Entities n/a Get Student Data This method returns student account data from SuccessMaker. If successful, this method will return the student resource as XML in the response body. URI URI Parameters {school-id} The organization district number SuccessMaker Data Services API Guide 6

10 {guid} The student's globally unique identifier HTTP Method GET Resource Formats text/xml Authentication required Request Entities n/a Responses 200 OK The student is returned as the response entity. 404 Not Found There is no student with this GUID. Response Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Student> <firstname>rest</firstname> <middlename></middlename> <lastname>student</lastname> <username>student11111_ri</username> <password>student11111_ri</password> <gender>female</gender> <studentdistrictid>student11111_ri</studentdistrictid> <grade>1</grade> <specialservices>plan_504</specialservices> <haseconomicdisadvantage>yes</haseconomicdisadvantage> <hasdisability>yes</hasdisability> <hasenglishproficiency>yes</hasenglishproficiency> <ismigrant>yes</ismigrant> <ethnicity>african_american</ethnicity> </Student> SuccessMaker Data Services API Guide 7

11 Update a Student This method updates student account data in SuccessMaker. URI URI Parameters {school-id} The organization district number {guid} The student's globally unique identifier HTTP Method PUT Resource Formats text/xml Authentication required Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Student> <firstname>rest</firstname> <middlename></middlename> <lastname>student</lastname> <username>student11111_ri</username> <password>student11111_ri</password> <gender>female</gender> <studentdistrictid>student11111_ri</studentdistrictid> <grade>1</grade> <specialservices>plan_504</specialservices> <haseconomicdisadvantage>yes</haseconomicdisadvantage> <hasdisability>yes</hasdisability> <hasenglishproficiency>yes</hasenglishproficiency> SuccessMaker Data Services API Guide 8

12 <ismigrant>yes</ismigrant> <ethnicity>african_american</ethnicity> </Student> Responses 200 OK Student account was updated. 400 Bad Request The provided data is incomplete or invalid. Response Entities n/a Student Data Fields First Name Middle Name Last Name Ethnicity Gender Grade Username Password Student ID Disability Status Socioeconomic Status English Proficiency Special Services Migrant Status SuccessMaker Data Services API Guide 9

13 Student Validation Rules Table 1-1 Student Validation Rules Validation Rule Fields Non UTF-16 characters not allowed No leading spaces, trailing spaces, or more than 1 consecutive inner space is allowed Field length maximum of 255 Field length maximum of 32 Invalid grade values Fields are required firstname middlename lastname username password studentdistrictid firstname middlename lastname username studentdistrictid firstname middlename lastname username password studentdistrictid If a grade is entered, it must match one of the following: K, 1, 2, 3, 4, 5, 6, 7, 8, NOT_SPECIFIED firstname lastname username password studentdistrictid gender grade haseconomicdisadvantage hasdisability hasenglishproficiency ismigrant has504 isgifted hasiep ethnicity SuccessMaker Data Services API Guide 10

14 Validation Rule Fields Invalid ethnicity values Invalid gender values Invalid yes/no demographic values. Values for these fields must match one of the following: YES NO NOT_SPECIFIED Must be unique If an ethnicity is entered, it must match one of the following: AFRICAN_AMERICAN ASIAN_PACIFIC_ISLANDER CAUCASIAN HISPANIC_OR_LATINO NATIVE_AMERICAN_ALASKAN_NATIVE OTHER NOT_SPECIFIED If a gender is entered, it must match one of the following: FEMALE MALE NOT_SPECIFIED haseconomicdisadvantage hasdisability hasenglishproficiency ismigrant has504 isgifted hasiep username studentdistrictid SuccessMaker Data Services API Guide 11

15 2 Teacher REST API This chapter describes the Teacher REST API methods and resources. The Teacher API provides Create, Read, Update and Delete operations for teacher accounts. With the exception of teacher creation, all methods require a teacher's GUID to execute. Resource URI school-id The organization district number Create a New Teacher This method creates a new teacher account in SuccessMaker. If successful, this method will return the newly-created teacher's GUID in the response body. The HTTP response will also contain a Location header with the new resource's URI. URI URI Parameters {school-id} HTTP Method POST Resource Formats text/xml Authentication required The organization district number SuccessMaker Data Services API Guide 12

16 Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Teacher> <firstname>rest</firstname> <middlename></middlename> <lastname>teacher</lastname> <username>teacher11111_ri</username> <password>teacher11111_ri</password> <userid>teacher11111_ri</userid> <title>dr</title> </Teacher> Responses 201 Created Teacher account was created. The location header contains its URI. 400 Bad Request The provided data is incomplete or invalid. Response Entities xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx This will be the GUID of the newly-created teacher. Delete a Teacher This method deletes a teacher account from SuccessMaker. URI URI Parameters {school-id} The organization district number {guid} The teacher's globally unique identifier HTTP Method DELETE SuccessMaker Data Services API Guide 13

17 Resource Formats text/xml Authentication required Request Entities n/a Responses 200 OK The teacher is returned as the response entity. 404 Not Found There is no teacher with this GUID. Response Entities n/a Get Teacher List This method returns a listing of teachers for a given school from SuccessMaker. If successful, this method will return the teacher list as XML in the response body. URI URI Parameters {school-id} HTTP Method GET Resource Formats text/xml Authentication required The organization district number SuccessMaker Data Services API Guide 14

18 Request Entities n/a Responses 200 OK The teacher list is returned as the response entity. Response Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <teachers self="/schools/{school-id}/teachers/"> <teacher ref="/schools/{school-id}/teachers/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx1">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1</teacher> <teacher ref="/schools/{school-id}/teachers/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx2">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2</teacher> <teacher ref="/schools/{school-id}/teachers/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx3">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx3</teacher> </teachers> Get Teacher Data This method returns teacher account data from SuccessMaker. If successful, this method will return the teacher resource as XML in the response body. URI URI Parameters {school-id} {guid} HTTP Method GET Resource Formats text/xml Authentication required The organization district number The teacher's globally unique identifier SuccessMaker Data Services API Guide 15

19 Request Entities n/a Responses 200 OK The teacher is returned as the response entity. 404 Not Found There is no teacher with this GUID. Response Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Teacher> <firstname>rest</firstname> <middlename></middlename> <lastname>teacher</lastname> <username>teacher11111_ri</username> <userid>teacher11111_ri</userid> <title>dr</title> </Teacher> Update a Teacher This method updates teacher account data in SuccessMaker. URI URI Parameters {school-id} The organization district number {guid} The teacher's globally unique identifier HTTP Method PUT Resource Formats text/xml SuccessMaker Data Services API Guide 16

20 Authentication required Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Teacher> <firstname>rest</firstname> <middlename></middlename> <lastname>teacher</lastname> <username>teacher11111_ri</username> <password>teacher11111_ri</password> <userid>teacher11111_ri</userid> <title>dr</title> </Teacher> Responses 200 OK Teacher account was updated. 400 Bad Request The provided data is incomplete or invalid. Response Entities n/a Teacher Data Fields First Name Middle Name Last Name Username Password Title User ID SuccessMaker Data Services API Guide 17

21 Teacher Validation Rules Table 2-1 Teacher Validation Rules Validation Rule Fields Non UTF-16 characters not allowed No leading spaces, trailing spaces, or more than 1 consecutive inner space is allowed Field length maximum of 255 Invalid title values Fields are required Must be unique firstname middlename lastname username userid password firstname middlename lastname username userid firstname middlename lastname username password If a title is entered, it must match one of the following: DR MISS MS MR MRS NOT_SPECIFIED firstname lastname username userid password title username userid SuccessMaker Data Services API Guide 18

22 3 Teacher-Student Relationship REST API This chapter describes the Teacher-Student Relationship REST API methods and resources. The Teacher-Student Relationship API provides Create and Delete operations for teacher student relationships. Resource URI school-id The organization district number Create a New Teacher-Student Relationship This method creates a new teacher -student relationship in SuccessMaker. If successful, this method will assign the student to the teacher. Any existing Teacher-Student relationship will be removed. This method allows the teacher to be identified by username or GUID. URI URI Parameters {school-id} HTTP Method POST Resource Formats text/xml Authentication required The organization district number SuccessMaker Data Services API Guide 19

23 Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <TeacherStudent> <teacherguid>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</teacherguid> <studentguid>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</studentguid> </TeacherStudent> This format uses the teacher's GUID to identify the teacher. This is the preferred format to use. Responses 201 Created Teacher-student relationship was created. 400 Bad Request The provided data is incomplete or invalid. Response Entities n/a Delete a Teacher-Student Relationship This method deletes an existing teacher-student relationship in SuccessMaker. If successful, this method will delete any existing teacher -student relationship; and the student will be set to unassigned. URI URI Parameters {school-id} {guid} HTTP Method DELETE Resource Formats text/xml The organization district number The student's globally unique identifier SuccessMaker Data Services API Guide 20

24 Authentication required Request Entities n/a Responses 200 OK Teacher Student relationship was deleted, student is now unassigned. 400 Bad Request The provided data is incomplete or invalid. Response Entities n/a Teacher-Student Relationship Data Fields Teacher GUID Student GUID SuccessMaker Data Services API Guide 21

25 4 Transfer Student REST API This chapter describes the Transfer Student REST API methods and resources. The Transfer Student API allows for the transferring of a student from one school to another school within the same district. Resource URI from-school-id The organization district number of the student's current school Transfer a Student to Another School This method will transfer a student from the current school to another school within the same district. If successful, this method will transfer the student's data to the new school; and the student will be set to unassigned. The HTTP response will also contain a Location header with the resource's new URI. URI {guid}/{to-school-id} URI Parameters {from-school-id} The organization district number of the student's current school {guid} {to-school-id} to HTTP Method POST Resource Formats text/xml The student's globally unique identifier The organization district number of the school to transfer the student SuccessMaker Data Services API Guide 22

26 Authentication required Request Entities n/a Responses 201 Created Student was successfully transferred. The location header contains its new URI. 400 Bad Request The provided data is incomplete or invalid. Response Entities n/a SuccessMaker Data Services API Guide 23

27 5 Student Performance Data REST API This chapter describes the Student Performance Data REST API methods and resources. The Student Performance Data API provides two raw data feeds for student session and skill mastery data. Resource URI {school-id} The organization district number Retrieve Student Session Data This method will return the student's assignment session data. Each assignment will be returned along with all of its sessions. Sessions that are currently in progress will not be included. If a student is in Initial Placement (IP) the session will contain a '-1.00' value for its current course level. URI /studentsessiondata/{guid} URI Parameters {school-id} {guid} HTTP Method GET Resource Formats text/xml The organization district number The student's globally unique identifier SuccessMaker Data Services API Guide 24

28 Authentication required Request Entities n/a Responses 200 OK Student session data was successfully retrieved. 400 Bad Request The provided data is incomplete or invalid. Response Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <studentsessiondata studentguid="xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"> <assignment name="math" subject="math" assignedby="mr. Henry Levyston" assignedcourselevel="3.0"/> <assignment name="reading" subject="reading" assignedby="mr. Henry Levyston" assignedcourselevel="3.0"> <session guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" currentcourselevel="3.00" startdate=" :35:10" enddate=" :45:10" length="10" ipmcompletedate="" ipmlevel="" rawexercisesattempted="2" rawexercisescorrect="2"/> <session guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" currentcourselevel="3.05" startdate=" :20:10" enddate=" :40:10" length="20" ipmcompletedate="" ipmlevel="" rawexercisesattempted="12" rawexercisescorrect="6"/> <session guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" currentcourselevel="3.10" startdate=" :35:10" enddate=" :50:10" length="15" ipmcompletedate="" ipmlevel="" rawexercisesattempted="20" rawexercisescorrect="15"/> </assignment> </studentsessiondata> Student Session Data Fields Student GUID Session GUID Assignment Name Subject Assigned by (Teacher) SuccessMaker Data Services API Guide 25

29 Assigned Course Level Current Course Level at End of Session Session Start Date/Time Session End Date/Time Session Length IPM Complete Timestamp IPM Level Raw Exercises Attempted in Session Raw Exercises Correct in session Retrieve Student Skill Mastery Data This method will return the student's skill mastery data. Each assignment will be returned along with all of its skills mastery data. URI URI Parameters {school-id} {guid} HTTP Method GET Resource Formats text/xml Authentication required Request Entities n/a The organization district number The student's globally unique identifier SuccessMaker Data Services API Guide 26

30 Responses 200 OK Student skill mastery data was successfully retrieved. 400 Bad Request The provided data is incomplete or invalid. Response Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <studentskillmasterydata studentguid="xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"> <assignment name="math" subject="math"/> <assignment name="reading" subject="reading"> <skill guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name="understanding Reading Skill 1" status="not Mastered" laststatuschangedate=" "/> <skill guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name="reading Comprehension Skills" status="not Mastered" laststatuschangedate=" "/> <skill guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name="understanding Reading Skill 77" status="at Risk" laststatuschangedate=" "/> </assignment> </studentskillmasterydata> Student Skill Mastery Data Fields Student GUID Assignment Name Subject Skill GUID Skill Assessed Skill Name Skill Status Mastered Not Mastered At Risk Date of Skill Status Change Last Date SuccessMaker Data Services API Guide 27

31 6 Error Messages This chapter describes the format of error messages and includes a list of all possible error codes in Table 6-1. See Table 6-2 for a list of the fields and their corresponding display names. Response Entity <?xml version="1.0" encoding="utf-8" standalone="yes"?> <errors> <error> <errorcode>{notfoundexception}</errorcode> <field>guid</field> <errormessage>person with guid invalidguid not found.</errormessage> </error> </errors> Error Codes Table 6-1 Error Codes HTTP Response Code Error Code Error Message Applies To 400 {UnmodifiableUserE xception} Cannot delete student. The student has an active session. Student Resource 400 {Message.Not.Read able} The message sent with your request could not be read. Please validate your message to ensure it is properly formatted. The HTTP request body. 400 {NotNull.validation. message} {displayname} is required. Any required element that is missing. 400 {NotBlank.validation.message} {displayname} is required. Any required element that has a blank value. 400 {InvalidValue.valida tion.message} The {displayname} value is invalid. Any element with an invalid value. SuccessMaker Data Services API Guide 28

32 HTTP Response Code Error Code Error Message Applies To 400 {InvalidSpaces.valid ation.message} The {displayname} contains invalid whitespace Any required element that contains leading or trailing spaces, or more than 1 consecutive inner space. 400 {Length.validation. message} {displayname} length must be between {min} and {max}. Any element that is outside of the min/max length range. 400 {Unique.validation. message} {displayname} already exists. A value is required to be unique for the resource. Teacher Resource ("userid" and "username"), Student Resource ("studentid" and "username") 400 {OnlyMe.validation. message} {displayname} already exists. Same as {Unique.validation.message}. It may occur while updating the resource. 400 {DoesNotExist.valid ation.message} {displayname} does not exist. Occurs for invalid school-id for all applicable operations, student GUID or teacher GUID for Teacher Student Relationship, fromschool-id and to-school-id for Transfer Student. 400 {UsernameGuidMis match.validation.me ssage} The Teacher GUID and Username do not match. Teacher Student Relationship 400 {UsernameGuidBoth Blank.validation.mes sage} The Teacher GUID and Username cannot both be blank. Teacher Student Relationship 400 {StudentTeacherDiff erentschools.validati on.message} The Student and Teacher do not belong to the same school. Teacher Student Relationship 400 {AlreadyAtSchool.va lidation.message} The student already exists in the school you are attempting to transfer them to. Transfer Student 400 {UnableToTransferS tudentdata.validatio n.message} Unable to transfer student's data. Transfer Student 400 {UnableToTransferS tudentassets.validati on.message} Unable to transfer student's assets. Transfer Student 400 {AlreadyAtSchool.va lidation.message} {studentid} The student already exists in the school you are attempting to transfer them to. Transfer Student List 400 {UnableToTransferS tudentdata.validatio n.message} {studentid} Unable to transfer student's data. Transfer Student List SuccessMaker Data Services API Guide 29

33 HTTP Response Code Error Code Error Message Applies To 400 {UnableToTransferS tudentassets.validati on.message} {studentid} Unable to transfer student's assets. Transfer Student List 400 {StudentDoesNotExi stinschool.validatio n.message} Student does not exist in the specified school. Occurs when the specified student exists, but is not in the school specified (schoolid). Applies to Student Resource, Student Teacher Relationship, and Transfer Student. 400 {TeacherDoesNotExi stinschool.validatio n.message} Teacher does not exist in the specified school. Occurs when the specified teacher exists, but is not in the school specified (schoolid). Applies to Teacher Resource and Student Teacher Relationship. 404 {NotFoundException } Any resources that cannot be found in SuccessMaker. 500 {Exception} An exception was encountered while processing your request. The SuccessMaker REST API encountered an unexpected exception. You may choose to retry your request or execute custom error handling. Field Names and Display Names Table 6-2 Field Names Field Name ethnicity firstname gender grade hasdisability haseconomicdisadvantage hasenglishproficiency ismigrant lastname middlename password specialservices studentdistrictid studentguid Display Name Ethnicity First Name Gender Grade Disability Status Socioeconomic Status English Proficiency Migrant Status Last Name Middle Name Password Special Services Student ID Student GUID SuccessMaker Data Services API Guide 30

34 teacherguid teacherusername title userid username Teacher GUID Teacher Username Title User ID Username SuccessMaker Data Services API Guide 31

35 7 XML Schema Definitions Student XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:element name="student"> <xsd:complextype> <xsd:all> <xsd:element name="firstname"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="middlename" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="lastname"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="username"> <xsd:simpletype> SuccessMaker Data Services API Guide 32

36 <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="password"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="gender" > <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="male" /> <xsd:enumeration value="female" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> <xsd:element name="studentdistrictid"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="32"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="grade" > <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="k" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> SuccessMaker Data Services API Guide 33

37 <xsd:enumeration value="4" /> <xsd:enumeration value="5" /> <xsd:enumeration value="6" /> <xsd:enumeration value="7" /> <xsd:enumeration value="8" /> <xsd:enumeration value="9" /> <xsd:enumeration value="10" /> <xsd:enumeration value="11" /> <xsd:enumeration value="12" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> <xsd:element name="specialservices"> <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="not_specified" /> <xsd:enumeration value="plan_504" /> <xsd:enumeration value="gifted_talented" /> <xsd:enumeration value="iep" /> <xsd:enumeration value="no_special_services" /> <xsd:enumeration value="other" /> </xsd:restriction> </xsd:simpletype> <xsd:element name="haseconomicdisadvantage"> <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="yes" /> <xsd:enumeration value="no" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> SuccessMaker Data Services API Guide 34

38 /> <xsd:element name="hasdisability"> <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="yes" /> <xsd:enumeration value="no" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> <xsd:element name="hasenglishproficiency"> <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="yes" /> <xsd:enumeration value="no" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> <xsd:element name="ismigrant"> <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="yes" /> <xsd:enumeration value="no" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> <xsd:element name="ethnicity"> <xsd:simpletype> <xsd:restriction base="xs:string"> <xsd:enumeration value="african_american" <xsd:enumeration value="asian_pacific_islander" /> <xsd:enumeration value="caucasian" /> <xsd:enumeration value="hispanic_or_latino"/> SuccessMaker Data Services API Guide 35

39 <xsd:enumeration value="native_american_alaskan_native" /> <xsd:enumeration value="other" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> </xsd:all> </xsd:complextype> </xsd:schema> Teacher XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:element name="teacher"> <xsd:complextype> <xsd:all> <xsd:element name="firstname"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="middlename" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="lastname"> <xsd:simpletype> SuccessMaker Data Services API Guide 36

40 <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="username"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="password"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="userid"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="32"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="title"> <xsd:simpletype> <xsd:restriction base="xsd:string" > <xsd:enumeration value="dr" /> <xsd:enumeration value="miss" /> <xsd:enumeration value="ms" /> <xsd:enumeration value="mr" /> <xsd:enumeration value="mrs" /> <xsd:enumeration value="not_specified" /> SuccessMaker Data Services API Guide 37

41 </xsd:restriction> </xsd:simpletype> </xsd:all> </xsd:complextype> </xsd:schema> Teacher-Student Relationship XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:element name="teacherstudent"> <xsd:complextype> <xsd:all> <xsd:element name="teacherguid" type="xsd:string" /> <xsd:element name="studentguid" type="xsd:string" /> </xsd:all> </xsd:complextype> </xsd:schema> Student Session XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:element name="studentsessiondata"> <xsd:complextype> <xsd:sequence> <xsd:element name="assignment"> <xsd:complextype> <xsd:sequence> <xsd:element name="session"> <xsd:complextype> SuccessMaker Data Services API Guide 38

42 <xsd:attribute name="guid" type="xsd:string"/> <xsd:attribute name="currentcourselevel" type="xsd:decimal"/> <xsd:attribute name="startdate" type="xsd:datetime"/> <xsd:attribute name="enddate" type="xsd:datetime"/> <xsd:attribute name="length" type="xsd:decimal"/> <xsd:attribute name="ipmcompletedate" type="xsd:datetime"/> <xsd:attribute name="ipmlevel" type="xsd:decimal"/> <xsd:attribute name="rawexercisesattempted" type="xsd:decimal"/> <xsd:attribute name="rawexercisescorrect" type="xsd:decimal"/> </xsd:complextype> </xsd:sequence> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="subject" type="xsd:string"/> <xsd:attribute name="assignedby" type="xsd:string"/> <xsd:attribute name="assignedcourselevel" type="xsd:decimal"/> </xsd:complextype> </xsd:sequence> <xsd:attribute name="studentguid" type="xsd:string"/> </xsd:complextype> </xsd:schema> SuccessMaker Data Services API Guide 39

43 Skill Mastery XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:element name="studentskillmasterydata"> <xsd:complextype> <xsd:sequence> <xsd:element name="assignment"> <xsd:complextype> <xsd:sequence> <xsd:element name="skill"> <xsd:complextype> <xsd:attribute name="guid" type="xsd:string"/> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="status" type="xsd:string"/> <xsd:attribute name="laststatuschangedate" type="xsd:date"/> </xsd:complextype> </xsd:sequence> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="subject" type="xsd:string"/> </xsd:complextype> </xsd:sequence> <xsd:attribute name="studentguid" type="xsd:string"/> </xsd:complextype> </xsd:schema> SuccessMaker Data Services API Guide 40

44 Transfer Student List XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:element name="students"> <xsd:complextype> <xsd:sequence> <xsd:element name="student" minoccurs="0" maxoccurs="unbounded"> <xsd:complextype> <xsd:attribute name="id" type="xsd:string"/> </xsd:complextype> </xsd:sequence> </xsd:complextype> </xsd:schema> SuccessMaker Data Services API Guide 41

45 Pearsonschool.com/successmaker support.pearsonschool.com