AbodeONE

<back to all web services

FindInspections

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/inspections
FindInspections Parameters:
NameParameterData TypeRequiredDescription
TermIdqueryint?No
BuildingIdsqueryArrayOfIntNo
StudentIdsqueryArrayOfIntNo
SchoolidsqueryArrayOfStringNo
ResidentIdqueryint?No
TypequeryInspectionType?No
InspectionType Enum:
MoveIn
MoveOut
FindInspectionsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<InspectionDTO>No
ResponseStatusformResponseStatusNo
InspectionDTO Parameters:
NameParameterData TypeRequiredDescription
InspectionIdformintNo
StudentIdformintNo
RoomIdformintNo
ResidentIdformintNo
ReservationIdformintNo
InspectionDtformDateTimeNo
RepairsNeededformstringNo
CommentsformstringNo
StudentSignatureTextformstringNo
RaSignatureTextformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
ModifiedByformstringNo
DetailsformList<InspectionDetailDTO>No
InspectionDetailDTO Parameters:
NameParameterData TypeRequiredDescription
InspectionDetailIdformint?No
InspectionIdformintNo
NameformstringNo
OrderformintNo
ItemStateformInspectionStateEnum?No
NotesformstringNo
InspectionStateEnum Enum:
Good
Problem

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

<FindInspectionsResponse 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>
    <InspectionDTO>
      <Comments>String</Comments>
      <CreatedBy>String</CreatedBy>
      <CreatedDt>0001-01-01T00:00:00</CreatedDt>
      <Details>
        <InspectionDetailDTO>
          <InspectionDetailId>0</InspectionDetailId>
          <InspectionId>0</InspectionId>
          <ItemState>Good</ItemState>
          <Name>String</Name>
          <Notes>String</Notes>
          <Order>0</Order>
        </InspectionDetailDTO>
      </Details>
      <InspectionDt>0001-01-01T00:00:00</InspectionDt>
      <InspectionId>0</InspectionId>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
      <RaSignatureText>String</RaSignatureText>
      <RepairsNeeded>String</RepairsNeeded>
      <ReservationId>0</ReservationId>
      <ResidentId>0</ResidentId>
      <RoomId>0</RoomId>
      <StudentId>0</StudentId>
      <StudentSignatureText>String</StudentSignatureText>
    </InspectionDTO>
  </Result>
</FindInspectionsResponse>