# API: Equipamentos --- - [Index](#index) - [Store](#store) - [Start](#start) - [Finish](#finish) ## Index ### Endpoint |Método|URI|Headers| |:|:-|:| |GET|`/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." } ``` ## Store ### Endpoint |Método|URI|Headers| |:|:-|:| |POST|`/ordens-instalacao`|Default| ### Body ```json { "zona_id": int, "quantity": int, "description": string, "target_date": string(datetime) } ``` ### Responses 201 - Created ```json { "zona_id": , "quantity": , "description": , "target_date": , "propriedade_id": , "empresa_id": , "id": , "active": } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## Start ### Endpoint |Método|URI|Headers| |:|:-|:| |PATCH|`/ordens-instalacao/{ordem_instalacao}/start`|Default| ### Body ```json { "code": string, "tipo": string(enum(['CONCENTRADOR', 'SONDA', 'REPETIDOR', 'MODULOS'])), "modelo": string, "versao_hardware": string(#.#.#), "versao_software": string(#.#.#) } ``` ### Responses 204 - No Content ```json Empty ``` 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." } ``` ## Finish ### Endpoint |Método|URI|Headers| |:|:-|:| |PATCH|`/ordens-instalacao/{ordem_instalacao}/finish`|Default| ### Body ```json Empty ``` ### Responses 204 - No Content ```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 n de n.", "errors": { "installed_quantity": [ "Não foram instaladas todas sondas previstas. Instaladas n de n." ] } } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ```