AbodeONE

<back to all web services

CreateIncidentsStudent

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/incidentsStudents
CreateIncidentsStudent Parameters:
NameParameterData TypeRequiredDescription
IncidentIdbodyintNo
StudentIdbodyintNo
StudentConferredbodyboolNo
ParentsContactedbodyDateTime?No
CreateIncidentsStudentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformIncidentRelatedStudentDTONo
ResponseStatusformResponseStatusNo
IncidentRelatedStudentDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
IncidentIdformintNo
StudentIdformintNo
StudentResponseformstringNo
StudentConferredformboolNo
ParentsContactedformDateTime?No
NameformstringNo
disciplineIdformlong?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.

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

{
	incidentId: 0,
	studentId: 0,
	studentConferred: False,
	parentsContacted: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 0,
		incidentId: 0,
		studentId: 0,
		studentResponse: String,
		studentConferred: False,
		parentsContacted: 0001-01-01,
		name: String,
		disciplineId: 0
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}