action ideal_postcodes_udprn {
  label: "Retrieve by UDPRN"
  description: "Returns an address as identified by its Unique Delivery Point Reference Number (UDPRN).\n\nYou may find it useful to store UDPRN information as it can be used to retrieve the most recent information for an address. It can also be used to test for a deleted address.\n\nUDPRNs are an eight digit unique numeric code (e.g. 25962203) for any premise on the Postcode Address File. It's essentially a unique identifier for every address in the UK that Royal Mail has in its database.\n\n## Testing\n\nTo test your implementation of our API we have a range of test UDPRNs that yield both successful and unsuccessful responses to your request.\n\nThey are the following:\n\n- `0` Returns a successful UDPRN lookup response\n  `2000`\n- `-1` Returns \"UDPRN not found\", error `4044`\n- `-2` Returns \"no lookups remaining\", error `4020`\n- `-3` Returns \"daily (or individual) lookup limit breached\",\n  error `4021`\n\nTest request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup."
  provider: ideal_postcodes
  method: GET
  path: "/udprn/{udprn}"
  encoding: json
  input: {
    type: "object"
    properties: {
      api_key: {
        type: "string"
        description: "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
      }
      filter: {
        type: "string"
        description: "Comma separated whitelist of address elements to return. \n\nE.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response\n"
      }
      udprn: {
        type: "string"
      }
    }
    required: ["udprn"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["code", "message", "result"]
    properties: {
      code: {
        type: "integer"
        format: "int32"
        enum: [2000]
      }
      message: {
        type: "string"
        enum: ["Success"]
      }
      result: {
        type: "object"
      }
    }
  }
}