AbodeONE

<back to all web services

FindStudentGroup

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/student_groups
FindStudentGroupResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<StudentGroupDTO>No
ResponseStatusformResponseStatusNo
StudentGroupDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
FilterformGroupFilterNo
GroupFilter Parameters:
NameParameterData TypeRequiredDescription
IncludesformList<int>No
ExcludesformList<int>No
exprformFilterExpressionNo
FilterExpression Parameters:
NameParameterData TypeRequiredDescription
FieldformstringNo
OpformstringNo
ValueformObjectNo
SubExprformList<FilterExpression>No

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

HTTP + 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.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
		}
	}
}