Sucesso.
{
"itens": [
{
"id": "0190a000-0000-7000-8000-000000000001",
"departamentoId": "0190a000-0000-7000-8000-000000000002",
"nome": "PETIÇÃO INICIAL",
"cor": "#1d4f91",
"ordem": 0,
"inicial": true,
"viraCliente": false
}
]
}
Campos da resposta
Corpo ou parâmetro inválido.
INVALIDO
{
"codigo": "INVALIDO",
"mensagem": "Confira os dados informados.",
"campos": {
"departamentoId": "Valor inválido."
}
}
CHAVE_IDEMPOTENCIA_INVALIDA
{
"codigo": "CHAVE_IDEMPOTENCIA_INVALIDA",
"mensagem": "A Idempotency-Key deve ter de 1 a 255 caracteres visíveis, sem espaços."
}
Campos da resposta
codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
codigotextoobrigatório
nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
Sem token, ou token revogado ou expirado, ou pessoa desativada.
TOKEN_INVALIDO
{
"codigo": "TOKEN_INVALIDO",
"mensagem": "Token de API inválido, expirado ou revogado."
}
Campos da resposta
codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
codigotextoobrigatório
nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
A pessoa não pode fazer isto, o token é só de leitura, foi bloqueado neste escritório, não tem esta operação, quem o gerou saiu do escritório ou o acesso ao escritório está suspenso.
SEM_PERMISSAO
{
"codigo": "SEM_PERMISSAO",
"mensagem": "Sem permissão para esta alteração."
}
TOKEN_SO_LEITURA
{
"codigo": "TOKEN_SO_LEITURA",
"mensagem": "Este token é só de leitura."
}
TOKEN_SEM_ESCOPO
{
"codigo": "TOKEN_SEM_ESCOPO",
"mensagem": "Este token não tem permissão para esta operação."
}
TOKEN_BLOQUEADO
{
"codigo": "TOKEN_BLOQUEADO",
"mensagem": "Este token foi bloqueado pela administração deste escritório."
}
TOKEN_AUTOR_INATIVO
{
"codigo": "TOKEN_AUTOR_INATIVO",
"mensagem": "Quem gerou este token não está mais ativo neste escritório."
}
ESCRITORIO_SUSPENSO
{
"codigo": "ESCRITORIO_SUSPENSO",
"mensagem": "O acesso a este escritório está suspenso. Fale com a IA2S."
}
Campos da resposta
codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
codigotextoobrigatório
nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
Não existe, está fora do alcance da pessoa, ou o escritório do caminho não é dela.
NAO_ENCONTRADO
{
"codigo": "NAO_ENCONTRADO",
"mensagem": "Não encontrado."
}
ESCRITORIO_NAO_ENCONTRADO
{
"codigo": "ESCRITORIO_NAO_ENCONTRADO",
"mensagem": "Escritório não encontrado."
}
Campos da resposta
codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
codigotextoobrigatório
nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
Limite de 120 requisições por minuto.
Cabeçalho Retry-After: Segundos até poder tentar de novo.
LIMITE_TOKEN
{
"codigo": "LIMITE_TOKEN",
"mensagem": "Muitas requisições com este token. Tente de novo em um minuto."
}
Campos da resposta
codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
codigotextoobrigatório
nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
