work-week

Get Many WorkWeeks

Get Many WorkWeeks

Securitybearer
Request
query Parameters
select
Array of strings

Select WorkWeek fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "officeId" "employeeId" "effectiveFrom" "timezone" "duration"
relations
Array of strings

Select related WorkWeek resources, comma-separated. (e.g. relations=office,department)

Items Enum: "office" "employee"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received WorkWeeks. (e.g. limit=20)

offset
integer

Offset amount of received WorkWeeks. (e.g. offset=20)

object

Sort received WorkWeeks by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/work-week
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": {
    }
}

Create One WorkWeek

Create One WorkWeek

Securitybearer
Request
Request Body schema: application/json
required
employeeId
string
officeId
string
effectiveFrom
required
string <date-time>
effectiveTo
string <date-time>
timezone
required
string
duration
required
number
required
object (WorkWeekDayRequest)
required
object (WorkWeekDayRequest)
required
object (WorkWeekDayRequest)
required
object (WorkWeekDayRequest)
required
object (WorkWeekDayRequest)
required
object (WorkWeekDayRequest)
required
object (WorkWeekDayRequest)
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/work-week
Request samples
application/json
{
  • "employeeId": "507f1f77bcf86cd799439011",
  • "officeId": "507f1f77bcf86cd799439011",
  • "effectiveFrom": "2019-08-24T14:15:22Z",
  • "effectiveTo": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "duration": 0,
  • "monday": {
    },
  • "tuesday": {
    },
  • "wednesday": {
    },
  • "thursday": {
    },
  • "friday": {
    },
  • "saturday": {
    },
  • "sunday": {
    }
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One WorkWeek

Get One WorkWeek

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select WorkWeek fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "officeId" "employeeId" "effectiveFrom" "timezone" "duration"
relations
Array of strings

Select related WorkWeek resources, comma-separated. (e.g. relations=office,department)

Items Enum: "office" "employee"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/work-week/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": {
    }
}

Update One WorkWeek

Update One WorkWeek

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
effectiveTo
string <date-time>
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/work-week/{id}
Request samples
application/json
{
  • "effectiveTo": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One WorkWeek

Replace One WorkWeek

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
effectiveTo
string <date-time>
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/work-week/{id}
Request samples
application/json
{
  • "effectiveTo": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One WorkWeek

Delete One WorkWeek

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/work-week/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to scope