Versions Compared

Old Version 1

changes.mady.by.user Jason Elwood

Saved on

compared with

New Version 2

changes.mady.by.user Jason Elwood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET /ssp/api/1/person/{id}/studentdocument

Security

PERSON_EARLY_ALERT_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)DOCUMENT_READ

Returns

Code Block
{"success":"true",
  "message":"","
  "results":1,
  "rows":
    [{"id":"84ace0060a76c6d7-1a3641eb-4acc13ce-83a78141-2d87abfcf3c2ec9fb583006a",
   
    "createdDate":13479649035681382654391683,
    "createdBy":
        {"id":"f02058a40a93b220-76e541a4-4d061263-97d28141-97d13db0505ea445371b0000",
        "firstName":"DemoAmy",
        "lastName":"Coach18Administrator"},
    "modifiedDate":13482205035681382654391683,
    "modifiedBy":
        {"id":"f02058a40a93b220-76e541a4-4d061263-97d28141-97d13db0505ea445371b0000",
        "firstName":"DemoAmy",
        "lastName":"Coach18Administrator"},
    "objectStatus":"ACTIVE",
    "courseNamefile":"ENG055"null,
    "courseTitlecomment":"CollegePublished ReadingI2012-04",
    "courseTermCodename":"FA12",
    "emailCC":nullSSP Article for the League for Innovation",
    "campusIdconfidentialityLevelId":"0a640a2ab3d077a7-409d4055-12710510-81407967-d10a517701174a09f93a0357",
    "earlyAlertReasonOtherDescriptionfileName":null,
    "earlyAlertSuggestionOtherDescription":null"2012-04 League article about SSP.pdf",
    "commentauthor":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",Amy Administrator"}
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b]
}

Get a Document

GET /ssp/api/1/person/{id}/studentdocument/{id}

Security

PERSON_DOCUMENT_READ

Returns

Document

Code Block
{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
    "closedDatecreatedDate":null1382654391683,
    "closedByIdcreatedBy":null,
    "closedByName":null,     {"noOfResponsesid":1,
    "earlyAlertReasonIds":"0a93b220-41a4-1263-8141-a445371b0000",
        [{"idfirstName":"b2d112b8-5056-a51a-8067-1fda2849c3e5Amy",
        "createdDatelastName":1336003200000"Administrator"},
    "modifiedDate":1382654391683,
    "createdBymodifiedBy":
        {"id":"58ba5ee30a93b220-734e41a4-4ae91263-b9c58141-943774b4de41a445371b0000",
        "firstName":"SystemAmy",
        "lastName":"Administrator"},
    "modifiedDateobjectStatus":1336003200000"ACTIVE",
    "modifiedByfile":
   null,
    {"idcomment":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
   Published 2012-04","name":"SSP Article for the League for Innovation",
    firstName"confidentialityLevelId":"Systemb3d077a7-4055-0510-7967-4a09f93a0357",
        "lastNamefileName":"Administrator"},
    "objectStatus":"ACTIVE"2012-04 League article about SSP.pdf",
    "nameauthor":"ExcessiveAmy Absences",
    "description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
  ]
}

Get an Early Alert

GET /ssp/api/1/person/{id}/earlyAlert/{id}

Security

PERSON_EARLY_ALERT_READ

Returns

EarlyAlert

Code Block
{"success":"true",
 "message":"","results":1,
 "rows":
    [{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
    "courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
    "emailCC":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Excessive Absences",
    "description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
  ]
}

 

Create an Early Alert

POST /ssp/api/1/person/{id}/earlyAlert

The {id} in the URL for Early Alert creation can either be an existing Person ID in UUID syntax, or it can be the school's legacy School ID (the school-assigned identifier for the student) for an existing Person.

Security

PERSON_EARLY_ALERT_WRITE

Sample Post

Code Block
{"courseName" : "MTH-101",
 "courseTitle" : "Concepts of Math",
 "courseTermCode" : "FA12",
 "emailCC" : "john.smith@university.edu",
 "campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
 "earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
 "earlyAlertReasonOtherDescription" : null,
 "earlyAlertSuggestionIds" : 
    [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
     {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
 "earlyAlertSuggestionOtherDescription" : null,
 "personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
 "comment" : "Student is often late to class and isn't prepared.",
 "sendEmailToStudent" : true}

Returns

EarlyAlert

Code Block
{"success":"true",
 "message":"","results":1,
 "rows":
    [{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
    "courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
    "emailCC":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Excessive Absences",
    "description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
  ]
}

 

Save an Early Alert

PUT /ssp/api/1/person/{id}/earlyAlert/{id}

Security

PERSON_EARLY_ALERT_WRITE

Sample Post

Code Block
{"success":"true",
 "message":"","results":1,
 "rows":
    [{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "objectStatus":"ACTIVE",
    "courseName":"ENG055",
    "courseTitle":"College ReadingI",
    "courseTermCode":"FA12",
    "emailCC":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":null,
    "earlyAlertSuggestionOtherDescription":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,
    "closedById":null,
    "closedByName":null,
    "noOfResponses":1,
    "earlyAlertReasonIds":
        [{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
        "createdDate":1336003200000,
        "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
        firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Excessive Absences",
    "description":"Excessive Absences",
    "sortOrder":2}],
    "earlyAlertSuggestionIds":
    [{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
    "createdDate":1336003200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Withdraw",
    "description":"",
    "sortOrder":8}],
    "sendEmailToStudent":false}
  ]
}

Returns

EarlyAlert

Code Block
{"success":"true",
 "message":"","results":1,
 "rows":
    [{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
        "createdDate":1347964903568,
    "createdBy":
        {"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
        "firstName":"Demo",
        "lastName":"Coach18"},
    "modifiedDate":1348220503568,
    "modifiedByAdministrator"}
}

Create a Document

POST /ssp/api/1/person/{id}/studentdocument

The {id} in the URL for Document creation can either be an existing Person ID in UUID syntax, or it can be the school's legacy School ID (the school-assigned identifier for the student) for an existing Person.

Security

PERSON_DOCUMENT_WRITE

Sample Post

Code Block
{"file":"http://www.link.com/file.pdf,
 "comment":"Published 2012-04","name":"SSP Article for the League for Innovation",
 "confidentialityLevelId":"b3d077a7-4055-0510-7967-4a09f93a0357",
 "fileName":"2012-04 League article about SSP.pdf"
}

Returns

Document

Code Block
{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
    "createdDate":1382654391683,
    "createdBy":
        {"id":"f02058a40a93b220-76e541a4-4d061263-97d28141-97d13db0505ea445371b0000",
        "firstName":"DemoAmy",
        "lastName":"Coach18Administrator"},
    "objectStatusmodifiedDate":"ACTIVE"1382654391683,
    "courseNamemodifiedBy":"ENG055",
        {"courseTitleid":"College ReadingI",0a93b220-41a4-1263-8141-a445371b0000",
        "courseTermCodefirstName":"FA12Amy",
    "emailCC":null,     "campusIdlastName":"0a640a2a-409d-1271-8140-d10a51770117"Administrator"},
    "earlyAlertReasonOtherDescriptionobjectStatus":null"ACTIVE",
    "earlyAlertSuggestionOtherDescriptionfile":null,
    "comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.Published 2012-04","name":"SSP Article for the League for Innovation",
    "personIdconfidentialityLevelId":"284c2248b3d077a7-87cd4055-342e0510-0c777967-d36444ea3b9b4a09f93a0357",
    "closedDatefileName":null,
    "closedById":null,
    "closedByName":null"2012-04 League article about SSP.pdf",
    "noOfResponsesauthor":1,
    "earlyAlertReasonIds":
        ["Amy Administrator"
}

 

Save a Document

PUT /ssp/api/1/person/{id}/studentdocument/{id}

Security

PERSON_DOCUMENT_WRITE

Sample Post

Code Block
{"id":"b2d112b80a76c6d7-505641eb-a51a13ce-80678141-1fda2849c3e5",
   ec9fb583006a",
    "createdDate":13360032000001382654391683,
  
     "createdBy":
        {"id":"58ba5ee30a93b220-734e41a4-4ae91263-b9c58141-943774b4de41a445371b0000",
        "firstName":"SystemAmy",
        "lastName":"Administrator"},
    "modifiedDate":13360032000001382654391683,
    "modifiedBy":
        {"id":"58ba5ee30a93b220-734e41a4-4ae91263-b9c58141-943774b4de41a445371b0000","
        "firstName":"SystemAmy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "comment":"Published 2012-04","name":"Excessive AbsencesSSP Article for the League for Innovation",
    "descriptionconfidentialityLevelId":"Excessive Absencesb3d077a7-4055-0510-7967-4a09f93a0357",
    "sortOrder":2}]fileName":"2012-04 League article about SSP.pdf",
    "earlyAlertSuggestionIdsauthor":"Amy     [Administrator"}
}

Returns

Document

Code Block
{"id":"b2d111ed0a76c6d7-505641eb-a51a13ce-80468141-5291453e8720ec9fb583006a",
    "createdDate":13360032000001382654391683,
    "createdBy":
        {"id":"58ba5ee30a93b220-734e41a4-4ae91263-b9c58141-943774b4de41a445371b0000",
        "firstName":"SystemAmy",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,":1382654391683,
    "modifiedBy":
        {"id":"0a93b220-41a4-1263-8141-a445371b0000",
        "modifiedByfirstName":"Amy",
        {"idlastName":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 Administrator"},
      "firstNameobjectStatus":"SystemACTIVE",
    "file":null,
    "lastNamecomment":"AdministratorPublished 2012-04"},"name":"SSP Article for the  "objectStatus":"ACTIVELeague for Innovation",
    "nameconfidentialityLevelId":"Withdrawb3d077a7-4055-0510-7967-4a09f93a0357",
    "descriptionfileName":"",2012-04 League article   "sortOrder":8}]about SSP.pdf",
    "sendEmailToStudentauthor":false}
  ]"Amy Administrator"}
}

 

Delete

...

a Document

DELETE /ssp/api/1/person/{id}/earlyAlertstudentdocument/{id}

Security

PERSON_EARLYDOCUMENT_ALERT_DELETEWRITE

Returns

Code Block
{"success" : "true"}

...