Através deste endoint é possível consultar a lista de NSNRecs vinculados a uma NFCom a partir de sua chave de acesso.
URL
Produção: POST https://nfcom.ns.eti.br/v1/util/list/nsnrecs
Dados de entrada
| Campo | Descrição | Tipo | Ocorrência | Observação |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | A | 1-1 | |
| chNFCom | Chave de acesso da NFCom | N | 1-1 | |
| tpAmb | Tipo de ambiente de autorização da NFCom 1 - Produção 2 - Homologação Valor padrão: 2 | N | 0-1 |
Exemplo de requisição
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"X-AUTH-TOKEN": "ADQWREQW561D32AWS1D6",
"chNFCom": "43240107364617000135620000000000011000000016",
"tpAmb": 2
}'\
https://nfcom.ns.eti.br/v1/util/list/nsnrecs
Dados retornados
| Campo | Descrição | Tipo | Ocorrência | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | N | 1-1 | ||
| motivo | Descrição literal do status de processamento | A | 1-1 | ||
| nsNRecs | Objeto contendo os dados da pessoa solicitada | Array | 1-1 | Conterá items apenas se forem encontrados nsNRecs vinculados a chave da NFCom fornecida | |
| nsNRec | nsNRec vinculado | N | 1-1 | nsNRecs | |
| cStat | Código do status do nsNRec | N | 1-1 | nsNRecs | |
| xMotivo | Descrição literal do status do nsNRec | A | nsNRecs |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"nsNRecs": [
{
"cStat": 100,
"nsNRec": 1894,
"xMotivo": "Autorizado o uso da NFCom "
}
]
}
Retorno com erro
{
"status": -2,
"motivo": "Chave de acesso inválida"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |
| -2 | Chave de acesso inválida |