AbodeONE

<back to all web services

CreateStudentGroup

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/student_groups
CreateStudentGroup Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
DescriptionbodystringNo
FilterbodyGroupFilterNo
GroupFilter Parameters:
NameParameterData TypeRequiredDescription
IncludesformList<int>No
ExcludesformList<int>No
exprformFilterExpressionNo
FilterExpression Parameters:
NameParameterData TypeRequiredDescription
FieldformstringNo
OpformstringNo
ValueformObjectNo
SubExprformList<FilterExpression>No
CreateStudentGroupResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformStudentGroupDTONo
ResponseStatusformResponseStatusNo
StudentGroupDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
FilterformGroupFilterNo

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.

POST //student_groups HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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: 
							[
								{
									
								}
							]
						}
					]
				}
			]
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		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
		}
	}
}