AbodeONE

<back to all web services

CreateAttendanceScan

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/attendance_scans
CreateAttendanceScan Parameters:
NameParameterData TypeRequiredDescription
StudentIdbodyint?No
EventIdbodyint?No
EventNamebodystringNo
TargetModulebodyTargetModuleEnum?No
RawScanCodebodystringNo
SchoolidbodystringNo
ScanDtbodyDateTime?No
ScannerCodebodystringNo
MobileSrcCodebodystringNo
ScannedBybodystringNo
Creditsbodyint?No
MetatagsbodystringNo
IsRosterFoundbodybool?No
IsApprovedbodybool?No
IsManualEntrybodybool?No
NotesbodystringNo
TargetModuleEnum Enum:
worship
chapel
career
curfew
CreateAttendanceScanResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformAttendanceScanDTONo
ResponseStatusformResponseStatusNo
AttendanceScanDTO Parameters:
NameParameterData TypeRequiredDescription
AttendanceScanIdformintNo
StudentIdformint?No
EventIdformint?No
TargetModuleformstringNo
RawScanCodeformstringNo
SchoolIdformstringNo
ScanDtformDateTime?No
ScannerCodeformstringNo
MobileSrcCodeformstringNo
ScannedByformstringNo
Creditsformint?No
MetatagsformstringNo
IsRosterFoundformboolNo
IsApprovedformboolNo
IsManualEntryformboolNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
NotesformstringNo
UploadDtformDateTime?No
GenderformstringNo
EthnicityformstringNo
EntryYearformstringNo
BuildingNameformstringNo
RoomformstringNo
HomeStateformstringNo
HomeCountryformstringNo
EventNameformstringNo
ClassificationformstringNo
MajorformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //attendance_scans HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"studentId":0,"eventId":0,"eventName":"String","targetModule":"worship","rawScanCode":"String","schoolid":"String","scanDt":"0001-01-01T00:00:00.0000000","scannerCode":"String","mobileSrcCode":"String","scannedBy":"String","credits":0,"metatags":"String","isRosterFound":false,"isApproved":false,"isManualEntry":false,"notes":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"attendanceScanId":0,"studentId":0,"eventId":0,"targetModule":"String","rawScanCode":"String","schoolId":"String","scanDt":"0001-01-01T00:00:00.0000000","scannerCode":"String","mobileSrcCode":"String","scannedBy":"String","credits":0,"metatags":"String","isRosterFound":false,"isApproved":false,"isManualEntry":false,"firstName":"String","lastName":"String","displayName":"String","notes":"String","uploadDt":"0001-01-01T00:00:00.0000000","gender":"String","ethnicity":"String","entryYear":"String","buildingName":"String","room":"String","homeState":"String","homeCountry":"String","eventName":"String","classification":"String","major":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}