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

<UploadCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <CheckClass>String</CheckClass>
  <CheckDt>0001-01-01T00:00:00</CheckDt>
  <CheckTypeId>0</CheckTypeId>
  <CheckTypeName>String</CheckTypeName>
  <Comments>String</Comments>
  <ExcusedBy>0</ExcusedBy>
  <ExcusedByUser>String</ExcusedByUser>
  <ExcusedDt>0001-01-01T00:00:00</ExcusedDt>
  <ExcusedReason>String</ExcusedReason>
  <Grace>0</Grace>
  <LeaveId>0</LeaveId>
  <NightOf>0001-01-01T00:00:00</NightOf>
  <Reason>String</Reason>
  <RoomStateId>0</RoomStateId>
  <Status>String</Status>
  <StudentId>0</StudentId>
  <ResidentChecks>
    <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>
  </ResidentChecks>
</UploadCheck>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckResponse 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>
    <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>
  </Result>
</CheckResponse>