Exibir código-fonte para Upload de arquivos

O objetivo deste serviço é possibilitar o envio de arquivos para os cadastros, atendimentos e usuários do sistema. Abaixo, segue exemplo do json de envio:

<syntaxhighlight lang="json" line="1">
{
  "files_upload":[
  {
    "type": "customer",
    "code": 21546,
    "filename": "meu_arquivo.pdf",
    "file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
             IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
             dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
             dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
             ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
    "visible": "no",
    "description": "Planilha de ações"
  },
  {
    "type": "user",
    "user": "joao",
    "filename": "meu_arquivo2.pdf",
    "file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
             IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
             dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
             dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
             ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
    "visible": "no",
    "description": "Planilha de ações"
  }]
}
</syntaxhighlight>

'''Detalhamento dos campos'''
<table style="border-collapse: collapse; width: 100%;" border="1">
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;"><strong>ID</strong></td>
<td style="width: 6.5821%; height: 18px;"><strong>Campo</strong></td>
<td style="width: 3.62012%; height: 18px;"><strong>Obrigat&oacute;rio</strong></td>
<td style="width: 0.728833%; height: 18px;"><strong>Pai</strong></td>
<td style="width: 1.01088%; height: 18px;"><strong>Tipo</strong></td>
<td style="width: 38.4579%; height: 18px;"><strong>Observa&ccedil;&otilde;es</strong></td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A01</td>
<td style="width: 6.5821%; height: 18px;">Dados do arquivo</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">Raiz</td>
<td style="width: 1.01088%; height: 18px;">-</td>
<td style="width: 38.4579%; height: 18px;">Podem ser enviados v&aacute;rios arquivos em uma mensagem mensgaem</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A02</td>
<td style="width: 6.5821%; height: 18px;">type</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Texto</td>
<td style="width: 38.4579%; height: 18px;">
<p>Tipo do arquivo a ser enviado. Op&ccedil;&otilde;es dispon&iacute;veis:</p>
<ul>
<li>customer (Clientes)</li>
<li>prospect (Mercados)</li>
<li>supplier (Fornecedores)</li>
<li>ticket (Atendimentos)</li>
<li>user (Usu&aacute;rios)</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 6.5821%; height: 18px;">code</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">N&uacute;mero</td>
<td style="width: 38.4579%; height: 18px;">
<p>C&oacute;digo do cadastro ou n&uacute;mero do atendimento.<br />N&atilde;o deve ser informado quanto type = user.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 6.5821%; height: 18px;">user</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Texto</td>
<td style="width: 38.4579%; height: 18px;">
<p>Usu&aacute;rio do sistema.<br />S&oacute; deve ser informado quando type = user.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A05</td>
<td style="width: 6.5821%; height: 18px;">filename</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Texto</td>
<td style="width: 38.4579%; height: 18px;">
<p>Nome do arquivo com extens&atilde;o.<br />N&atilde;o pode ter tamanho maior que 200 caracteres.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A06</td>
<td style="width: 6.5821%; height: 18px;">file</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Texto</td>
<td style="width: 38.4579%; height: 18px;">
<p>Conte&uacute;do do arquivo codificado em base64.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A07</td>
<td style="width: 6.5821%; height: 18px;">visible</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Texto</td>
<td style="width: 38.4579%; height: 18px;">
<p>Define se o arquivo estar&aacute; vis&iacute;vel para o cliente. Op&ccedil;&otilde;es dispon&iacute;veis:</p>
<ul>
<li>yes (Sim)</li>
<li>no (N&atilde;o)</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A08</td>
<td style="width: 6.5821%; height: 18px;">description</td>
<td style="width: 3.62012%; height: 18px;">Sim</td>
<td style="width: 0.728833%; height: 18px;">A01</td>
<td style="width: 1.01088%; height: 18px;">Texto</td>
<td style="width: 38.4579%; height: 18px;">
<p>Descri&ccedil;&atilde;o do arquivo no sistema.</p>
</td>
</tr>
</table>
<p>&nbsp;</p>

'''Mensagem de retorno'''

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": [
    {
       "id": 10,
       "type": "customer",
       "code": 21546,
       "filename": "meu_arquivo.pdf",
       "file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
                IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
                dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
                dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
                ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
       "visible": "no",
       "description": "Planilha de ações"
     },
          {
       "id": 11,
       "type": "user",
       "user": "joao",
       "filename": "meu_arquivo2.pdf",
       "file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
                IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
                dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
                dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
                ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
       "visible": "no",
       "description": "Planilha de ações"
     }]
}
</syntaxhighlight>

Em caso de falha, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
  "status": 0,
  "error_code": 5,
  "error_description": "The field file is required!",
  "result": ""
}
</syntaxhighlight>