Page Comparison

...

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

Security

PERSON_EARLY_ALERTDOCUMENT_READ

Parameters

status : ALL, ACTIVE, INACTIVEstart : 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)

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",SSP Article for the League "emailCC":nullfor Innovation",
    "campusIdconfidentialityLevelId":"0a640a2ab3d077a7-409d4055-12710510-81407967-d10a517701174a09f93a0357",
    "earlyAlertReasonOtherDescriptionconfidentialityLevelName":null,"Custom CL    "earlyAlertSuggestionOtherDescription":null,3", 
    "commentfileName":"Do2012-04 toLeague lackarticle of attendance and low test scores, he should consider withdrawing from this class.about SSP.pdf",
    "personIdauthor":"284c2248-87cd-342e-0c77-d36444ea3b9b",
    "closedDate":null,Amy Administrator"}
    "closedById":null]
}

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",
    "closedByNamecreatedDate":null1382654391683,
    "noOfResponsescreatedBy":1,
        {"earlyAlertReasonIdsid":"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-943774b4de41Published 2012-04","name":"SSP Article for the League for Innovation",
   firstName "confidentialityLevelId":"Systemb3d077a7-4055-0510-7967-4a09f93a0357",

       "lastNameconfidentialityLevelName":"AdministratorCustom CL 3"},     "objectStatus "fileName":"ACTIVE",
    "name":"Excessive Absences"2012-04 League article about SSP.pdf",
    "descriptionauthor":"ExcessiveAmy 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":1347964903568Administrator"} }

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",
 "confidentialityLevelName":"Custom CL 3", 
 "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"},
    "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":null,
    "campusId":"0a640a2a-409d-1271-8140-d10a51770117",
    "earlyAlertReasonOtherDescription":nullSSP Article for the League for Innovation",
    "earlyAlertSuggestionOtherDescriptionconfidentialityLevelId":null"b3d077a7-4055-0510-7967-4a09f93a0357",
    "commentconfidentialityLevelName":"DoCustom to lack of attendance and low test scores, he should consider withdrawing from this class.",
    "personId":"284c2248-87cd-342e-0c77-d36444ea3b9bCL 3",  "fileName":"2012-04 League article about SSP.pdf",
    "author":"Amy Administrator"
}

Save a Document

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

Security

PERSON_DOCUMENT_WRITE

Sample Post

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",
    "modifiedBy"comment":"Published 2012-04","name":"SSP Article   for the League for Innovation",
    {"idconfidentialityLevelId":"58ba5ee3b3d077a7-734e4055-4ae90510-b9c57967-943774b4de414a09f93a0357","
    "confidentialityLevelName":"Custom CL   firstName3",  "fileName":"System2012-04 League article about SSP.pdf",
    "author":"Amy    "lastName":"Administrator"}Administrator"}
}

Returns

Document

Code Block

{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
    "objectStatuscreatedDate":"ACTIVE"1382654391683,
    "namecreatedBy":"Excessive Absences",
        {"descriptionid":"Excessive Absences",0a93b220-41a4-1263-8141-a445371b0000",
        "sortOrderfirstName":2}],
"Amy",
   "earlyAlertSuggestionIds":     [{"idlastName":"b2d111ed-5056-a51a-8046-5291453e8720"Administrator"},
    "createdDatemodifiedDate":13360032000001382654391683,
    "createdBymodifiedBy":
        {"id":"58ba5ee30a93b220-734e41a4-4ae91263-b9c58141-943774b4de41a445371b0000",
        "firstName":"SystemAmy",
        "lastName":"Administrator"},
    "modifiedDate":1336003200000,
    "modifiedBy":
   
    {"idobjectStatus":"58ba5ee3-734e-4ae9-b9c5-943774b4de41ACTIVE",
    "file":null,
    "firstNamecomment":"SystemPublished 2012-04","name":"SSP Article for the League     "lastName":"Administrator"}for Innovation",
    "objectStatusconfidentialityLevelId":"ACTIVE"b3d077a7-4055-0510-7967-4a09f93a0357",
    "nameconfidentialityLevelName":"WithdrawCustom CL 3",     "description "fileName":"",2012-04 League article about  "sortOrder":8}]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"}

...

Versions Compared

Old Version 1

New Version Current

Key

Get a Document

Get an Early Alert

Create an Early Alert

Save an Early Alert

Create a Document

Save a Document

Delete

a Document