| Required role: | Admin |
| POST | /disciplines |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | body | string | No | |
| StudentId | body | int | No | |
| Description | body | string | No | |
| DisciplineDate | body | DateTime | No | |
| Types | body | IEnumerable<DisciplineTypeDTO> | No | |
| Comments | body | string | No | |
| Notes | body | string | No | |
| Attachment | body | byte[] | No | |
| LetterIssued | body | bool | No | |
| Probation | body | bool | No | |
| Action | body | string | No | |
| IssuingDean | body | string | No | |
| Resolved | body | bool | No | |
| ProbationStart | body | DateTime? | No | |
| ProbationEnd | body | DateTime? | No | |
| IncidentId | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| DefaultCharge | form | int? | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | DisciplineDTO | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Title | form | string | No | |
| StudentId | form | int | No | |
| Description | form | string | No | |
| DisciplineDate | form | DateTime | No | |
| Types | form | IEnumerable<DisciplineTypeDTO> | No | |
| Comments | form | string | No | |
| Notes | form | string | No | |
| Attachment | form | byte[] | No | |
| LetterIssued | form | bool | No | |
| Probation | form | bool | No | |
| Action | form | string | No | |
| IssuingDean | form | string | No | |
| Resolved | form | bool | No | |
| ProbationStart | form | DateTime? | No | |
| ProbationEnd | form | DateTime? | No | |
| IncidentId | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreatedDt | form | DateTime | No | |
| CreatedBy | form | string | No | |
| ModifiedDt | form | DateTime? | No | |
| ModifiedBy | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST //disciplines HTTP/1.1
Host: api.lsu.abodehms.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
title: String,
studentId: 0,
description: String,
disciplineDate: 0001-01-01,
comments: String,
notes: String,
attachment: AA==,
letterIssued: False,
probation: False,
action: String,
issuingDean: String,
resolved: False,
probationStart: 0001-01-01,
probationEnd: 0001-01-01,
incidentId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
id: 0,
title: String,
studentId: 0,
description: String,
disciplineDate: 0001-01-01,
comments: String,
notes: String,
attachment: AA==,
letterIssued: False,
probation: False,
action: String,
issuingDean: String,
resolved: False,
probationStart: 0001-01-01,
probationEnd: 0001-01-01,
incidentId: 0,
createdDt: 0001-01-01,
createdBy: String,
modifiedDt: 0001-01-01,
modifiedBy: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}