Skip to navigation

Get location data associated with a PCode

View as Markdown

Access control: this endpoint is available to users with the everyone role.

Request will return all locations associated with the PCode

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

pCodeintegerRequired

Headers

client_idintegerRequired
The client id.

Response

OK
LocationDatalist of objects or nullOptional
List of location matches for the address being searched.
MatchCountintegerOptional
Number of matches returned.
InputMatchTypestring or nullOptional
Match type from user input. "Exact" match or "Best" match.
MatchTypeAppliedstring or nullOptional
Indicates whether the matches returned are based on an "Exact" match or "Best" match.
ResultsLimitintegerOptional
Maximum number of results applied to search.