Feedback Gran Bretagna

Beta

Manage missing addresses in the United Kingdom.

Riferimento OpenAPI

GETList addresses POSTAdd an address DELETERemove an address

GEThttps://api.pro6pp.nl/v2/feedback/gb

Panoramica

Lists the addresses added by the authenticated subscription.

ParametriQuery string

authKeystringObbligatorio

Every request needs an API key, which you can get in the portal.

When you call the API from a browser, visitors can see your API key. Limit it to your own domains in the portal, or send the requests through your own server so the key stays hidden.

Risposte

200Addresses added by your subscription, or an empty array when there are noneElenco di risultati

Campo	Tipo	Valore di esempio	Descrizione
countryCode	string	"GB"	The ISO 3166-1 alpha-2 country code of the address ("GB").
postalCode	string	"B1 2JB"	The complete unit postcode in uppercase, with a space before the inward code.
streetNumber	string	"997-998"	The house number, as text.
street	string	"Brindley Place"	The street name as submitted.
settlement	string	"Birmingham City Centre"	The settlement name as submitted, or an empty string when none was given.
lat	number	non presente nell'esempio	The submitted latitude, rounded to 5 decimals; left out when none was given.
lng	number	non presente nell'esempio	The submitted longitude, rounded to 5 decimals; left out when none was given.
premise	string	non presente nell'esempio	The house number addition as submitted, in lowercase; left out when there is none.
claim	string	non presente nell'esempio	The reason the subscriber gave for adding the address; left out when none was given.

Risposta di esempio

[
  {
    "countryCode": "GB",
    "postalCode": "B1 2JB",
    "settlement": "Birmingham City Centre",
    "street": "Brindley Place",
    "streetNumber": "997-998"
  }
]

Errori

Campi di una risposta di errore

Campo	Tipo	Descrizione
error_id	string	The reason the request failed, such as `INVALID_VALUE`. The response lists the reasons this operation returns.
errors	array of object	One entry per problem found in the request.
errors[].message	string	A readable explanation of the problem, in English.
errors[].help	string	A link to the documentation section that covers the problem.
errors[].parameter	any	The parameter the problem is about. Usually its name; a list when several parameters are involved, or a name with the values to choose from when the request must select one.
errors[].value	any	The value the request sent for `parameter`, when it has one.

401Non autorizzato

UNAUTHORIZED

The API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.

UNAUTHORIZED

{
  "error_id": "UNAUTHORIZED",
  "errors": [
    {
      "message": "No authorization token provided",
      "help": "https://pro6pp.nl/docs/v2/redoc#section/Authentication"
    }
  ]
}

Esempi di codice

curl "https://api.pro6pp.nl/v2/feedback/gb?authKey=YOUR_API_KEY"

La invitiamo a richiedere codice di esempio nel linguaggio di programmazione che preferisce.