The Document API allows a user of the system to attach a document to a student's record. The supported document types are pdf, doc, jpg, gif, rtf, jpeg, png, xls, xlsx, docx, txt and csv. Document storage should be on the filesystem with metadata kept in the database. The filesystem location for document storage should not be web accessible. The only means to manage these documents will be through the API.
Note: Research required of best way to download data stream to client. The API below will require modification depending on solution determined.
Get All Documents for a Person
GET /ssp/api/1/person/{id}/document
Security
PERSON_DOCUMENT_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>return
limit : Maximum number of results to return<br>return
sort : Property name<br>name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
ReturnsList<Document>
| Code Block |
|---|
[{"idsuccess" : "6201b18d-9d1d-48d3-82d4-092e52ad676btrue", "results" : "100", "createdByIdrows" : [{"id" : "91f46e39cb9ae287-cea80b28-422b4a3b-b215aece-00f6bcf5d2802c6d1d974443", "createdDatecreatedBy" : "1332216000000", {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDatefirstName" : "1332216000000John", "objectStatus "lastName" : "ACTIVEDoe"}, "earlyAlertIdcreatedDate" : "1765cf54-b9c9-4821-8946-d09731c7cf8d1332216000000", "earlyAlertOutreachIdsmodifiedBy" : [{"id" : "198c1b8091f46e39-fee5cea8-4ece422b-aefb-97c23beac116"},b215-00f6bcf5d280", "firstName" : "John", { "idlastName" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074Doe"}], "earlyAlertOutcomeIdmodifiedDate" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f21332216000000", "earlyAlertOutcomeOtherDescriptionobjectStatus" : null,"ACTIVE", "earlyAlertReferralIdsname" : "High School Transcript", [{"idnote" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"}This is Billy's high school transcript from Oakwood High School", "confidentialityLevel" : {"id" : "30a17f21c57f11e1-6aaa7ef2-49fb4989-8b0b9ac2-bd53585ed3ac7b0690563995"}], "comment "name" : "Follow-up via Phone.EVERYONE"}}, Appt scheduled."}, {"id" : "6201b18d3a9d3bee-9d1d1acf-48d34af2-82d492b6-092e52ad676b10bf6d6b4da0", "createdBy" : {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDatefirstName" : "1332216000000John", "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280",Doe"}, "modifiedDatecreatedDate" : "1332216000000", "objectStatusmodifiedBy" : "ACTIVE", {"earlyAlertIdid" : "1765cf5491f46e39-b9c9cea8-4821422b-8946b215-d09731c7cf8d00f6bcf5d280", "earlyAlertOutreachIdsfirstName" : "John", [{"id "lastName" : "88b9bd08-5814-44d4-8ff2-1667597f8bba"}Doe"}, "modifiedDate" : "1332216000000", {"idobjectStatus" : "6373d1ef-d2a2-48a7-aa78-c0b4a29da3ef"}],ACTIVE", "earlyAlertOutcomeIdname" : "00c42b84-88fe-4bc9-8cef-723cd6a26c65Email", "earlyAlertOutcomeOtherDescriptionnote" : "Student stopped byEmail received from Billy on 04/12/12 outlining struggles during Spring term.", "earlyAlertReferralIdsconfidentialityLevel" : [ {"id" : "b2f52c40c57f11e1-82dd7ef2-4b094989-9ec09ac2-06f98c0c54c97b0690563995"}, { "idname" : "6ef6aca6-4fd6-4bd2-9cf2-bea4c73a25f4EVERYONE"}]}, ... "comment" : null} ] } |
Get a Document
GET /ssp/api/1/person/{id}/document/{id}
Security
PERSON_DOCUMENT_READ
Returns
Document
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDatefirstName" : "1332216000000John",
"modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
"modifiedDatecreatedDate" : "1332216000000",
"objectStatusmodifiedBy" : "ACTIVE",
{"earlyAlertIdid" : "1765cf5491f46e39-b9c9cea8-4821422b-8946b215-d09731c7cf8d00f6bcf5d280",
"earlyAlertOutreachIds" : [{"idfirstName" : "198c1b80-fee5-4ece-aefb-97c23beac116"},John",
{"idlastName" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074Doe"}],
"earlyAlertOutcomeIdmodifiedDate" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f21332216000000",
"earlyAlertOutcomeOtherDescriptionobjectStatus" : null"ACTIVE",
"earlyAlertReferralIdsname" : "High School Transcript",
[{"idnote" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" :
{"id" : "30a17f21c57f11e1-6aaa7ef2-49fb4989-8b0b9ac2-bd53585ed3ac7b0690563995"}],
"comment" : "Follow-up via Phone. "name" Appt: scheduled."EVERYONE"}} |
...
Create a Document
POST /ssp/api/1/person/{id}/document
Security
PERSON_DOCUMENT_WRITE
Sample Post
| Code Block |
|---|
{"earlyAlertId"name" : "High School Transcript",
"note" : "1765cf54-b9c9-4821-8946-d09731c7cf8dThis is Billy's high school transcript from Oakwood High School",
"earlyAlertOutreachIdsconfidentialityLevel" :
[{"id" : "198c1b80c57f11e1-fee57ef2-4ece4989-aefb9ac2-97c23beac1167b0690563995"},
{ "idname" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeIdEVERYONE"}} |
Returns
Document
| Code Block |
|---|
{"id" : "85fa1583cb9ae287-74b40b28-47fe4a3b-9eddaece-e5c9da9e11f22c6d1d974443", "earlyAlertOutcomeOtherDescriptioncreatedBy" : null, "earlyAlertReferralIds" : [{"id" : "4139a3ba91f46e39-b7facea8-4ff3422b-ab09b215-43cf3d9de8a600f6bcf5d280"}, { "idfirstName" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}]John", "comment" : "Follow-up via Phone. Appt scheduled."} |
Returns
Document
| Code Block |
|---|
{"id""lastName" : "6201b18d-9d1d-48d3-82d4-092e52ad676b"Doe"}, "createdByIdcreatedDate" : "91f46e39-cea8-422b-b215-00f6bcf5d2801332216000000", "createdDatemodifiedBy" : "1332216000000", {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatusfirstName" : "ACTIVEJohn", "earlyAlertId" : "1765cf54-b9c9-4821-8946-d09731c7cf8d", "earlyAlertOutreachIdslastName" : "Doe"}, [{"idmodifiedDate" : "198c1b80-fee5-4ece-aefb-97c23beac116"}1332216000000", {"idobjectStatus" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}]ACTIVE", "earlyAlertOutcomeIdname" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2High School Transcript", "earlyAlertOutcomeOtherDescriptionnote" : null,"This "earlyAlertReferralIds" : [{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},is Billy's high school transcript from Oakwood High School", "confidentialityLevel" : {"id" : "30a17f21c57f11e1-6aaa7ef2-49fb4989-8b0b9ac2-bd53585ed3ac7b0690563995"}], "comment" : "Follow-up via Phone. "name" Appt: scheduled."EVERYONE"}} |
Save a Document
PUT /ssp/api/1/person/{id}/document/{id}
Security
PERSON_DOCUMENT_WRITE
Sample Post
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDatefirstName" : "1332216000000John",
"modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280",Doe"},
"modifiedDatecreatedDate" : "1332216000000",
"objectStatusmodifiedBy" : "ACTIVE",
{"earlyAlertIdid" : "1765cf5491f46e39-b9c9cea8-4821422b-8946b215-d09731c7cf8d00f6bcf5d280",
"earlyAlertOutreachIds"
: [{"idfirstName" : "198c1b80-fee5-4ece-aefb-97c23beac116"}John",
{ "idlastName" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074Doe"}],
"earlyAlertOutcomeIdmodifiedDate" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f21332216000000",
"earlyAlertOutcomeOtherDescriptionobjectStatus" : null"ACTIVE",
"earlyAlertReferralIdsname" : "High School Transcript",
[{"idnote" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" :
{"id" : "30a17f21c57f11e1-6aaa7ef2-49fb4989-8b0b9ac2-bd53585ed3ac7b0690563995"}],
"comment" : "Follow-up via Phone. "name" Appt: scheduled."EVERYONE"}} |
Returns
Document
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDatefirstName" : "1332216000000John",
"modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"},
"modifiedDatecreatedDate" : "1332216000000",
"objectStatusmodifiedBy" : "ACTIVE",
{"earlyAlertIdid" : "1765cf5491f46e39-b9c9cea8-4821422b-8946b215-d09731c7cf8d00f6bcf5d280",
"earlyAlertOutreachIds"
: [{"idfirstName" : "198c1b80-fee5-4ece-aefb-97c23beac116"}John",
{ "idlastName" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074Doe"}],
"earlyAlertOutcomeIdmodifiedDate" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f21332216000000",
"earlyAlertOutcomeOtherDescriptionobjectStatus" : null"ACTIVE",
"earlyAlertReferralIdsname" : "High School Transcript",
[{"idnote" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" :
{"id" : "30a17f21c57f11e1-6aaa7ef2-49fb4989-8b0b9ac2-bd53585ed3ac7b0690563995"}],
"comment" : "Follow-up via Phone. "name" Appt: scheduled."EVERYONE"}} |
Delete a Document
DELETE /ssp/api/1/person/{id}/document/{id}
Security
PERSON_DOCUMENT_DELETE
Returns
| Code Block |
|---|
{"success" : "true"} |
...