| Required role: | Admin |
| All Verbs | /students/{StudentId}/communications |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | IEnumerable<StudentCommunicationDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Transport | form | string | No | |
| ToAddress | form | string | No | |
| FromAddress | form | string | No | |
| Subject | form | string | No | |
| PlainText | form | string | No | |
| HtmlText | form | string | No | |
| ShortText | form | string | No | |
| SentDt | form | DateTime | No |
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
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.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"}}}