Options
All
  • Public
  • Public/Protected
  • All
Menu

@ideal-postcodes/api-fixtures

Index

Variables

Const addresses

addresses: { empty: {}; multipleResidence: { success: {} }; success: {} } = ...

API responses returned by the /addresses API

Type declaration

  • empty: {}
  • multipleResidence: { success: {} }
    • success: {}
  • success: {}

Const autocomplete

autocomplete: { empty: {}; multipleResidence: { success: {} }; success: {} } = ...

API responses returned by the /autocomplete API

Type declaration

  • empty: {}
  • multipleResidence: { success: {} }
    • success: {}
  • success: {}

Const errors

errors: { balanceDepleted: {}; dailyIpRateLimitReached: {}; dailyLimitReached: {}; invalidKey: {}; invalidUrl: {} } = ...

Errors responses returned by API

Type declaration

  • balanceDepleted: {}
  • dailyIpRateLimitReached: {}
  • dailyLimitReached: {}
  • invalidKey: {}
  • invalidUrl: {}

Const keys

keys: { check: { available: {}; invalid: {}; unavailable: {} }; private: { success: {} }; usage: {} } = ...

API responses returned by the /keys API

Type declaration

  • check: { available: {}; invalid: {}; unavailable: {} }
    • available: {}
    • invalid: {}
    • unavailable: {}
  • private: { success: {} }
    • success: {}
  • usage: {}

Const postcodes

postcodes: { multipleResidence: { success: {} }; notFound: {}; success: {} } = ...

API responses returned by the /postcodes API

Type declaration

  • multipleResidence: { success: {} }
    • success: {}
  • notFound: {}
  • success: {}

Const udprn

udprn: { notFound: {}; success: {} } = ...

API responses returned by the /udprn API

Type declaration

  • notFound: {}
  • success: {}

Const umprn

umprn: { notFound: {}; success: {} } = ...

API responses returned by the /umprn API

Type declaration

  • notFound: {}
  • success: {}