AbodeONE

<back to all web services

FindAttendanceRoster

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/attendance_roster
FindAttendanceRoster Parameters:
NameParameterData TypeRequiredDescription
TermIdqueryint?No
TargetModulequeryTargetModuleEnumNo
BuildingIdsqueryArrayOfIntNo
TargetModuleEnum Enum:
worship
chapel
career
curfew
FindAttendanceRosterResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<AttendanceRosterDTO>No
ResponseStatusformResponseStatusNo
AttendanceRosterDTO Parameters:
NameParameterData TypeRequiredDescription
TargetModuleformstringNo
FirstNameformstringNo
LastNameformstringNo
ImageFileformstringNo
SchoolidformstringNo
StudentIdformintNo
ScanCodeformstringNo

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

{
	results: 
	[
		{
			targetModule: String,
			firstName: String,
			lastName: String,
			imageFile: String,
			schoolid: String,
			studentId: 0,
			scanCode: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}