# Retrieve Crown allotment parcels including parcel SPI

Retrieve a list of Crown allotment parcels that match the Crown allotment search criteria.
The response includes each parcel's SPI, which can be used to obtain detailed parcel information.

Endpoint: GET /discovery/v1/parcels/crown-allotments
Version: 1.9.0
Security: oauthClientCredentials

## Query parameters:

  - `allotment` (string)
    Crown Allotment descriptor.
At least one of Allotment OR Portion OR Section MUST be provided
Note that Allotment is a more specific identifier than Section and Portion, so may return a smaller, more specific list of Crown allotment parcels.
    Example: "H"

  - `section` (string)
    Section is a part of the parcel descriptor. It is utilized in combination with either Lot and Plan number or Allotment and Parish code.
Note that Section is less specific of an identifier than Allotment, so may return a larger, less specific list of Crown allotment parcels.
At least one of Allotment OR Portion OR Section MUST be provided.
    Example: "9"

  - `portion` (string)
    Crown Portion descriptor.
Note that Portion is less specific of an identifier than Allotment, so may return a larger, less specific list of Crown allotment parcels.
At least one of Allotment OR Portion OR Section MUST be provided.
    Example: "105"

  - `block` (string)
    Crown Block descriptor.
A part of the parcel descriptor. It is utilized in combination with either Lot and Plan number or Allotment and Parish code.
    Example: "1"

  - `subdivision` (string)
    Crown Subdivision descriptor.
    Example: "16"

  - `parishCode` (string)
    Parish code.
A list of parish names and their associated codes can be obtained from the GET /parishes endpoint.
If only parishCode is used, townshipCode will not return in the response.
At least one of Parish code OR Township code MUST be provided.
    Example: "2796"

  - `townshipCode` (string)
    Township code.
A list of township names and their associated codes can be obtained from the GET /townships endpoint.
Note that townshipCode will only return in the response if townshipCode is used in the request
At least one of Parish code OR Township code MUST be provided.
    Example: "2796B"

## Header parameters:

  - `x-correlation-id` (string)
    Optional unique UUID which can assist with tracing / debugging requests.
    Example: "824993ab-7366-4faa-963d-c456dec227a5"

## Response 200 fields (application/json):

  - `crownAllotmentSummaries` (array)

  - `crownAllotmentSummaries.spi` (string, required)
    A Standard Parcel Identifier (SPI) uniquely identifies a parcel. An SPI typically consists of either a Lot on Plan or a Crown Allotment.
A Lot on Plan defines the allocated lot number on a particular plan. For example '101\PS328573' is lot 101 on the plan of subdivision 328573.
There are instances of an SPI not containing a lot, eg: 'TP109554'.
A Crown Allotment parcel is defined by up to five different factors including Allotment, Block, Portion, Section and SubDivision.
For example '12~10A\PP5762' is Allotment 12 in Section 10a on the Parish Plan 5762.
    Example: "3A2\\PS515587"

  - `crownAllotmentSummaries.allotment` (string)
    Crown Allotment.
Crown Allotment descriptor.
    Example: "15D"

  - `crownAllotmentSummaries.section` (string)
    Section.
A part of the parcel descriptor. It is utilized in combination with either Lot and Plan number or Allotment and Parish code.
    Example: "A"

  - `crownAllotmentSummaries.portion` (string)
    Crown Portion.
Crown Portion descriptor.
    Example: "105"

  - `crownAllotmentSummaries.block` (string)
    Crown Block.
A part of the parcel descriptor. It is utilized in combination with either Lot and Plan number or Allotment and Parish code.
    Example: "1"

  - `crownAllotmentSummaries.subdivision` (string)
    Crown Subdivision.
Crown Subdivision descriptor.
    Example: "16"

  - `crownAllotmentSummaries.parishCode` (string)
    Parish code.
    Example: "3987"

  - `crownAllotmentSummaries.parishName` (string)
    Parish name.
    Example: "YEO"

  - `crownAllotmentSummaries.townshipCode` (string)
    Township code.
    Example: "5051"

  - `crownAllotmentSummaries.townshipName` (string)
    Township name.
    Example: "BARWON DOWNS TP"

## Response 400 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 401 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 403 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 404 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 500 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.