FaseController

Informações das fases disponíveis no processo produtivo

Endpoint: /fase

method: POST

path: /fase

description: Endpoint para cadastrar

parameters:
  - name: dados
    type: DadosCadastroFase
    description: Parâmetro dados
    required: true
    in: body

Exemplo de requisição:

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

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: /fase/all

method: POST

path: /fase/all

description: Endpoint para cadastrarTodos

parameters:
  - name: dados
    type: List<DadosCadastroFase>
    description: Parâmetro dados
    required: true
    in: body

Exemplo de requisição:

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

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: /fase

method: GET

path: /fase

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>/fase \
  --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: /fase/cultura/{cultura}

method: GET

path: /fase/cultura/{cultura}

description: Endpoint para listar

parameters:
  - name: cultura
    type: TipoCultura
    description: Parâmetro cultura
    required: true
    in: path

Exemplo de requisição:

curl --request GET \
  --url https://<url>/fase/cultura/{cultura} \
  --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: /fase/cultura/{cultura}/etapa/{etapa}

method: GET

path: /fase/cultura/{cultura}/etapa/{etapa}

description: Endpoint para listar

parameters:
  - name: cultura
    type: TipoCultura
    description: Parâmetro cultura
    required: true
    in: path
  - name: etapa
    type: String
    description: Parâmetro etapa
    required: true
    in: path

Exemplo de requisição:

curl --request GET \
  --url https://<url>/fase/cultura/{cultura}/etapa/{etapa} \
  --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: /fase/cultura/{cultura}/etapa/{etapa}/{nome}

method: GET

path: /fase/cultura/{cultura}/etapa/{etapa}/{nome}

description: Endpoint para listar

parameters:
  - name: cultura
    type: TipoCultura
    description: Parâmetro cultura
    required: true
    in: path
  - name: etapa
    type: String
    description: Parâmetro etapa
    required: true
    in: path
  - name: nome
    type: String
    description: Parâmetro nome
    required: true
    in: path

Exemplo de requisição:

curl --request GET \
  --url https://<url>/fase/cultura/{cultura}/etapa/{etapa}/{nome} \
  --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: /fase

method: PUT

path: /fase

description: Endpoint para atualizar

parameters:
  - name: dados
    type: DadosAtualizacaoFase
    description: Parâmetro dados
    required: true
    in: body

Exemplo de requisição:

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

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: /fase/{id}

method: DELETE

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