Data Services API Guide SuccessMaker 10

Transcription

1

2 Document last updated July 26, 2017 Copyright 2017 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 the trademarks or company names implies no relationship, sponsorship, endorsement, sale, or promotion on the part of Pearson Education, Inc. ii

3 Table of Contents Introduction 1 Description 1 Authentication Schemes 1 Base URI 1 Student REST API 2 Description 2 Resource URI 2 Create a New Student 2 Description 2 URI 2 URI Parameters 2 HTTP Method 2 Resource Formats 2 Authentication 2 Request Entities 2 Responses 3 Response Entities 3 Delete a Student 3 Description 3 URI 3 URI Parameters 4 HTTP Method 4 Resource Formats 4 Authentication 4 iii

4 Request Entities 4 Responses 4 Response Entities 4 Get Student List 4 Description 4 URI 4 URI Parameters 4 HTTP Method 4 Resource Formats 5 Authentication 5 Request Entities 5 Responses 5 Response Entities 5 Get Student Data 5 Description 5 URI 5 URI Parameters 5 HTTP Method 6 Resource Formats 6 Authentication 6 Request Entities 6 Responses 6 Response Entities 6 Update a Student 7 Description 7 URI 7 iv

5 URI Parameters 7 HTTP Method 7 Resource Formats 7 Authentication 7 Request Entities 7 Responses 8 Response Entities 8 Student Data Fields 8 Student Validation Rules 9 Teacher REST API 12 Description 12 Resource URI 12 Create a New Teacher 12 Description 12 URI 12 URI Parameters 12 HTTP Method 12 Resource Formats 12 Authentication 12 Request Entities 12 Responses 13 Response Entities 13 Delete a Teacher 13 Description 13 URI 13 URI Parameters 13 v

6 HTTP Method 13 Resource Formats 13 Authentication 14 Request Entities 14 Responses 14 Response Entities 14 Get Teacher List 14 Description 14 URI 14 URI Parameters 14 HTTP Method 14 Resource Formats 14 Authentication 14 Request Entities 14 Responses 15 Response Entities 15 Get Teacher Data 15 Description 15 URI 15 URI Parameters 15 HTTP Method 15 Resource Formats 15 Authentication 15 Request Entities 16 Responses 16 Response Entities 16 vi

7 Update a Teacher 16 Description 16 URI 16 URI Parameters 16 HTTP Method 16 Resource Formats 16 Authentication 17 Request Entities 17 Responses 17 Response Entities 17 Teacher Data Fields 17 Teacher Validation Rules 18 Teacher-Student Relationship REST API 20 Description 20 Resource URI 20 Create a New Teacher-Student Relationship 20 Description 20 URI 20 URI Parameters 20 HTTP Method 20 Resource Formats 20 Authentication 20 Request Entities 20 Responses 21 Response Entities 21 Delete a Teacher-Student Relationship 21 vii

8 Description 21 URI 21 URI Parameters 21 HTTP Method 21 Resource Formats 21 Authentication 22 Request Entities 22 Responses 22 Response Entities 22 Teacher-Student Relationship Data Fields 22 Transfer Student REST API 23 Description 23 Resource URI 23 Transfer a Student to Another School 23 Description 23 URI 23 URI Parameters 23 HTTP Method 23 Resource Formats 23 Authentication 24 Request Entities 24 Responses 24 Response Entities 24 Student Performance Data REST API 25 Description 25 Resource URI 25 viii

9 Retrieve Student Session Data 25 Description 25 URI 25 URI Parameters 25 HTTP Method 25 Resource Formats 25 Authentication 25 Request Entities 26 Responses 26 Response Entities 26 Student Session Data Fields 26 Retrieve Student Skill Mastery Data 27 Description 27 URI 27 URI Parameters 27 HTTP Method 27 Resource Formats 27 Authentication 27 Request Entities 28 Responses 28 Response Entities 28 Student Skill Mastery Data Fields 28 Error Messages 30 Description 30 Response Entity 30 Error Codes 30 ix

10 Field Names and Display Names 36 XML Schema Definitions 38 Student XSD 38 Teacher XSD 42 Teacher-Student Relationship XSD 45 Student Session XSD 45 Skill Mastery XSD 46 x

11 Introduction Description 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 1

12 Student REST API Description This section 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 Description 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} The organization district number HTTP Method POST Resource Formats text/xml Authentication required Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> 2

13 <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 Description This method deletes a student account from SuccessMaker. URI 3

14 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 Description 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} The organization district number HTTP Method GET 4

15 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-xxxxxxxx-xxxxxxxxxxx1">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1</student> <student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxx2">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2</student> <student ref="/schools/{school-id}/students/xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxx3">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx3</student> </students> Get Student Data Description 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 {guid} The student's globally unique identifier 5

16 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> 6

17 </Student> Update a Student Description 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> 7

18 <haseconomicdisadvantage>yes</haseconomicdisadvantage> <hasdisability>yes</hasdisability> <hasenglishproficiency>yes</hasenglishproficiency> <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 8

19 Student Validation Rules Validation Rule 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 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 9

20 Validation Rule Fields are required > Invalid ethnicity values Fields firstname lastname username password studentdistrictid gender grade haseconomicdisadvantage hasdisability hasenglishproficiency ismigrant has504 isgifted hasiep ethnicity 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 10

21 Validation Rule 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 Fields 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 11

22 Teacher REST API Description This section 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 Description 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} The organization district number HTTP Method POST Resource Formats text/xml Authentication required Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Teacher> 12

23 <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 Description 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 Resource Formats text/xml 13

24 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 Description 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} The organization district number HTTP Method GET Resource Formats text/xml Authentication required Request Entities n/a 14

25 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-xxxxxxxx-xxxxxxxxxxx1">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1</teacher> <teacher ref="/schools/{school-id}/teachers/xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxx2">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2</teacher> <teacher ref="/schools/{school-id}/teachers/xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxx3">xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx3</teacher> </teachers> Get Teacher Data Description 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} The organization district number {guid} The teacher's globally unique identifier HTTP Method GET Resource Formats text/xml Authentication required 15

26 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 Description 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 16

27 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 17

28 Teacher Validation Rules Validation Rule 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 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 18

29 Validation Rule Fields are required Must be unique Fields firstname lastname username userid password title username userid 19

30 Teacher-Student Relationship REST API Description This section 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 Description 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} The organization district number HTTP Method POST Resource Formats text/xml Authentication required Request Entities <?xml version="1.0" encoding="utf-8" standalone="yes"?> 20

31 <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 Description 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 {guid} URI Parameters {school-id} The organization district number {guid} The student's globally unique identifier HTTP Method DELETE Resource Formats text/xml 21

32 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 22

33 Transfer Student REST API Description This section 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 Description 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 URI Parameters {from-school-id} school The organization district number of the student's current {guid} The student's globally unique identifier {to-school-id} student to The organization district number of the school to transfer the HTTP Method POST Resource Formats text/xml 23

34 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 24

35 Student Performance Data REST API Description This section 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 Description 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} The organization district number {guid} The student's globally unique identifier HTTP Method GET Resource Formats text/xml Authentication required 25

36 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 26

37 Assigned by (Teacher) 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 Description 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} The organization district number {guid} The student's globally unique identifier HTTP Method GET Resource Formats text/xml Authentication required 27

38 Request Entities n/a 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 28

39 Not Mastered At Risk Date of Skill Status Change Last Date 29

40 Error Messages Description This section describes the format of error messages and includes a list of all possible error codes in the Error Codes table. See the Field Names and Display Names table 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 HTTP Respo nse Code Error Code Error Message Applies To 400 {UnmodifiableUserException} Cannot delete student. The student has an active session. Student Resource 30

41 HTTP Respo nse Code Error Code Error Message Applies To 400 {Message.Not.Readable} The message sent with your request could not be read. Please validate your message to ensure it is properly formatte d. 400 {NotNull.validation.message} {displayn ame} is required. 400 {NotBlank.validation.message} {displayn ame} is required. 400 {InvalidValue.validation.message} The {displayn ame} value is invalid. The HTTP request body. Any required element that is missing. Any required element that has a blank value. Any element with an invalid value. 31

42 HTTP Respo nse Code Error Code Error Message Applies To 400 {InvalidSpaces.validation.message} The {displayn ame} contains invalid whitespac e 400 {Length.validation.message} {displayn ame} length must be between {min} and {max}. 400 {Unique.validation.message} {displayn ame} already exists. 400 {OnlyMe.validation.message} {displayn ame} already exists. Any required element that contains leading or trailing spaces, or more than 1 consecutive inner space. Any element that is outside of the min/max length range. A value is required to be unique for the resource. Teacher Resource ("userid" and "username"), Student Resource ("studentid" and "username") Same as {Unique.validation. message}. It may occur while updating the resource. 32

43 HTTP Respo nse Code Error Code Error Message Applies To 400 {DoesNotExist.validation.message} {displayn ame} does not exist. Occurs for invalid school-id for all applicable operations, student GUID or teacher GUID for Teacher Student Relationship, fromschool-id and toschool-id for Transfer Student. 400 {UsernameGuidMismatch.validation. message} 400 {UsernameGuidBothBlank.validation. message} The Teacher GUID and Usernam e do not match. The Teacher GUID and Usernam e cannot both be blank. Teacher Student Relationship Teacher Student Relationship 33

44 HTTP Respo nse Code Error Code Error Message Applies To 400 {StudentTeacherDifferentSchools.vali dation.message} The Student and Teacher do not belong to the same school. Teacher Student Relationship 400 {AlreadyAtSchool.validation.message} The student already exists in the school you are attemptin g to transfer them to. Transfer Student 400 {UnableToTransferStudentData.valida tion.message} 400 {UnableToTransferStudentAssets.valid ation.message} Unable to transfer student's data. Unable to transfer student's assets. Transfer Student Transfer Student 34

45 HTTP Respo nse Code Error Code Error Message Applies To 400 {StudentDoesNotExistInSchool.validati on.message} 400 {TeacherDoesNotExistInSchool.validat ion.message} Student does not exist in the specified school. Teacher does not exist in the specified school. Occurs when the specified student exists, but is not in the school specified (school-id). Applies to Student Resource, Student Teacher Relationship, and Transfer Student. Occurs when the specified teacher exists, but is not in the school specified (school-id). Applies to Teacher Resource and Student Teacher Relationship. 404 {NotFoundException} Any resources that cannot be found in SuccessMaker. 35

46 HTTP Respo nse Code Error Code Error Message Applies To 500 {Exception} An exception was encounte red while processin g 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 Field Name ethnicity firstname gender grade hasdisability haseconomicdisadvantage hasenglishproficiency ismigrant lastname middlename password specialservices Display Nam Ethnicity First Name Gender Grade Disability Status Socioeconomic Status English Proficiency Migrant Status Last Name Middle Name Password Special Services 36

47 Field Name studentdistrictid studentguid teacherguid teacherusername title userid username Display Nam Student ID Student GUID Teacher GUID Teacher Username Title User ID Username 37

48 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> <xsd:element name="middlename" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <xsd:element name="lastname"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> 38

49 <xsd:element name="username"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <xsd:element name="password"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <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> <xsd:element name="studentdistrictid"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="32"/> </xsd:restriction> </xsd:simpletype> </xsd:element> 39

50 <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" /> <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> <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> 40

51 </xsd:simpletype> </xsd:element> <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> </xsd:element> <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> <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> <xsd:element name="ismigrant"> 41

52 <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> <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"/> <xsd:enumeration value="native_american_alaskan_ NATIVE" /> <xsd:enumeration value="other" /> <xsd:enumeration value="not_specified" /> </xsd:restriction> </xsd:simpletype> </xsd:element> </xsd:all> </xsd:complextype> </xsd:element> </xsd:schema> Teacher XSD <?xml version="1.0"?> <xsd:schema xmlns:xsd=" elementformdefault="qualified"> 42

53 <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> <xsd:element name="middlename" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <xsd:element name="lastname"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <xsd:element name="username"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> 43

54 </xsd:element> <xsd:element name="password"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <xsd:element name="userid"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="32"/> </xsd:restriction> </xsd:simpletype> </xsd:element> <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" /> </xsd:restriction> </xsd:simpletype> </xsd:element> </xsd:all> </xsd:complextype> </xsd:element> 44

55 </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:element> </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> <xsd:attribute name="guid" type="xsd:string"/> <xsd:attribute name="currentcourselevel" type="xsd:decimal"/> 45

56 <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:element> </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:element> </xsd:sequence> <xsd:attribute name="studentguid" type="xsd:string"/> </xsd:complextype> </xsd:element> </xsd:schema> Skill Mastery XSD <?xml version="1.0"?> 46

57 <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:element> </xsd:sequence> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="subject" type="xsd:string"/> </xsd:complextype> </xsd:element> </xsd:sequence> <xsd:attribute name="studentguid" type="xsd:string"/> </xsd:complextype> </xsd:element> </xsd:schema> 47

58 Pearsonschool.com/successmaker K12 Curriculum and Assessment Support