| Required role: | Admin |
| GET | /student_groups |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<StudentGroupDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Filter | form | GroupFilter | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Includes | form | List<int> | No | |
| Excludes | form | List<int> | No | |
| expr | form | FilterExpression | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Field | form | string | No | |
| Op | form | string | No | |
| Value | form | Object | No | |
| SubExpr | form | List<FilterExpression> | 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.
GET //student_groups HTTP/1.1 Host: api.lsu-staging.abodehms.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
results:
[
{
id: 0,
name: String,
description: String,
filter:
{
includes:
[
0
],
excludes:
[
0
],
expr:
{
field: String,
op: String,
value: {},
subExpr:
[
{
field: String,
op: String,
value: {},
subExpr:
[
{
field: String,
op: String,
value: {},
subExpr:
[
{
}
]
}
]
}
]
}
}
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}