Webservice (Comercial Contratos - Fazer upload de arquivos para o cadastro de cliente): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
(Criou página com ''''Descrição:''' Faz o upload de uma lista de arquivos para o cadastro de um cliente '''URL:''' https://[URL]/ws/comercial/clientes/anexar_arquivos '''Método:''' POST ''...')
 
Sem resumo de edição
 
Linha 32: Linha 32:
|-
|-
|idCliente
|idCliente
|
|body
|
|String
|
|SIM
|
|
|-
|-
|tipo
|tipo
|
|body
|
|String
|
|SIM
|
|
|-
|-
|model
|model
|
|body
|Map<String,Object>
|Map<String,Object>
|
|SIM
|
|
|}
|}

Edição atual tal como às 17h54min de 25 de maio de 2023

Descrição: Faz o upload de uma lista de arquivos para o cadastro de um cliente

URL: https://[URL]/ws/comercial/clientes/anexar_arquivos

Método: POST

Entrada: HeaderParam(“Token”) com o value contendo um token válido, gerado pelo método “Gerar Token”. JSON contendo a lista de arquivos que deseja fazer o upload.

OBS.: a lista não deve conter mais que 5 arquivos e os arquivos (model) não podem ter tamanho maior que 5MB.

Saída: String de “SUCESSO” ou o erro encontrado.

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
idContrato Path Param String SIM
Token Header Param String SIM
idCliente body String SIM
tipo body String SIM
model body Map<String,Object> SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/clientes/anexar_arquivos
      • Parâmetros adicionais:
        [
           {
              "idCliente":81593,
              "tipo":"DOCUMENTO",
              "model":{
                 "base64":"QzpcVXNlcnNcUHJpc2NpbGxhXERvd25sb2Fkc1xURVNURV9TSU5URUdSQSAoMjMpL0cmli...",
                 "filename":"foto.jpg",
                 "filesize":106743,
                 "filetype":"image/jpeg"
              }
           },
           {
              "idCliente":81593,
              "tipo":"DOCUMENTO",
              "model":{
                 "base64":"QzpcVXNlcnNcUHJpc2NpbGxhXERvd25sb2Fkc1xURVNURV9TSU5URUdSQSAoMjMpL0cmli...",
                 "filename":"foto.jpg",
                 "filesize":106743,
                 "filetype":"image/jpeg"
              }
           }
        ]
        
  • Retorno:
    • Sucesso:
      {
         "error":"O tamanho da imagem foto.jpg excede o limite de 5MB."
      }
      
    • Erro:
      { 
          "error": "A quantidade de arquivos excede o número máximo de 5." 
      }
      

Voltar ao menu Webservice Comercial Contratos