PT EN

Áreas

URL base: $PUBLIC_API

O objecto

tenant_idstring · obrigatório

Identifier of the utility serving the area

tenant_slugstring · opcional

Utility slug for its public brand files (GET /branding/tenants/{slug}/assets/{kind})

utility_namestring · obrigatório

The utility's trading name

localitystring · obrigatório

Name of the matching service area

profiledboolean · obrigatório

Whether the utility has a public profile; basic listings are false

coverage_notestring · opcional

Optional note about coverage in the area

contact_phonestring · opcional

Optional public contact phone

estimate_min_centsinteger (int64) · opcional

Optional lower bound of a new connection estimate

estimate_max_centsinteger (int64) · opcional

Optional upper bound of a new connection estimate

currencystring · opcional

Currency of the estimate

Operações
O objecto
{
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "tenant_slug": "tenant slug",
  "utility_name": "Ana Matsinhe",
  "locality": "Machava",
  "profiled": true,
  "coverage_note": "coverage note",
  "contact_phone": "+258841234567",
  "estimate_min_cents": 1,
  "estimate_max_cents": 1,
  "currency": "MZN"
}

Procurar empresas de água por local

Registos

GET /areas/search

Answers "who serves this place?" without sign-in: matches the text against the active service areas of approved, active utilities and returns one listing per matching area, with the utility's name, its slug for public brand files and the area's name. No customer data or counts are returned. q must be 2 to 100 characters after trimming, or the response is 400.

Parâmetros

qstring · consulta · obrigatório

Place name to look for, 2 to 100 characters; matched against service area names.

limitinteger · consulta · opcional · predefinição 5

Maximum number of listings, default 5. Values above 20 are reduced to 20; zero, negative or non-numeric values return 400.

Devolve

200 Matching area listings

Mostrar atributos
dataarray of PublicAreaListing · obrigatório

Matching listings

Mostrar atributos filhos
tenant_idstring · obrigatório

Identifier of the utility serving the area

tenant_slugstring · opcional

Utility slug for its public brand files (GET /branding/tenants/{slug}/assets/{kind})

utility_namestring · obrigatório

The utility's trading name

localitystring · obrigatório

Name of the matching service area

profiledboolean · obrigatório

Whether the utility has a public profile; basic listings are false

coverage_notestring · opcional

Optional note about coverage in the area

contact_phonestring · opcional

Optional public contact phone

estimate_min_centsinteger (int64) · opcional

Optional lower bound of a new connection estimate

estimate_max_centsinteger (int64) · opcional

Optional upper bound of a new connection estimate

currencystring · opcional

Currency of the estimate

querystring · obrigatório

The trimmed search text

Erros 400

curl -X GET "$PUBLIC_API/areas/search"
Resposta 200
{
  "data": [
    {
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "tenant_slug": "tenant slug",
      "utility_name": "Ana Matsinhe",
      "locality": "Machava",
      "profiled": true,
      "coverage_note": "coverage note",
      "contact_phone": "+258841234567",
      "estimate_min_cents": 1,
      "estimate_max_cents": 1,
      "currency": "MZN"
    }
  ],
  "query": "query"
}