AbodeONE

<back to all web services

FindDisciplines

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/students/{StudentId}/disciplines
GET/disciplines
FindDisciplines Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathint?No
TermIdqueryint?No
FindDisciplinesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformIEnumerable<DisciplineDTO>No
ResponseStatusformResponseStatusNo
DisciplineDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringNo
StudentIdformintNo
DescriptionformstringNo
DisciplineDateformDateTimeNo
TypesformIEnumerable<DisciplineTypeDTO>No
CommentsformstringNo
NotesformstringNo
Attachmentformbyte[]No
LetterIssuedformboolNo
ProbationformboolNo
ActionformstringNo
IssuingDeanformstringNo
ResolvedformboolNo
ProbationStartformDateTime?No
ProbationEndformDateTime?No
IncidentIdformint?No
Tracked Parameters:
NameParameterData TypeRequiredDescription
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo
DisciplineTypeDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DefaultChargeformint?No
NameformstringNo

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 //students/{StudentId}/disciplines HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}