AbodeONE

<back to all web services

GetDiscipline

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/disciplines/{Id}
GetDiscipline Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetDisciplineResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformDisciplineDTONo
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 //disciplines/{Id} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
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
		}
	}
}