User Minimal Time Reports API

General notes

Content

User minimal time reports collection

• [GET] index, searching and filtering user groups

Single user minimal time report

• [GET] user group detail
• [PUT/PATCH] update user group

User minimal time reports collection

---

User minimal time reports index

GET /api/v0/user-minimal-time-reports

Request

Index behaviour	Definition
Paginated by default	No
Sorting	id, user_id, year, month, required_minutes, reported_minutes
Filters	id:enum, user_id:int, year:int, month:int, required_minutes:int, reported_minutes:int

GET /api/v0/user-minimal-time-reports HTTP/1.1

Responses

200 OK

GET /api/v0/user-minimal-time-reports HTTP/1.1
Content-Type: application/json
Status-Code: 200

{
    "items": [
        {
            "id": 1,
            "user_id": 1,
            "year": 2023,
            "month": 5,
            "required_minutes": 7600,
            "reported_minutes": 1124
        },
        {
            "id": 2,
            "user_id": 2,
            "year": 2023,
            "month": 5,
            "required_minutes": 8200,
            "reported_minutes": 60
        }
    ]
}

---

Single user minimal time report

User minimal time report detail

Request

GET /api/v0/user-minimal-time-report/1 HTTP/1.1

Responses

200 OK

GET /api/v0/user-minimal-time-report/1 HTTP/1.1
Content-Type: application/json
Status-Code: 200

{
    "id": 1,
    "user_id": 1,
    "year": 2023,
    "month": 5,
    "required_minutes": 7600,
    "reported_minutes": 1124
}

404 NOT FOUND

User Minimal Time Report was not found.

GET /api/v0/user-minimal-time-reports/12 HTTP/1.1
Content-Type: application/json
Status-Code: 404

{
    "type": "NotFound",
    "message": "Required model was not found.",
    "id": "0cd85449-05fe-4866-9802-8192e6785fc7"
}

---

Update User minimal time report

PUT/PATCH /api/v0/user-minimal-time-report/{user-minimal-time-report-id}

Request

Param	Type	Description	Requirements
required_minutes	int	User's minimal time report requirements	Required. Must be integer.

PATCH /api/v0/user-minimal-time-reports/1 HTTP/1.1
Content-Type: application/json

{
  "required_minutes": 7100
}

Responses

200 OK

PUT /api/v0/user-minimal-time-reports/1 HTTP/1.1
Content-Type: application/json
Status-Code: 200

{
    "id": 1,
    "user_id": 1,
    "year": 2023,
    "month": 5,
    "required_minutes": 7100,
    "reported_minutes": 1124
}

404 NOT FOUND

User Minimal Time Report was not found.

PUT /api/v0/user-minimal-time-reports/2 HTTP/1.1
Content-Type: application/json
Status-Code: 404

{
    "type": "NotFound",
    "message": "Required model was not found.",
    "id": "0cd85449-05fe-4866-9802-8192e6785fc7"
}

422 UNPROCESSABLE ENTITY

Validation error occurred.

PUT /api/v0/user-minimal-time-reports/1 HTTP/1.1
Content-Type: application/json
Status-Code: 422

{
    "type": "ValidationError",
    "message": "The given data was invalid.",
    "id": "5c99f70a-e400-44bb-9cd4-592b0a30e145",
    "errors": [
        {
            "field": "required_minutes",
            "message": "Pole musí být vyplněno."
        }
    ]
}