Autenticação- As chamadas terão autenticação a nível de transporte (Basic Authentication).
- Solicite o user / password ao administrador da conta.
Características |
|---|
| Título | Inserir um documento do sistema em uma rota já criada. | | URL | /api/1.0/routes/insertdocument/ | | Método | POST | | Parâmetro URL | Sem parâmetros | | Parâmetro Data | Tipo: application/json
Exemplo:
{
"route_name": "CAMPINAS",
"route_date": "2015-11-09",
"route_driver": "0017",
"document_key": "3514001615500700028557518898261"
} | | Sucesso | Code: 200
Content:
{
"user_message": "Documentos incluidos com sucesso!",
"internal_message": "",
"response_data": "",
"code": 0,
"more_info": "http://dev.comprovei.com.br"
} | | Erro | Code: 400
Content:
{
"user_message": "Documento {CHAVE} já está em uma rota.",
"internal_message": "Verifique os dados do documento.",
"response_data": "",
"code": 400,
"more_info": "http://dev.comprovei.com.br"
}
Code: 400
Content:
{
"user_message": "Documento {CHAVE} não existente no sistema.",
"internal_message": "Importe o documento.",
"response_data": "",
"code": 400,
"more_info": "http://dev.comprovei.com.br"
}
Code: 400
Content:
{
"user_message": "Rota em andamento. Inclusão cancelada!",
"internal_message": "",
"response_data": "",
"code": 400,
"more_info": "http://dev.comprovei.com.br"
}
Code: 400
Content:
{
"user_message": "Rota está encerrada',
"internal_message": "Verifique os dados da rota.",
"response_data": "",
"code": 400,
"more_info": "http://dev.comprovei.com.br"
}
Code: 400
Content:
{
"user_message": "Rota não existe.',
"internal_message": "Verifique os dados da rota.",
"response_data": "",
"code": 400,
"more_info": "http://dev.comprovei.com.br"
}
Code: 401
Content:
{
"user_message": "Parâmetro Data ausente",
"internal_message": "Verifique os dados enviados",
"response_data": "",
"code": 401,
"more_info": "http://dev.comprovei.com.br"
}
Code: 401
Content:
{
"user_message": "Método indisponível para o tipo da conta",
"internal_message": "{TIPOCONTA}",
"response_data": "",
"code": 401,
"more_info": "http://dev.comprovei.com.br"
}
Code: 401
Content:
{
"user_message": "",
"internal_message": "Usuário e/ou senha do desenvolvedor inválidos",
"response_data": "",
"code": 0,
"more_info": "http://dev.comprovei.com.br"
}
Code: 401
Content:
{
"user_message": "",
"internal_message": "Sem dados de autenticação do desenvolvedor",
"response_data": Tipo da conta,
"code": 0,
"more_info": "http://dev.comprovei.com.br"
}
|
Paramêtro Data| Nome | Tipo | Padrão | Descrição |
|---|
route_name | string | | Nome utilizado no cadastro da rota. | route_date | string | | Data utilizada no cadastro da rota. Formato: yyyy-mm-dd | route_driver | string | | Código do motorista utilizado no cadastro da rota. | document_key | string | | Chave do documento a ser inserido. |
|
|
