STstreet
Inspections

Get all Inspections

Changed on

This endpoint retrieves multiple paginated inspections along with meta and pagination information.

get/inspections

Request

Query parameters

includestring[]

Optional related entities to include in the results.

page[size]number
Example:25

Set the number of results per page.

page[number]number
Example:3

Set the page number.

filter[status]'need_to_book' | 'overdue' | 'unconfirmed' | 'booked' | 'incomplete' | 'complete' | 'cancelled'

Filter the status of inspections.

filter[due_date_from]string datetime

Filter the inspections due date from the input date.

filter[due_date_to]string datetime

Filter the inspections due date to the input date.

filter[booked_from]string datetime

If the inspection has been booked in, filter the inspections booked date from the input date.

filter[booked_to]string datetime

If the inspection has been booked in, filter the inspections booked date to the input date.

sortstring[]

Sort the inspections by the input value.

Response

Get all Inspections.

Example response

{
  "data": [
    {
      "relationships": {
        "property": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        },
        "bookedBy": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        },
        "inspector": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        }
      }
    }
  ],
  "included": [
    {
      "attributes": {
        "address": {
          "single_line": "19 Lansdowne Road, Monton, Manchester",
          "anon_single_line": "Lansdowne Road, Monton, Manchester",
          "building_number": "19",
          "line_1": "19 Lansdowne Road",
          "line_2": "Monton",
          "line_3": "Manchester",
          "town": "Manchester",
          "country": "United Kingdom",
          "postcode": "M30 9PA",
          "udprn": "28327204",
          "geo": {
            "lat": 0.2365698,
            "lng": 53.023654
          }
        },
        "material_information": {
          "council_tax_band": "D"
        }
      },
      "relationships": {
        "branch": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 226,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 23
    }
  }
}

Changes

  • b01c2825aba9Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 6ed52b1e6e1eRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status