DocumentacaoCargaExportacaoController

Fase 08: Transporte Logístico de Exportação - 24. Documentação da Carga para Exportação

Endpoint: /logisticaExportacao/documentacaoCargaExportacao

method: POST

path: /logisticaExportacao/documentacaoCargaExportacao

description: Endpoint para cadastrar

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

Exemplo de requisição:

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

      "notaFiscalExportacao": "Nota fiscal de exportação",
      "declaracaoSegregacao": "Declaração de segregação",
      "certificadoOrigem": "Certificado de origem",
      "certificadoFitossanitario": "Certificado fitossanitário",
      "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: /logisticaExportacao/documentacaoCargaExportacao

method: PUT

path: /logisticaExportacao/documentacaoCargaExportacao

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>/logisticaExportacao/documentacaoCargaExportacao \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "safraId": "<id_safra>",
    "safraCodigo": "<codigo_safra>",
    "dados": {

      "notaFiscalExportacao": "Nota fiscal de exportação",
      "declaracaoSegregacao": "Declaração de segregação",
      "certificadoOrigem": "Certificado de origem",
      "certificadoFitossanitario": "Certificado fitossanitário",
      "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: /logisticaExportacao/documentacaoCargaExportacao/{id}

method: GET

path: /logisticaExportacao/documentacaoCargaExportacao/{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>/logisticaExportacao/documentacaoCargaExportacao/{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: /logisticaExportacao/documentacaoCargaExportacao/safra/{id}

method: GET

path: /logisticaExportacao/documentacaoCargaExportacao/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>/logisticaExportacao/documentacaoCargaExportacao/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: /logisticaExportacao/documentacaoCargaExportacao

method: GET

path: /logisticaExportacao/documentacaoCargaExportacao

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>/logisticaExportacao/documentacaoCargaExportacao \
  --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: /logisticaExportacao/documentacaoCargaExportacao/{id}

method: DELETE

path: /logisticaExportacao/documentacaoCargaExportacao/{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>/logisticaExportacao/documentacaoCargaExportacao/{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
}