Shyft Customer > RequestJobs API
The Customer > RequestJobs API from Shyft — 1 operation(s) for customer > requestjobs.
OpenAPI Specification
openapi: 3.0.0
info:
title: Shyft Customer Authentication > Email Customer > RequestJobs 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: Customer > RequestJobs
paths:
/api/customer/request_jobs:
get:
tags:
- Customer > RequestJobs
summary: Get request jobs
security:
- bearerAuth: []
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: 86c78555-b722-42e0-a722-7ba2789a109c
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: Authorization
in: header
schema:
type: string
description: '[MESSION] api key, preset inside app, not secure
'
example: Token token={{api_key_access_token}}
- name: uuid_is
in: query
schema:
type: string
example: ccc12dbc-181b-4c52-ab11-080f4b8a3d1c,f95e8398-f902-46c4-bd4b-bd73ddedc0f4
responses:
'200':
description: OK
headers:
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Content-Encoding:
schema:
type: string
example: gzip
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Date:
schema:
type: string
example: Fri, 13 Sep 2019 17:29:00 GMT
ETag:
schema:
type: string
example: W/"52cd9c19bedb5e14f46e5ed41aa935e8"
Server:
schema:
type: string
example: nginx/1.14.1 + Phusion Passenger 4.0.60
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=dXhZeEJ0ZkFvQnQwNWdNSllNY254NkZwYUkxV0E1TmVtbzd6NDB6UTdPRjlqam1LNzNubVRaQXl6SHRNaXUxK1FncnJTMW9QdkFNdFhIWlpHN1dVUHc9PS0tYWl1ZGdEVWxVMWduK1RqUmZ6OFNDdz09--0273f07b93e058ae2fc24453f7f1f76b2b979e1d; path=/; secure; HttpOnly
Status:
schema:
type: string
example: 200 OK
Strict-Transport-Security:
schema:
type: string
example: max-age=15552000; includeSubDomains
Vary:
schema:
type: string
example: Origin
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-Powered-By:
schema:
type: string
example: Phusion Passenger 4.0.60
X-Rack-Dev-Mark-Env:
schema:
type: string
example: development3
X-Request-Id:
schema:
type: string
example: 9ab3742f-5dff-4b6a-99b8-e18cb558ac9d
X-Request-Method:
schema:
type: string
example: none
X-Runtime:
schema:
type: number
example: '0.148415'
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
transfer-encoding:
schema:
type: string
example: chunked
Connection:
schema:
type: string
example: keep-alive
content:
application/json:
schema:
type: object
example:
request_jobs:
- _parent_object_id: null
id: 32
uuid: ccc12dbc-181b-4c52-ab11-080f4b8a3d1c
total_count: 2
success_count: 0
failed_count: 2
output:
- errors:
owner_id:
- Sorry, this user is not approved to create shifts.
- errors:
owner_id:
- Sorry, this user is not approved to create shifts.
input:
params: '{"schedule_elements"=>[<ActionController::Parameters {"name"=>"open_shift", "owner_id"=>9679, "location_id"=>5539, "start_at"=>"2019-10-01 09:00:00", "end_at"=>"2019-10-01 16:00:00", "shift_content"=>"(Open Shift #1 of 2) Open Shift A"} permitted: true>, <ActionController::Parameters {"name"=>"open_shift", "owner_id"=>9679, "location_id"=>5539, "start_at"=>"2019-10-01 09:00:00", "end_at"=>"2019-10-01 16:00:00", "shift_content"=>"(Open Shift #2 of 2) Open Shift A"} permitted: true>], "format"=>:json, "controller"=>"api/customer/user_role/schedule_elements", "action"=>"bulk_create", "schedule_element"=>{}, "response"=><ActionController::Parameters {} permitted: true>, "page"=>1, "per_page"=>25, "owner_id"=>nil, "async_mode"=>"true"}'
options: {}
pundit_user: '#<AuthorizationContext:0x000055d9d3241118>'
base_chain: '#<ActiveRecord::Relation:0x000055d9d7bc3598>'
- _parent_object_id: null
id: 35
uuid: f95e8398-f902-46c4-bd4b-bd73ddedc0f4
total_count: 2
success_count: 2
failed_count: 0
output:
- _parent_object_id: null
id: 1772281
name: open_shift
start_at: 2019-10-01 09:00:00 UTC
end_at: 2019-10-01 16:00:00 UTC
trade_status: posted
channel_name: Victoria's Secret Logan Valley
channel_type: location_feed
tip_amount: 0
location_id: 5535
owner_id: 9679
coverer_id: null
approver_id: null
coverer_time: null
manager_time: null
owner_position: null
require_approval: false
can_approve: false
channel_id: 8079
post_id: 41659
schedule_id: 0
content: '(Open Shift #1 of 2) Open Shift A'
created_at: 2019-09-13 17:28:52 UTC
updated_at: 2019-09-13 17:28:52 UTC
allow_delete: true
segment_count: 0
extra_segment_count: 0
published_at: 2019-09-13 17:28:52 UTC
owner:
_parent_object_id: 1772281
id: 9679
active_org: 1
first_name: Profile Time
last_name: System Account
email: steve@myshyft.com
phone_number: '18003382002'
gender: 0
chat_handle: 83eb30122be8c87b8eae806f93519ff1
user_group: 0
status: ''
push_settings_list:
shift_push:
label: Shift Notifications
type: boolean
schedule_push:
label: Schedule Notifications
type: boolean
community_push:
label: Community Notifications
type: boolean
push_settings_list_array:
- label: Shift Notifications
type: boolean
key: shift_push
- label: Schedule Notifications
type: boolean
key: schedule_push
- label: Community Notifications
type: boolean
key: community_push
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/8485_9679-20180427_230134_422.jpg?1524884495
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/8485_9679-20180427_230134_422.jpg?1524884495
current_position: null
current_user_privilege_id: 16618
current_is_approved: true
all_push: true
shift_push: true
schedule_push: true
community_push: true
locale: null
profile_image:
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/8485_9679-20180427_230134_422.jpg?1524884495
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/8485_9679-20180427_230134_422.jpg?1524884495
recent_user_privilege:
_parent_object_id: 9679
id: 16618
email: steve@myshyft.com
wage: 15
position: null
is_approved: true
owner_id: 9679
location_id: 5535
org_id: 1
is_admin: false
read_only: false
first_name: Profile Time
last_name: System Account
phone_number: '18003382002'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
admin_claim_pending: false
status: active
allow_toggle_approve: null
allow_toggle_shift_approval: null
allow_toggle_dashboard: null
allow_toggle_delete_content: null
allow_toggle_tipping: null
allow_approve: false
allow_shift_approve: null
allow_delete_user: null
allow_delete_post: null
allow_delete_schedule: null
allow_tipping: false
allow_delete_shift_inventory: null
allow_delete_shift_posted: null
allow_delete_shift_covered: null
allow_delete_shift_pending: null
allow_delete_shift_approved: null
allow_delete_shift_rejected: null
location:
_associations_removed: true
_parent_object_id: 16618
id: 5535
swift_code: VSS0363
location_name: Victoria's Secret Logan Valley
unit_number: null
street_number: null
address: Route 220 & Goods Lane
province: PA
postal: '16602'
country: United States
lat: null
lng: null
latitude: 40.469316
longitude: -78.414226
phone_number: (814) 944-5213
created_at: 2019-02-27 01:25:08 UTC
users_count: 1
formatted_address: Route 220 and, Goods Ln, Altoona, PA 16602, United States
time_zone: America/New_York
google_map_id: ChIJ67_TfTiRy4kRtDp4cmz6WdI
four_sq_id: null
allow_tipping: false
shift_require_approval: true
shyft_pro_active: true
shyft_pro_expiry_date: 2020-02-27 01:25:06 UTC
fence_radius: null
cfg_not_dm: true
cfg_geofence_log: true
cfg_timeout: 15
cfg_vto: null
tos_url: https://myshyft.com/vss-terms.2.en.html
tos_version: '8.0'
require_approval: false
documents:
- title: Shyft Terms of Service
url: https://myshyft.com/terms.en.html
- title: LBrands Acknowledgement & Agreement
url: https://myshyft.com/vss-terms.2.en.html
shyft_pro_subscription_status: 0
admin_delete_content: true
ip_blocked: true
member_count: 0
location_address: null
location_city: Altoona, PA, 16602
feed_channel_id: 8079
pending_users_count: 0
shyft_pro_trial_flag: false
is_sso_required: true
cfg_exclude_coworker_schedules: true
user:
_associations_removed: true
_parent_object_id: 16618
id: 9679
active_org: 1
first_name: Profile Time
last_name: System Account
email: steve@myshyft.com
phone_number: '18003382002'
gender: 0
chat_handle: 83eb30122be8c87b8eae806f93519ff1
user_group: 0
status: ''
push_settings_list:
shift_push:
label: Shift Notifications
type: boolean
schedule_push:
label: Schedule Notifications
type: boolean
community_push:
label: Community Notifications
type: boolean
push_settings_list_array:
- label: Shift Notifications
type: boolean
key: shift_push
- label: Schedule Notifications
type: boolean
key: schedule_push
- label: Community Notifications
type: boolean
key: community_push
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/8485_9679-20180427_230134_422.jpg?1524884495
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/8485_9679-20180427_230134_422.jpg?1524884495
current_position: null
current_user_privilege_id: 16618
current_is_approved: true
all_push: true
shift_push: true
schedule_push: true
community_push: true
locale: null
pending_legals: []
coverer: null
approver: null
reposted_object: null
- _parent_object_id: null
id: 1772282
name: open_shift
start_at: 2019-10-01 09:00:00 UTC
end_at: 2019-10-01 16:00:00 UTC
trade_status: posted
channel_name: Victoria's Secret Logan Valley
channel_type: location_feed
tip_amount: 0
location_id: 5535
owner_id: 9679
coverer_id: null
approver_id: null
coverer_time: null
manager_time: null
owner_position: null
require_approval: false
can_approve: false
channel_id: 8079
post_id: 41660
schedule_id: 0
content: '(Open Shift #2 of 2) Open Shift A'
created_at: 2019-09-13 17:28:53 UTC
updated_at: 2019-09-13 17:28:53 UTC
allow_delete: true
segment_count: 0
extra_segment_count: 0
published_at: 2019-09-13 17:28:53 UTC
owner:
_parent_object_id: 1772282
id: 9679
active_org: 1
first_name: Profile Time
last_name: System Account
email: steve@myshyft.com
phone_number: '18003382002'
gender: 0
chat_handle: 83eb30122be8c87b8eae806f93519ff1
user_group: 0
status: ''
push_settings_list:
shift_push:
label: Shift Notifications
type: boolean
schedule_push:
label: Schedule Notifications
type: boolean
community_push:
label: Community Notifications
type: boolean
push_settings_list_array:
- label: Shift Notifications
type: boolean
key: shift_push
- label: Schedule Notifications
type: boolean
key: schedule_push
- label: Community Notifications
type: boolean
key: community_push
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/8485_9679-20180427_230134_422.jpg?1524884495
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/8485_9679-20180427_230134_422.jpg?1524884495
current_position: null
current_user_privilege_id: 16618
current_is_approved: true
all_push: true
shift_push: true
schedule_push: true
community_push: true
locale: null
profile_image:
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/8485_9679-20180427_230134_422.jpg?1524884495
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/8485_9679-20180427_230134_422.jpg?1524884495
recent_user_privilege:
_parent_object_id: 9679
id: 16618
email: steve@myshyft.com
wage: 15
position: null
is_approved: true
owner_id: 9679
location_id: 5535
org_id: 1
is_admin: false
read_only: false
first_name: Profile Time
last_name: System Account
phone_number: '18003382002'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
admin_claim_pending: false
status: active
allow_toggle_approve: null
allow_toggle_shift_approval: null
allow_toggle_dashboard: null
allow_toggle_delete_content: null
allow_toggle_tipping: null
allow_approve: false
allow_shift_approve: null
allow_delete_user: null
allow_delete_post: null
allow_delete_schedule: null
allow_tipping: false
allow_delete_shift_inventory: null
allow_delete_shift_posted: null
allow_delete_shift_covered: null
allow_delete_shift_pending: null
allow_delete_shift_approved: null
allow_delete_shift_rejected: null
location:
_associations_removed: true
_parent_object_id: 16618
id: 5535
swift_code: VSS0363
location_name: Victoria's Secret Logan Valley
unit_number: null
street_number: null
address: Route 220 & Goods Lane
province: PA
postal: '16602'
country: United States
lat: null
lng: null
latitude: 40.469316
longitude: -78.414226
phone_number: (814) 944-5213
created_at: 2019-02-27 01:25:08 UTC
users_count: 1
formatted_address: Route 220 and, Goods Ln, Altoona, PA 16602, United States
time_zone: America/New_York
google_map_id: ChIJ67_TfTiRy4kRtDp4cmz6WdI
four_sq_id: null
allow_tipping: false
shift_require_approval: true
shyft_pro_active: true
shyft_pro_expiry_date: 2020-02-27 01:25:06 UTC
fence_radius: null
cfg_not_dm: true
cfg_geofence_log: true
cfg_timeout: 15
cfg_vto: null
tos_url: https://myshyft.com/vss-terms.2.en.html
tos_version: '8.0'
require_approval: false
documents:
- title: Shyft Terms of Service
url: https://myshyft.com/terms.en.html
- title: LBrands Acknowledgement & Agreement
url: https://myshyft.com/vss-terms.2.en.html
shyft_pro_subscription_status: 0
admin_delete_content: true
ip_blocked: true
member_count: 0
location_address: null
location_city: Altoona, PA, 16602
feed_channel_id: 8079
pending_users_count: 0
shyft_pro_trial_flag: false
is_sso_required: true
cfg_exclude_coworker_schedules: true
user:
_associations_removed: true
_parent_object_id: 16618
id: 9679
active_org: 1
first_name: Profile Time
last_name: System Account
email: steve@myshyft.com
phone_number: '18003382002'
gender: 0
chat_handle: 83eb30122be8c87b8eae806f93519ff1
user_group: 0
status: ''
push_settings_list:
shift_push:
label: Shift Notifications
type: boolean
schedule_push:
label: Schedule Notifications
type: boolean
community_push:
label: Community Notifications
type: boolean
push_settings_list_array:
- label: Shift Notifications
type: boolean
key: shift_push
- label: Schedule Notifications
type: boolean
key: schedule_push
- label: Community Notifications
type: boolean
key: community_push
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/8485_9679-20180427_230134_422.jpg?1524884495
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/8485_9679-20180427_230134_422.jpg?1524884495
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/8485_9679-20180427_230134_422.jpg?1524884495
current_position: null
current_user_privilege_id: 16618
current_is_approved: true
all_push: true
shift_push: true
schedule_push: true
community_push: true
locale: null
pending_legals: []
coverer: null
approver: null
reposted_object: null
input:
params: '{"schedule_elements"=>[<ActionController::Parameters {"name"=>"open_shift", "owner_id"=>9679, "location_id"=>5535, "start_at"=>"2019-10-01 09:00:00", "end_at"=>"2019-10-01 16:00:00", "shift_content"=>"(Op
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shyft/refs/heads/main/openapi/shyft-customer-requestjobs-api-openapi.yml