AbodeONE

<back to all web services

UploadCheck

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/check
UploadCheck Parameters:
NameParameterData TypeRequiredDescription
ResidentChecksbodyList<CheckDTO>No
CreateCheck Parameters:
NameParameterData TypeRequiredDescription
RoomStateIdformintNo
StudentIdformintNo
ReasonformstringNo
CommentsformstringNo
CheckTypeIdformintNo
CheckDtformDateTime?No
GraceformintNo
ExcusedByformintNo
StatusformstringNo
CheckClassformstringNo
LeaveIdformintNo
NightOfformDateTimeNo
ExcusedReasonformstringNo
ExcusedDtformDateTime?No
CheckTypeNameformstringNo
ExcusedByUserformstringNo
CheckDTO Parameters:
NameParameterData TypeRequiredDescription
CheckIdformintNo
RoomStateIdformintNo
EntryStampformDateTime?No
StudentIdformintNo
ReasonformstringNo
CommentsformstringNo
CheckTypeIdformintNo
CheckDtformDateTime?No
GraceformintNo
CurfewDtformDateTimeNo
ExcusedByformintNo
StatusformstringNo
CheckClassformstringNo
LeaveIdformintNo
NightOfformDateTimeNo
ViolationDtformDateTimeNo
ExcusedReasonformstringNo
ExcusedDtformDateTime?No
ImportedformintNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
ModifiedByformstringNo
CheckTypeNameformstringNo
ExcusedByUserformstringNo
IsPresentformbool?No
CheckResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformCheckDTONo
ResponseStatusformResponseStatusNo

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

{
	residentChecks: 
	[
		{
			checkId: 0,
			roomStateId: 0,
			entryStamp: 0001-01-01,
			studentId: 0,
			reason: String,
			comments: String,
			checkTypeId: 0,
			checkDt: 0001-01-01,
			grace: 0,
			curfewDt: 0001-01-01,
			excusedBy: 0,
			status: String,
			checkClass: String,
			leaveId: 0,
			nightOf: 0001-01-01,
			violationDt: 0001-01-01,
			excusedReason: String,
			excusedDt: 0001-01-01,
			imported: 0,
			createdDt: 0001-01-01,
			createdBy: String,
			modifiedDt: 0001-01-01,
			modifiedBy: String,
			checkTypeName: String,
			excusedByUser: String,
			isPresent: False
		}
	],
	roomStateId: 0,
	studentId: 0,
	reason: String,
	comments: String,
	checkTypeId: 0,
	checkDt: 0001-01-01,
	grace: 0,
	excusedBy: 0,
	status: String,
	checkClass: String,
	leaveId: 0,
	nightOf: 0001-01-01,
	excusedReason: String,
	excusedDt: 0001-01-01,
	checkTypeName: String,
	excusedByUser: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		checkId: 0,
		roomStateId: 0,
		entryStamp: 0001-01-01,
		studentId: 0,
		reason: String,
		comments: String,
		checkTypeId: 0,
		checkDt: 0001-01-01,
		grace: 0,
		curfewDt: 0001-01-01,
		excusedBy: 0,
		status: String,
		checkClass: String,
		leaveId: 0,
		nightOf: 0001-01-01,
		violationDt: 0001-01-01,
		excusedReason: String,
		excusedDt: 0001-01-01,
		imported: 0,
		createdDt: 0001-01-01,
		createdBy: String,
		modifiedDt: 0001-01-01,
		modifiedBy: String,
		checkTypeName: String,
		excusedByUser: String,
		isPresent: False
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}