# Rede de Sementes ITS4U

**Estas informações estão disponíveis também na** [**collection do postman**](https://www.getpostman.com/collections/88152ab0c1dc5369880c)

Este documento tem por objetivo explicar de forma textual o uso da API para extração de dados do Rede de Sementes por parte do time do **ITS4U** servindo de complemento à *collection* do Postman previamente criada e provida para os times.

## Autenticação

**POST** /api/v1/auth

*body request*

{
   "email": "[e-mail]",
   "password": "..."
}

*payload response*

{
    "user": {
        ...
        "token": "eyJhbGciOiJIUzI1NiJ9.OTUzNzk4OTI.Ng9HGhlxs9qvLqLcBHZHlMFqznbs--IvHuj1GUQOoBY",
        ...
    }
}

> Você irá precisar do `token` para a próxima requisição

## Dados do Rede de Sementes

**GET** /api/v1/harvest-stage

O `token` gerado na requisição anterior precisará ser enviado como autorização nos headers

São *query params* aceitáveis e acumulativos:

| Parâmetro | Exemplo | Descrição |
| -------- | -------- | -------- |
| startDateHarvest | 2020-07-16 00:00 | Filtra pela data mínima ou igual de início da Safra |
| finalDateHarvest | 2042-12-31 23:59 | Filtra pela data máxima ou igual de fim da Safra |
| startDateStage | 2020-08-05 00:00 | Filtra pela data mínima ou igual de início da Onda |
| finalDateStage | 2020-09-02 23:59 | Filtra pela data máxima ou igual de início da Onda |
| stageDescription | 1 | Filtra pela descrição numérica da Onda |
| currentStage | 1 ou 0 | Filtra pelas ondas abertas (1) ou fechadas (0) |
| regional | CENTRO SOJA | Filtra pela Regional |
| updatedAt | 2020-08-09 00:00 | Filtra pela data mínima ou igual de alteração em um preenchimento da Rede de Sementes |

*payload response*

[
    {
        "harvestDescription": "Safra Teste Kaio",
        "startDateHarvest": "2042-01-01T03:00:00.000Z",
        "finalDateHarvest": "2042-12-31T03:00:00.000Z",
        "startDateStage": "2020-08-05T19:30:29.068Z",
        "finalDateStage": "2020-09-02T19:30:35.285Z",
        "stageDescription": 1,
        "currentStage": 1,
        "harvestStageDescriptionEnable": 1,
        "regional": "CENTRO SOJA",
        "district": "ITAPEVA-SOJA",
        "multiplier": "BEATRICE HASSON SVERNER",
        "documentNumber": "08444497000149",
        "seed": "61HO114 IPRO",
        "brand": "HO SEMENTES",
        "breeder": "GDM",
        "prodExpectation": null,
        "forecast": null,
        "volume": null,
        "updatedAt": "2020-08-12T19:31:02.950Z"
    },
    ...
]

Segue abaixo também uma explicação de cada campo

| Campo | Descrição |
| -------- | -------- |
| harvestDescription | Descrição da Safra, nome dado pelo OP |
| startDateHarvest | Data de início da Safra |
| finalDateHarvest | Data de fim da Safra |
| startDateStage | Data de início da Onda |
| finalDateStage | Data de fim da Onda |
| stageDescription | Descrição numérica da Onda que determina a ordem de exibição |
| currentStage | Indicador que determina se a Onda é a atual na Rede de Sementes |
| harvestStageDescriptionEnable | Indicador que determina se a relação Multiplicador-Semente está ativa na Rede de Sementes-Safra |
| regional | Regional |
| district | Distrito |
| multiplier | Multiplicador |
| documentNumber | Número de documento do Multiplicador |
| seed | Semente |
| brand | Marca |
| breeder | Obtentor |
| prodExpectation | Expectativa de produção. Quando `null` significa que não houve preenchimento |
| volume | Volume vendido. Quando `null` significa que não houve preenchimento |
| forecast | Forecast de comercialização. Quando `null` significa que não houve preenchimento |
| updatedAt | Data da última atualização em algum campo de preenchimento (`prodExpectation`, `volume` ou `forecast`) |