AbodeONE

<back to all web services

FindStudentCommunications

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/students/{StudentId}/communications
FindStudentCommunications Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathintNo
FindStudentCommunicationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformIEnumerable<StudentCommunicationDTO>No
ResponseStatusformResponseStatusNo
StudentCommunicationDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TransportformstringNo
ToAddressformstringNo
FromAddressformstringNo
SubjectformstringNo
PlainTextformstringNo
HtmlTextformstringNo
ShortTextformstringNo
SentDtformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //students/{StudentId}/communications HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"studentId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}