AbodeONE

<back to all web services

GetAttendanceScan

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/attendance_scans/{AttendanceScanId}
GetAttendanceScan Parameters:
NameParameterData TypeRequiredDescription
AttendanceScanIdpathintNo
GetAttendanceScanResponse 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 .xml suffix or ?format=xml

HTTP + XML

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

GET //attendance_scans/{AttendanceScanId} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAttendanceScanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <AttendanceScanId>0</AttendanceScanId>
    <BuildingName>String</BuildingName>
    <Classification>String</Classification>
    <Credits>0</Credits>
    <DisplayName>String</DisplayName>
    <EntryYear>String</EntryYear>
    <Ethnicity>String</Ethnicity>
    <EventId>0</EventId>
    <EventName>String</EventName>
    <FirstName>String</FirstName>
    <Gender>String</Gender>
    <HomeCountry>String</HomeCountry>
    <HomeState>String</HomeState>
    <IsApproved>false</IsApproved>
    <IsManualEntry>false</IsManualEntry>
    <IsRosterFound>false</IsRosterFound>
    <LastName>String</LastName>
    <Major>String</Major>
    <Metatags>String</Metatags>
    <MobileSrcCode>String</MobileSrcCode>
    <Notes>String</Notes>
    <RawScanCode>String</RawScanCode>
    <Room>String</Room>
    <ScanDt>0001-01-01T00:00:00</ScanDt>
    <ScannedBy>String</ScannedBy>
    <ScannerCode>String</ScannerCode>
    <SchoolId>String</SchoolId>
    <StudentId>0</StudentId>
    <TargetModule>String</TargetModule>
    <UploadDt>0001-01-01T00:00:00</UploadDt>
  </Result>
</GetAttendanceScanResponse>