# API: Empresas --- - [Index](#index) - [Show](#show) - [Store](#store) - [Comodato Ativo](#comodato_ativo) - [Comodatos](#comodatos) - [Propriedades](#propriedades) - [Produtos](#produtos) - [Instalações](#instalacoes) - [Ordens de Instalação](#ordens_instalacoes) - [Silobags](#silobags) - [Zonas](#zonas) ## Index ### Endpoint |Método|URI|Headers| |:|:-|:| |GET|`/empresas`|Default| ### Body ```json Empty ``` ### Responses 200 - OK ```json [ { "id": , "cnpj": , "razao_social": , "nome_fantasia": , "email": , "logo_file": , "is_active": , "assinatura_contrato_at": , "logo_url": }, //... ] ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## Show ### Endpoint |Método|URI|Headers| |:|:-|:| |GET|`/empresas/{empresa}`|Default| ### Body ```json Empty ``` ### Responses 200 - OK ```json { "id": , "cnpj": , "razao_social": , "nome_fantasia": , "email": , "logo_file": , "is_active": , "assinatura_contrato_at": , "logo_url": } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## Store ### Endpoint |Método|URI|Headers| |:|:-|:| |POST|`/empresas/{empresa}`|Default| ### Body ```json { "razao_social": string, "nome_fantasia": string, "cnpj": string(cnpj), "email": string(email), "assinatura_contrato_at": string(Y-m-d H:i:s), "admin_user": { "name" : string, "email" : string(email), "cpf" : string(cpf) } } ``` ### Responses 200 - OK ```json { "id": , "cnpj": , "razao_social": , "nome_fantasia": , "email": , "logo_file": , "is_active": , "assinatura_contrato_at": , "logo_url": } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## Comodato Ativo ### Endpoint |Método|URI|Headers| |:|:-|:| |GET|`/empresas/{empresa}/comodato-ativo`|Default| ### Body ```json Empty ``` ### Responses 200 - OK ```json { "id": , "empresa_id": , "data_inicio": , "data_fim": , "active": , "equipamentos": [ { "id": , "code":

,
            "tipo": ,
            "modelo": ,
            "versao_hardware": ,
            "versao_software": ,
            "instalacao_id": ,
            "pivot": {
                "comodato_id": ,
                "equipamento_id": 
            }
        },
        //...
    ]
}
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Comodatos

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/comodatos`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "empresa_id": ,
        "data_inicio": ,
        "data_fim": ,
        "active": 
    },
    //..
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Propriedades

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/propriedades`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "empresa_id": ,
        "nome": ,
        "descricao": ,
        "center_lat": ,
        "center_lng": ,
        "area_polygon": [
            [
                ,
                
            ],
            //...
        ],
        "profile_picture_file": ,
        "profile_picture_url": 
    }
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```
---
### Endpoint
|Método|URI|Headers|
|:|:-|:|
|POST|`/empresas/{empresa}/propriedades`|Default|

### Body
```json
{
    "empresa_id": int,
    "nome": string,
    "descricao": string,
    "center_lat": float,
    "center_lng": float,
    "area_polygon": [
        [
            float, 
            float
        ],
        //... 
    ],
    "profile_picture_temp": string
}
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "empresa_id": ,
        "nome": ,
        "descricao": ,
        "center_lat": ,
        "center_lng": ,
        "area_polygon": [
            [
                ,
                
            ],
            //...
        ],
        "profile_picture_file": ,
        "profile_picture_url": 
    }
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Produtos

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/produtos`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "empresa_id": ,
        "nome": ,
        "descricao": 
    },
    //...
]
```
---
### Endpoint
|Método|URI|Headers|
|:|:-|:|
|POST|`/empresas/{empresa}/produtos`|Default|

### Body
```json
{
    "nome": string,
    "descricao": string,
    "default_ativos_referencias": [
        {
            "ativo_medicao_id": int,
            "min_val": float,
            "max_val": float
        },
        //...
    ]
}
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "empresa_id": ,
        "nome": ,
        "descricao": 
    },
    //...
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Instalações

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/instalacoes`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "equipamento_id": ,
        "ordem_instalacao_id": ,
        "secao_id": ,
        "latitude": ,
        "longitude": ,
        "installation_picture":,
        "installation_observation": ,
        "installed_at": ,
        "installation_warning": 
    }
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Ordens de Instalação

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/ordens-instalacao`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "empresa_id": ,
        "propriedade_id": ,
        "zona_id": ,
        "responsible_user_id": ,
        "quantity": ,
        "installed_quantity": ,
        "description": ,
        "target_date": ,
        "started_at": ,
        "finished_at": ,
        "active": 
    },
    //...
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```

---

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|POST|`/empresas/{empresa}/ordens-instalacao`|Default|

### Body
```json
{
    "zona_id": int,
    "quantity": int,
    "description": string,
    "target_date": string(Y-m-d)
}
```

### Responses
200 - OK
```json
{
    "zona_id": ,
    "quantity": ,,
    "description": ,,
    "target_date": ,,
    "propriedade_id": ,,
    "empresa_id": ,,
    "id": ,,
    "active": ,
}
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```

---

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|PATCH|`/empresas/{empresa}/ordens-instalacao/{ordem-instalacao}/start`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
{
    "zona_id": ,
    "quantity": ,,
    "description": ,,
    "target_date": ,,
    "propriedade_id": ,,
    "empresa_id": ,,
    "id": ,,
    "active": ,
}
```

422 - Unprocessable Content
```json
{
    "message": "A ordem de instalação já foi iniciada.",
    "errors": {
        "started_at": [
            "A ordem de instalação já foi iniciada."
        ]
    }
}
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```

---

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|PATCH|`/empresas/{empresa}/ordens-instalacao/{ordem-instalacao}/finish`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
Empty
```

422 - Unprocessable Content
```json
{
    "message": "A ordem de instalação já foi finalizada.",
    "errors": {
        "started_at": [
            "A ordem de instalação já foi finalizada."
        ]
    }
}
```
```json
{
    "message": "Não foram instaladas todas sondas previstas. Instaladas 0 de 2.",
    "errors": {
        "installed_quantity": [
            "Não foram instaladas todas sondas previstas. Instaladas 0 de 2."
        ]
    }
}

```
401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Silobags

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/silobags`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "zona_id": ,
        "propriedade_id": ,
        "empresa_id": ,
        "produto_id": ,
        "referencia_id": ,
        "identificacao": ,
        "descricao": ,
        "center_lat": ,
        "center_lng": ,
        "length": ,
        "reta": [
            [
                ,
                
            ],
            //..
        ],
        "has_alerta": 
    }
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|POST|`/empresas/{empresa}/silobags`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "zona_id": ,
        "propriedade_id": ,
        "empresa_id": ,
        "produto_id": ,
        "referencia_id": ,
        "identificacao": ,
        "descricao": ,
        "center_lat": ,
        "center_lng": ,
        "length": ,
        "reta": [
            [
                ,
                
            ],
            //..
        ],
        "has_alerta": 
    }
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Zonas

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/empresas/{empresa}/silobags`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
[
    {
        "id": ,
        "propriedade_id": ,
        "empresa_id": ,
        "identificacao": ,
        "descricao": ,
        "center_lat": ,
        "center_lng": ,
        "area_polygon": [
            [
                ,
                
            ],
            //...
        ],
        "profile_picture_file": ,
        "profile_picture_url": ,
        "propriedade": {
            "id": ,
            "empresa_id": ,
            "nome": ,
            "center_lat": ,
            "center_lng": ,
            "area_polygon": [
                [
                    ,
                    
                ],
                //...
            ],
            "profile_picture_file": ,
            "profile_picture_url": 
        }
    }
]
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```