Shyft Compact > RequstTimeOff API
The Compact > RequstTimeOff API from Shyft — 2 operation(s) for compact > requsttimeoff.
OpenAPI Specification
openapi: 3.0.0
info:
title: Shyft Customer Authentication > Email Compact > RequstTimeOff API
description: "Welcome to the Shyft Customer App API.\n\nShyft customer App API is designed to support the function of Shyft Mobile App(iOS, Android), Web App and Manager Dashboard.\n\nNOTES:\n\n- In parameters section, the letter `R` stands for `Required`.\n \n- All API examples show only essential data set.\n \n\n## Authentication\n\n---\n\nInclude as headers for API calls after authentication token.\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| Session-Uukey | | \\* | The value got from authentication API call (SignIn/Confirm) |\n\n## Global Information\n\n---\n\n#### Query Parameters\n\n###### For All API:\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| api_version | String | | Ex. 6_0_0 |\n| response\\[nested\\] | Integer | | Ex. 1 |\n| response\\[keep\\] | String | | Ex. location\\[current_user_privilege\\],name,id |\n| response\\[only\\] | String | | Ex. id,location\\[id,location_name,current_user_privilege\\] |\n| response\\[except\\] | String | | Ex. name,location\\[id,location_name,swift_code\\],owner\\[id\\] |\n\n- The query parameter `response[only]` is needed to help API performance by limiting the size of returned data.\n \n- On test server, `response[only]` support wildcard, you can supply `response[only]=\\*` to get everything.\n \n- Production server does not support wildcard, you need to figure out and supply your `response[only]` for each API call.\n \n\n###### For Index API:\n\n- Pagination Option 1)\n \n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| page | Integer | | Ex. 1 |\n| per_page | Integer | | Ex. 5 |\n| total | boolean | | true/false |\n| order | String | | Ex. start_at_desc, start_at_asc |\n\n- Pagination Option 2)\n \n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| limit | Integer | | Ex. 10 |\n| offset | Integer | | Ex. 5 |\n| order | String | | Ex. start_at_desc, start_at_asc |\n| last_id | Integer | | Ex. 101 |\n\n###### For Update API:\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| response\\[put_return_resource\\] | String | | Ex. true |\n\n#### Headers\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| Platform | ios|android|web | \\* | |\n| Api-Version | 6_0_0 | \\* | Ex: 6_0_0 |\n| Build-Number | | \\* | |\n| Push-Id | | | |\n| X-Method | | | Deprecated |\n| Content-Type | application/json | \\* | |\n\n#### Success Codes\n\n| SUCCESS Code | Meaning |\n| --- | --- |\n| 200 | Created -- Objet created. |\n| 201 | Unauthorized -- Your API key is wrong. |\n| 204 | No Content -- Success without returning resource. |\n\n#### Error Codes\n\n| Error Code | Meaning |\n| --- | --- |\n| 400 | Bad Request -- Your request is invalid. |\n| 401 | Unauthorized -- Your API key is wrong. |\n| 403 | Forbidden -- The records requested is hidden for administrators only. |\n| 404 | Not Found -- The specified record could not be found. |\n| 405 | Method Not Allowed -- You tried to access a record with an invalid method. |\n| 406 | Not Acceptable -- You requested a format that isn't json. |\n| 410 | Gone -- The record requested has been removed from our servers. |\n| 422 | Unprocessable Entity -- Invalid input data. |\n| 429 | Too Many Requests -- You're requesting too many requests! Slow down! |\n| 500 | Internal Server Error -- We had a problem with our server. Try again later. |\n| 502 | Bad Gateway -- |\n| 504 | Gateway Timeout -- |\n| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |\n\n#### Error Response Formats\n\n422\n\n``` json\n{\n \"errors\": {\n \"base\": [\n \"a private session for same two users already exists: 3034\"\n ]\n }\n}\n\n ```\n\n422\n\n```\n{\n \"errors\": {\n \"google_map_id\": [\n \"can't be blank\"\n ],\n \"time_zone\": [\n \"can't be blank\"\n ],\n \"longitude\": [\n \"can't be blank\"\n ]\n }\n}\n{\n \"errors\": {\n \"record_invalid\": [\n \"Validation failed: User has already been taken\"\n ]\n }\n}\n\n ```\n\n404\n\n``` json\n{\n \"errors\": {\n \"not_found\": [\n \"Couldn't find Post\"\n ]\n }\n}\n\n ```\n\n500\n\n``` json\n{\n \"errors\": {\n \"internal_server_error\": [\n \"Invalid nil value\"\n ]\n }\n}\n\n ```"
version: 1.0.0
servers:
- url: http://{{host}}
- url: http://{{local-host}}
- url: http://{{sp3-host}}
- url: http://test-service.myshyft.com
- url: http://localhost:4001
- url: http://localhost:3000
- url: http://{{local-host}}api
- url: https://test-unfurl.myshyft.com
tags:
- name: Compact > RequstTimeOff
paths:
/api/compact/request_time_offs/can_admin:
get:
tags:
- Compact > RequstTimeOff
summary: get manageable request time offs
description: "Description\n- - - \n\n\n\n\nParams\n- - -\nParam | Values | R |Description\n--- | --- | --- | ---\n\n\nHeaders\n- - -\nHeader | Values | R |Description\n--- | --- | --- | ---\n\n\n\nInput\n- - - \n\nAttribute | Values | R |Description\n--- | --- | --- | ---\n\n\nOutput\n- - -"
security:
- noauthAuth: []
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: location_id
in: query
schema:
type: string
example: '{{location_id}}'
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Wed, 01 Sep 2021 17:41:24 GMT
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Transfer-Encoding:
schema:
type: string
example: chunked
Connection:
schema:
type: string
example: keep-alive
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Download-Options:
schema:
type: string
example: noopen
X-Permitted-Cross-Domain-Policies:
schema:
type: string
example: none
Referrer-Policy:
schema:
type: string
example: strict-origin-when-cross-origin
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: none
ETag:
schema:
type: string
example: W/"f4186736d52ba106f554066f69c28dd3"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=dzNaOVRkcStkNHpyUXRGWGg2RXhNV1FmRy8ybkhPNXFOcUV2M2tlMnJpTENOdXdQM2o3b0RKWjE2N3lmL1hJZTM0WnVqVm8xdTBQOVU1L09iTUtTZ2c9PS0tUVZRYTJRelZrVzErUzBjTzV6YXI3QT09--88b937e685dd3e588af16b99ead75f4a19e49e39; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 74b94381-0a27-4d62-ac02-a1590c50a512
X-Runtime:
schema:
type: number
example: '3.060987'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
request_time_offs:
- _parent_object_id: null
id: 2
user_id: 11284
approver_id: null
managed_at: null
location_id: 2622
days: 5
day_hours: 8
total_hours: 40
latest_balance: null
start_date: '2021-09-01'
start_time: '2021-09-01T09:00:00.000Z'
end_date: '2021-09-05'
end_time: '2021-09-01T17:00:00.000Z'
category: '1'
status: requested
time_off_reason: null
managed_reason: null
balances_at_closed: null
- _parent_object_id: null
id: 27
user_id: 14601
approver_id: null
managed_at: null
location_id: 2622
days: 5
day_hours: 8
total_hours: 40
latest_balance: null
start_date: '2021-09-01'
start_time: '2021-09-01T09:00:00.000Z'
end_date: '2021-09-05'
end_time: '2021-09-01T17:00:00.000Z'
category: pto
status: requested
time_off_reason: null
managed_reason: null
balances_at_closed: null
- _parent_object_id: null
id: 1
user_id: 11284
approver_id: null
managed_at: null
location_id: 2622
days: 5
day_hours: 8
total_hours: 40
latest_balance: null
start_date: '2021-09-01'
start_time: '2021-09-01T09:00:00.000Z'
end_date: '2021-09-05'
end_time: '2021-09-01T17:00:00.000Z'
category: pto
status: requested
time_off_reason: null
managed_reason: null
balances_at_closed: null
meta:
pagination:
current_page: 1
per_page: 500
/api/compact/request_time_offs/mine:
get:
tags:
- Compact > RequstTimeOff
summary: get my request time offs
description: "Description\n- - - \n\nParams\n- - -\nParam | Values | R |Description\n--- | --- | --- | ---\n\nHeaders\n- - -\nHeader | Values | R |Description\n--- | --- | --- | ---\n\n\n\nInput\n- - - \n\nAttribute | Values | R |Description\n--- | --- | --- | ---\n\n\nOutput\n- - -"
security:
- noauthAuth: []
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Wed, 01 Sep 2021 17:41:36 GMT
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Transfer-Encoding:
schema:
type: string
example: chunked
Connection:
schema:
type: string
example: keep-alive
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Download-Options:
schema:
type: string
example: noopen
X-Permitted-Cross-Domain-Policies:
schema:
type: string
example: none
Referrer-Policy:
schema:
type: string
example: strict-origin-when-cross-origin
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: none
ETag:
schema:
type: string
example: W/"a9784c8b5cb818f65efaced83c1bd52b"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=Wk9YazZqWHp5UGplekVySVlWQkl0cDdWQ3dYc0dRQTRDaTZzZi9kZi9YandYc1ZKcWdmMTlCakMwTWVPTSthTjl0WW9TT1FpU296K0NQdnpjZDR4UHc9PS0tblBzVEpkOUdHaHM2YXptVWtDM1BLQT09--d25ce5ce4e3572caf65b2673cbde6f76feaa3979; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 265f8492-2fa8-49b6-b3b9-56261ccdfd0c
X-Runtime:
schema:
type: number
example: '0.279662'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
request_time_offs:
- _parent_object_id: null
id: 149
user_id: 11284
approver_id: 11284
managed_at: '2021-08-27T18:24:06.666Z'
location_id: 8421
days: 1
day_hours: 1
total_hours: 1
latest_balance: null
start_date: '2021-09-07'
start_time: '2021-09-07T13:00:00.000Z'
end_date: '2021-09-07'
end_time: '2021-09-07T14:00:00.000Z'
category: rto_category_pto
status: approved
time_off_reason: null
managed_reason: null
balances_at_closed:
rto_balances:
rto_category_pto: 15
rto_category_floating: 0
rto_category_diversity: 0
rto_in_queue:
rto_category_pto: 3
- _parent_object_id: null
id: 148
user_id: 11284
approver_id: 11284
managed_at: '2021-08-27T18:26:29.250Z'
location_id: 8421
days: 1
day_hours: 1
total_hours: 1
latest_balance: null
start_date: '2021-09-08'
start_time: '2021-09-08T14:00:00.000Z'
end_date: '2021-09-08'
end_time: '2021-09-08T15:00:00.000Z'
category: rto_category_pto
status: approved
time_off_reason: null
managed_reason: null
balances_at_closed:
rto_balances:
rto_category_pto: 15
rto_category_floating: 0
rto_category_diversity: 0
rto_in_queue:
rto_category_pto: 3
- _parent_object_id: null
id: 138
user_id: 11284
approver_id: 11284
managed_at: '2021-08-27T00:50:44.810Z'
location_id: 8421
days: 1
day_hours: 1
total_hours: 1
latest_balance: null
start_date: '2021-08-31'
start_time: '2021-08-31T10:00:00.000Z'
end_date: '2021-08-31'
end_time: '2021-08-31T11:00:00.000Z'
category: rto_category_pto
status: approved
time_off_reason: null
managed_reason: null
balances_at_closed:
rto_balances:
rto_category_pto: 15
rto_category_floating: 0
rto_category_diversity: 0
rto_in_queue:
rto_category_pto: 1
- _parent_object_id: null
id: 2
user_id: 11284
approver_id: null
managed_at: null
location_id: 2622
days: 5
day_hours: 8
total_hours: 40
latest_balance: null
start_date: '2021-09-01'
start_time: '2021-09-01T09:00:00.000Z'
end_date: '2021-09-05'
end_time: '2021-09-01T17:00:00.000Z'
category: '1'
status: requested
time_off_reason: null
managed_reason: null
balances_at_closed: null
- _parent_object_id: null
id: 1
user_id: 11284
approver_id: null
managed_at: null
location_id: 2622
days: 5
day_hours: 8
total_hours: 40
latest_balance: null
start_date: '2021-09-01'
start_time: '2021-09-01T09:00:00.000Z'
end_date: '2021-09-05'
end_time: '2021-09-01T17:00:00.000Z'
category: pto
status: requested
time_off_reason: null
managed_reason: null
balances_at_closed: null
meta:
pagination:
current_page: 1
per_page: 500
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
noauthAuth:
type: http
scheme: noauth