Unidades consumidoras

Descubra e identifique UCs com um recurso estável para instalação atual, identificador legado, conta contrato, cliente e endereço.

Nesta página

Obter UCs
Resposta
Campos
Identificadores

Obter UCs

Para a lista disponível, use a rota da conexão. Para atualizar a lista a partir da distribuidora, crie um trabalho de descoberta.

GET/api/v1/connections/{connectionId}/ucs

POST/api/v1/jobs

{
  "type": "uc_discovery",
  "dist": "COPEL",
  "connectionId": "conn_exemplo_123"
}

Onde o recurso aparece

A rota retorna UCs em ucs[]. O trabalho retorna a mesma forma em result.items[], acrescida do envelope e da paginação do trabalho.

Todos os campos

Campo	Tipo	Descrição
`schemaVersion`	string	Versão do recurso: 3.0.
`dist`	string	Código da distribuidora.
`consumerUnit.installationId`	string	Identificador atual da UC.
`consumerUnit.legacyInstallationId`	string \| null	Identificador anterior.
`consumerUnit.contractAccount`	string \| null	Conta contrato.
`customer.name`	string \| null	Nome retornado para ajudar a identificar a UC.
`serviceAddress.formatted`	string \| null	Endereço completo formatado.
`serviceAddress.street`	string \| null	Logradouro e número.
`serviceAddress.neighborhood`	string \| null	Bairro.
`serviceAddress.city`	string \| null	Município.
`serviceAddress.state`	string \| null	UF.
`serviceAddress.postalCode`	string \| null	CEP formatado.
`lastUpdated`	datetime	Última atualização em ISO 8601 com offset.

Escolher o identificador

Prefira consumerUnit.installationId em novas solicitações. A API também aceita o identificador legado e a conta contrato quando vinculados à mesma UC.