# 1:1 - esaj-protocolo

**Formato da Requisição do robô (via HTTP)**

``` json
{
    "dry": false,
    "bot": "esaj-protocolo",
    "version": "v3.0.0-dev",
    "cid": "",
    "timeout": "",
    "deadline": "",
    "data": {
        "processo": "",
        "grau": "",
        "incidente": "",
        "tipoProtocolo": "",
        "categoria": "",
        "parteCliente": "",
        "documentoCliente": "",
        "guias": ["123", "421"],
        "justicaGratuita": "",
        "cumprirPrazo": "",
        "cumprirTodasIntimacoes": "",
        "arquivos": [
            "tipoArquivo": "",
            "arquivo": "",
            "descricaoArquivo": "",
            "sigilo": "",
            "peticao": ""
        ]
    },
    "files": [
        {
            "name": "arquivo.pdf",
            "data": "",
            "property": "arquivo",
            "bound": true
        }
    ],
    "credentials": {
        "username": "user",
        "pin": "senha",
        "base64Cert": "[base64]",
        "credentialsOption": "RJ"
    }
}

 ```

**Descrição campos 'DATA'**

| **CAMPO** | **Obrigatório** | **Formato** | **Default** | **Descrição** |
| --- | --- | --- | --- | --- |
| processo | Sim | String |  | Número do processo |
| incidente | Não | String |  | Número do incidente que deseja realizar o protocolo |
| tipoProtocolo | Sim | String |  | Tipo de evento do protocolo |
| categoria | Sim | String |  | Categoria do protocolo |
| parteCliente | Sim\* | String |  | Nome da parte, Não obrigatório caso envie o documento da parte |
| documentoCliente | Sim\* | String |  | Documento da parte, Não obrigatório caso envie o nome da parte |
| poloCliente | Nao | String |  | Caso necessário enviar o polo da parte |
| guias | Não | String\[\] |  | Número da guia que deseja vincular ao processo |
| justicaGratuita | Não | String | false | Se deseja informar que o protocolo é justiça gratuita  <br>  <br>(TRUE, FALSE, SIM ou NÂO) |
| cumprirPrazo | Não | String | false | Se deseja cumprir algum prazo  <br>  <br>(TRUE, FALSE, SIM ou NÂO) |
| cumprirTodasIntimacoes | Não | Strint | false | Se o robô encontrar mais de uma intimação ele apontará erro  <br>  <br>(TRUE, FALSE, SIM ou NÂO) |
| arquivos | Sim | \[ARQUIVO\] |  | Lista de arquivos |

**Descrição campos 'ARQUIVO'**

| **CAMPO** | **Obrigatório** | **Formato** | **Default** | **Descrição** |
| --- | --- | --- | --- | --- |
| tipoArquivo | Sim | String |  | Categorização do arquivo dentro do tribunal. Ex: Petição |
| descricaoArquivo | Não | String | vazio | Descrição extra do arquivo |
| sigilo | Não | Boolean | false | Marcar se o arquivo deverá ser marcado como sigiloso. |
| arquivo | Sim | String |  | Nome do arquivo. Deverá ser informado o mesmo nome do atributo 'files.name' |
| peticao | Não | String | false | Usado para identificar o arquivo principal da petição..  <br>  <br>  <br>Obs: Nas próximas atualizações do robô esse campo será usado para identificar se o robô não deverá utilizar o campo de edição para descrever a petição inicial. |

**Descrição campos 'credentials'**

| **CAMPO** | **Obrigatório** | **Formato** | **Default** | **Descrição** |
| --- | --- | --- | --- | --- |
| username | Sim | String |  | CPF do certificado |
| pin | Sim | String |  | Senha do certificado |
| base64Cert | Sim | String |  | Base64 do certificado |
| hash | Sim (se a credencial estiver salva no nosso cofre) | String |  | hash gerado pelo nosso cofre |