DocumentacaoCargaController

Fase 04: Transporte Logístico (para Armazenagem/Processamento Industrial) - 14. Documentação de Carga

Endpoint: /transporteLogistico/documentacaoCarga

method: POST

path: /transporteLogistico/documentacaoCarga

description: Endpoint para cadastrar

parameters:
  - name: unknown
    type: Unknown
    description: Parâmetro unknown
    required: false
    in: query

Upload neste metodo

Este cadastro deve ser enviado como multipart/form-data no metodo POST /transporteLogistico/documentacaoCarga.

• Envie o JSON do cadastro em uma parte de texto chamada body.
• Envie cada arquivo em uma parte separada, usando exatamente estes nomes: declaracaoSegregacao, certificadoFitossanitario.
• Nao envie os arquivos dentro de dados; se precisar manter outros campos, deixe apenas os campos nao-arquivo dentro de dados.
• Os arquivos sao opcionais, mas, quando enviados, precisam respeitar o limite de 10MB e as extensoes permitidas: .pdf, .jpg, .jpeg, .png, .doc, .docx, .xls, .xlsx.

Exemplo:

curl --request POST "https://<url>/transporteLogistico/documentacaoCarga" \
  --header "X-API-ACCESS-KEY: <chave_de_acesso>" \
  --header "X-API-SECRET-KEY: <chave_de_seguranca>" \
  --form 'body={"safraId":"<id_safra>","safraCodigo":"<codigo_safra>","dados":{}}' \
  --form "declaracaoSegregacao=@/caminho/arquivo.pdf" \
  --form "certificadoFitossanitario=@/caminho/arquivo.pdf"

Exemplo de requisição:

curl --request POST \
  --url https://<url>/transporteLogistico/documentacaoCarga \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "safraId": "<id_safra>",
    "safraCodigo": "<codigo_safra>",
    "dados": {

      "notaFiscal": "Nota Fiscal",
      "declaracaoSegregacao": "Declaração de segregação",
      "certificadoOrigemLote": "Certificado de origem do lote",
      "certificadoFitossanitario": "Certificado Fitossanitario",
      "certificadoCertificacao": "certificado de certificação (RTRS, ISCC, ProTerra)"

    }
  }'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /transporteLogistico/documentacaoCarga

method: PUT

path: /transporteLogistico/documentacaoCarga

description: Endpoint para atualizar

parameters:
  - name: entity
    type: UpdateChainEntity
    description: Parâmetro entity
    required: true
    in: body

Exemplo de requisição:

curl --request PUT \
  --url https://<url>/transporteLogistico/documentacaoCarga \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "safraId": "<id_safra>",
    "safraCodigo": "<codigo_safra>",
    "dados": {

      "notaFiscal": "Nota Fiscal",
      "declaracaoSegregacao": "Declaração de segregação",
      "certificadoOrigemLote": "Certificado de origem do lote",
      "certificadoFitossanitario": "Certificado Fitossanitario",
      "certificadoCertificacao": "certificado de certificação (RTRS, ISCC, ProTerra)"

    }
  }'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /transporteLogistico/documentacaoCarga/{id}

method: GET

path: /transporteLogistico/documentacaoCarga/{id}

description: Endpoint para getById

parameters:
  - name: id
    type: String
    description: Parâmetro id
    required: true
    in: path

Exemplo de requisição:

curl --request GET \
  --url https://<url>/transporteLogistico/documentacaoCarga/{id} \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /transporteLogistico/documentacaoCarga/safra/{id}

method: GET

path: /transporteLogistico/documentacaoCarga/safra/{id}

description: Endpoint para getBySafra

parameters:
  - name: id
    type: String
    description: Parâmetro id
    required: true
    in: path

Exemplo de requisição:

curl --request GET \
  --url https://<url>/transporteLogistico/documentacaoCarga/safra/{id} \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /transporteLogistico/documentacaoCarga

method: GET

path: /transporteLogistico/documentacaoCarga

description: Endpoint para listar

parameters:
  - name: =
    type: (size
    description: Parâmetro =
    required: false
    in: query
  - name: =
    type: sort
    description: Parâmetro =
    required: false
    in: query

Exemplo de requisição:

curl --request GET \
  --url https://<url>/transporteLogistico/documentacaoCarga \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /transporteLogistico/documentacaoCarga/{id}

method: DELETE

path: /transporteLogistico/documentacaoCarga/{id}

description: Endpoint para excluir

parameters:
  - name: id
    type: String
    description: Parâmetro id
    required: true
    in: path

Exemplo de requisição:

curl --request DELETE \
  --url https://<url>/transporteLogistico/documentacaoCarga/{id} \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}