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.
Get All Documents for a Person
...
List<Document>
| Code Block |
|---|
[{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"earlyAlertIdname" : "1765cf54-b9c9-4821-8946-d09731c7cf8d",
"earlyAlertOutreachIds" :
[{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"}High School Transcript",
{"idnote" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
"earlyAlertOutcomeOtherDescription" : null,
"earlyAlertReferralIds" :
[{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
{"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"comment" : "Follow-up via Phone. Appt scheduled.This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" : "EVERYONE"},
{"id" : "6201b18d3a9d3bee-9d1d1acf-48d34af2-82d492b6-092e52ad676b10bf6d6b4da0",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"earlyAlertIdname" : "1765cf54-b9c9-4821-8946-d09731c7cf8dEmail",
"earlyAlertOutreachIdsnote" :
[{"id" : "88b9bd08-5814-44d4-8ff2-1667597f8bba"},
{"id" : "6373d1ef-d2a2-48a7-aa78-c0b4a29da3ef"}],
"earlyAlertOutcomeId" : "00c42b84-88fe-4bc9-8cef-723cd6a26c65",
"earlyAlertOutcomeOtherDescription" : "Student stopped by"Email received from Billy on 04/12/12 outlining struggles during Spring term.",
"earlyAlertReferralIdsconfidentialityLevel" :
[{"id" : "b2f52c40-82dd-4b09-9ec0-06f98c0c54c9"EVERYONE"},
{"id" : "6ef6aca6-4fd6-4bd2-9cf2-bea4c73a25f4"}],
"comment" : null}
...
] |
Get a Document
GET /ssp/api/1/person/{id}/document/{id}
...
Document
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"earlyAlertId" : "1765cf54-b9c9-4821-8946-d09731c7cf8d",
"earlyAlertOutreachIds" :
[{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"}"name" : "High School Transcript",
{"idnote" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
"earlyAlertOutcomeOtherDescription" : null,
"earlyAlertReferralIds" :
[{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
{"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"comment" : "Follow-up via Phone. Appt scheduled.This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" : "EVERYONE"} |
Create a Document
POST /ssp/api/1/person/{id}/document
Sample Post
| Code Block |
|---|
{"earlyAlertIdname" : "1765cf54-b9c9-4821-8946-d09731c7cf8d",
"earlyAlertOutreachIds" :
[{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
{"idHigh School Transcript",
"note" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
"earlyAlertOutcomeOtherDescription" : null,
"earlyAlertReferralIds" :
[{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
{"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"comment" : "Follow-up via Phone. Appt scheduled."}This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" : "EVERYONE"} |
Returns
Document
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"earlyAlertId" : "1765cf54-b9c9-4821-8946-d09731c7cf8d",
"earlyAlertOutreachIds" :
[{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
{"id"name" : "High School Transcript",
"note" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
"earlyAlertOutcomeOtherDescription" : null,
"earlyAlertReferralIds" :
[{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
{"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"comment" : "Follow-up via Phone. Appt scheduled.This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" : "EVERYONE"} |
Save a Document
PUT /ssp/api/1/person/{id}/document/{id}
Sample Post
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"earlyAlertId" : "1765cf54-b9c9-4821-8946-d09731c7cf8d",
"earlyAlertOutreachIds" :
[{"id" : "198c1b80-fee5-4ece-aefb-97c23beac116"},
{"id"name" : "High School Transcript",
"note" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
"earlyAlertOutcomeOtherDescription" : null,
"earlyAlertReferralIds" :
[{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
{"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"comment" : "Follow-up via Phone. Appt scheduled."}This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" : "EVERYONE"} |
Returns
Document
| Code Block |
|---|
{"id" : "6201b18dcb9ae287-9d1d0b28-48d34a3b-82d4aece-092e52ad676b2c6d1d974443",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"earlyAlertId" : "1765cf54-b9c9-4821-8946-d09731c7cf8d",
"earlyAlertOutreachIdsname" :
[{"id"High :School "198c1b80-fee5-4ece-aefb-97c23beac116"},
Transcript",
{"idnote" : "3fd7e44d-dc33-4519-9e93-dc85d24f9074"}],
"earlyAlertOutcomeId" : "85fa1583-74b4-47fe-9edd-e5c9da9e11f2",
"earlyAlertOutcomeOtherDescription" : null,
"earlyAlertReferralIds" :
[{"id" : "4139a3ba-b7fa-4ff3-ab09-43cf3d9de8a6"},
{"id" : "30a17f21-6aaa-49fb-8b0b-bd53585ed3ac"}],
"comment" : "Follow-up via Phone. Appt scheduled.This is Billy's high school transcript from Oakwood High School",
"confidentialityLevel" : "EVERYONE"} |
Delete a Document
DELETE /ssp/api/1/person/{id}/document/{id}
...