Get All Documents for a Person
GET /ssp/api/1/person/{id}/studentdocument
Security
PERSON_DOCUMENT_READ
Returns
{"success":"true",
"message":"",
"results":1,
"rows":
[{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
"createdDate":1382654391683,
"createdBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1382654391683,
"modifiedBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"file":null,
"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",
"author":"Amy Administrator"}
]
}
Get a Document
GET /ssp/api/1/person/{id}/studentdocument/{id}
Security
PERSON_DOCUMENT_READ
Returns
Document
{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
"createdDate":1382654391683,
"createdBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1382654391683,
"modifiedBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"file":null,
"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",
"author":"Amy Administrator"}
}
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
{"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
{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
"createdDate":1382654391683,
"createdBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1382654391683,
"modifiedBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"file":null,
"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",
"author":"Amy Administrator"
}
Save a Document
PUT /ssp/api/1/person/{id}/studentdocument/{id}
Security
PERSON_DOCUMENT_WRITE
Sample Post
{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
"createdDate":1382654391683,
"createdBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1382654391683,
"modifiedBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"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",
"author":"Amy Administrator"}
}
Returns
Document
{"id":"0a76c6d7-41eb-13ce-8141-ec9fb583006a",
"createdDate":1382654391683,
"createdBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1382654391683,
"modifiedBy":
{"id":"0a93b220-41a4-1263-8141-a445371b0000",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"file":null,
"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",
"author":"Amy Administrator"}
}
Delete a Document
DELETE /ssp/api/1/person/{id}/studentdocument/{id}
Security
PERSON_DOCUMENT_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}