STstreet
Lettings Applications

Get a single Lettings Application

Changed on

This endpoint retrieves a single lettings application by its UUID.

get/lettings-applications/{application_id}

Request

Query parameters

includestring[]

Optional related entities to include in the results supplied as a comma separated list.

Response

OK.

metaobject

Example response

{
  "data": {
    "attributes": {
      "application_status": "pending",
      "desired_tenancy_length": 12
    },
    "relationships": {
      "attributes": {
        "name": "p045126_01",
        "collection": "general",
        "url": "https://example.com/path/to/resource.jpg",
        "extension_type": "jpg"
      }
    }
  },
  "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"
          }
        }
      }
    }
  ]
}

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

  • 0ba539eb4023Revision changes
    • warning

      added the new additional_licensing enum value to the ///// response property for the response status

    • warning

      added the new additional_licensing enum value to the ///// response property for the response status