STstreet
Viewings

Get a single Viewing

Changed on

This endpoint retrieves a single viewing by its UUID.

get/viewings/{viewing_id}

Request

Query parameters

includestring[]

Optional related entities to include in the results, e.g. property,applicant,branch,notes,owner,viewer

filter[cancelled]'with' | 'only'

Optionally return result WITH cancelled results or return ONLY cancelled results.

Response

OK.

metaobject

Example response

{
  "data": {
    "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
        }
      }
    },
    "relationships": {
      "branch": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "property": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "owner": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "applicant": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "viewer": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "notes": {
        "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
          }
        }
      }
    }
  ]
}

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