Options
All
  • Public
  • Public/Protected
  • All
Menu

Response body returned from a successful API Key availability check.

API Documentation for keys/:key: ideal-postcodes.co.uk/documentation/keys#key.

Example Request:

api.ideal-postcodes.co.uk/v1/keys/iddqd

Hierarchy

  • ApiResponseWithResult<KeyStatus>
    • PublicKeyResponse

Index

Properties

Properties

code

code: number

Custom response code returned by API.

The response codes first 3 digits, reflects the HTTP status. e.g. 2000 would accompany a 200 OK HTTP status.

We do not recommend performing > or < type comparison operations on code even though its type is number. This prohibits us from producing more than 10 response codes per HTTP status.

message

message: string

Human readable success or error message returned by API.

result

result: KeyStatus

Result or set of results