AbodeONE

FindChecks

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
All Verbs	/student/{StudentId}/checks

**FindChecks** Parameters:
Name	Parameter	Data Type	Required
StudentId	path	int?	No
LeaveId	query	int?	No
CheckClass	query	string	No
NightOf	query	DateTime?	No
NightOfStart	query	DateTime?	No
NightOfEnd	query	DateTime?	No
Status	query	string	No

**ChecksResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	List<CheckDTO>	No
ResponseStatus	form	ResponseStatus	No

**CheckDTO** Parameters:
Name	Parameter	Data Type	Required
CheckId	form	int	No
RoomStateId	form	int	No
EntryStamp	form	DateTime?	No
StudentId	form	int	No
Reason	form	string	No
Comments	form	string	No
CheckTypeId	form	int	No
CheckDt	form	DateTime?	No
Grace	form	int	No
CurfewDt	form	DateTime	No
ExcusedBy	form	int	No
Status	form	string	No
CheckClass	form	string	No
LeaveId	form	int	No
NightOf	form	DateTime	No
ViolationDt	form	DateTime	No
ExcusedReason	form	string	No
ExcusedDt	form	DateTime?	No
Imported	form	int	No
CreatedDt	form	DateTime	No
CreatedBy	form	string	No
ModifiedDt	form	DateTime	No
ModifiedBy	form	string	No
CheckTypeName	form	string	No
ExcusedByUser	form	string	No
IsPresent	form	bool?	No

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.

POST //student/{StudentId}/checks HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindChecks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <CheckClass>String</CheckClass>
  <LeaveId>0</LeaveId>
  <NightOf>0001-01-01T00:00:00</NightOf>
  <NightOfEnd>0001-01-01T00:00:00</NightOfEnd>
  <NightOfStart>0001-01-01T00:00:00</NightOfStart>
  <Status>String</Status>
  <StudentId>0</StudentId>
</FindChecks>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChecksResponse 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>
    <CheckDTO>
      <CheckClass>String</CheckClass>
      <CheckDt>0001-01-01T00:00:00</CheckDt>
      <CheckId>0</CheckId>
      <CheckTypeId>0</CheckTypeId>
      <CheckTypeName>String</CheckTypeName>
      <Comments>String</Comments>
      <CreatedBy>String</CreatedBy>
      <CreatedDt>0001-01-01T00:00:00</CreatedDt>
      <CurfewDt>0001-01-01T00:00:00</CurfewDt>
      <EntryStamp>0001-01-01T00:00:00</EntryStamp>
      <ExcusedBy>0</ExcusedBy>
      <ExcusedByUser>String</ExcusedByUser>
      <ExcusedDt>0001-01-01T00:00:00</ExcusedDt>
      <ExcusedReason>String</ExcusedReason>
      <Grace>0</Grace>
      <Imported>0</Imported>
      <IsPresent>false</IsPresent>
      <LeaveId>0</LeaveId>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
      <NightOf>0001-01-01T00:00:00</NightOf>
      <Reason>String</Reason>
      <RoomStateId>0</RoomStateId>
      <Status>String</Status>
      <StudentId>0</StudentId>
      <ViolationDt>0001-01-01T00:00:00</ViolationDt>
    </CheckDTO>
  </Result>
</ChecksResponse>