Ideal Postcodes API Fixtures
Options
All
  • Public
  • Public/Protected
  • All
Menu

Fixture

Represents the essential data returned by an api.ideal-postcodes.co.uk (via body and httpStatus as well as the HTTP request used to retrieve the data (e.g. url, query)

Note, secrets are redacted and added back in via environment variables when the fixtures are generated

Hierarchy

  • Fixture

Index

Properties

Properties

Optional body

body: any

JSON body of API Response

description

description: string

Basic description of request

Optional headers

headers: StringMap

HTTP request headers

httpStatus

httpStatus: number

HTTP Status of API Response

Optional method

method: undefined | string

HTTP Method. Defaults to GET if not defined

Optional query

query: StringMap

HTTP request query string

url

url: string

URL of request (relative to https://api.ideal-postcodes.co.uk/)