Shyft Customer > Skill API
The Customer > Skill API from Shyft — 4 operation(s) for customer > skill.
OpenAPI Specification
openapi: 3.0.0
info:
title: Shyft Customer Authentication > Email Customer > Skill 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 > Skill
paths:
/api/customer/user_role/locations/2806/skills/managable:
get:
tags:
- Customer > Skill
summary: load location's managable skills
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: Successful response
content:
application/json: {}
/api/customer/user_role/locations/2806/skills/{skill_id}:
get:
tags:
- Customer > Skill
summary: load a single mangable skill
parameters:
- name: skill_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
put:
tags:
- Customer > Skill
summary: update a skill
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"skill\": {\n \"name\": \"New Skill\"\n }\n}"'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: skill_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
delete:
tags:
- Customer > Skill
summary: delete a skill
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: skill_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/customer/user_role/locations/2806/skills:
post:
tags:
- Customer > Skill
summary: create a new skill
requestBody:
content:
application/json:
schema:
type: object
example:
skill:
name: Sample Skill
responses:
'200':
description: Successful response
content:
application/json: {}
/api/customer/user_role/locations/2806/assign_user_skills/7613:
put:
tags:
- Customer > Skill
summary: assign a location user's skills
description: "Description\n- - - \n- Update a location\n- `location_id` coulld be `ID` or `Swift Code`\n\n\nParams\n- - -\nParam | Values | R |Description\n--- | --- | --- | ---\n\n\nHeaders\n- - -\nHeader | Values | R |Description\n--- | --- | --- | ---\n\n\n\nInput\n- - - \nAttribute | Values | R |Description\n--- | --- | --- | ---\nshift_require_approval| true/false| | |\nrequire_approval| true/false| | |\nallow_tipping| true/false| | |\nadmin_delete_content| true/false| | |"
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"skill_ids\": [1, 2]\n}"'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: response[put_return_resource]
in: query
schema:
type: boolean
example: 'true'
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Mon, 25 Apr 2022 21:49:56 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/"7cb2ea80f413d2fd42a1a20b5dc33956"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=Q3ZEN2RLTmlmRStyTFZGLzAyTTEvSjhkSVVGbk5RNldBQnJqait6RDYvUEtxVkdIZHc3NkJFc0gvS0ZtbTNqM2UxSHFhcjh5TFVkOXF6cXRNZmFsOGc9PS0tM0pLWjlXTVBmVnF4VFQ3VWI5SVczdz09--88f57ca98d3b6ef36c9117109918a90af1e9f181; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 290541ed-520c-446e-ab8b-b8f43989b008
X-Runtime:
schema:
type: number
example: '19.617205'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
user:
_parent_object_id: null
id: 7613
active_org: 0
first_name: Kyle210
last_name: Lou
email: kyle@myshyft.com
gender: 0
user_group: 0
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/18131_7613-20210721_144506_273.jpg?1626903906
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/18131_7613-20210721_144506_273.jpg?1626903906
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/18131_7613-20210721_144506_273.jpg?1626903906
current_position: Test
current_user_privilege_id: 21286
current_is_approved: true
current_is_admin: true
all_push: true
shift_push: true
schedule_push: true
community_push: true
cfg_ewa_ok: true
cfg_lock_profile: null
skill_ids:
- 3
- 2
- 1
locale: en
profile_image:
thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/18131_7613-20210721_144506_273.jpg?1626903906
gallery_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/gallery/18131_7613-20210721_144506_273.jpg?1626903906
full_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/full/18131_7613-20210721_144506_273.jpg?1626903906
recent_user_privilege:
id: 21286
wage: null
first_name: Kyle210
last_name: Lou
location_id: 2417
is_admin: true
position: Test
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/18131_7613-20210721_144506_273.jpg?1626903906
owner_id: 7613
chat_handle: 7e3a12108b84396ff25c0d12e9372a6b
phone_number: '18888888210'
is_approved: true
'400':
description: Bad Request
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Mon, 25 Apr 2022 22:23:37 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
Cache-Control:
schema:
type: string
example: no-cache
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=UHpEQmJ2bmRZNi92L1FZUHBWcS94dS9RVmNvQUJRcW1qWFhybGhZbE5FYVVrNnczS2JsV3pFaGdqUVhsTzhXTGUvdmUwd1dWTW9VUUZjOUlkd2h3WFE9PS0tUzAwSVQwNHdNRG5QWGtCNkxVL1RhZz09--c050efe0423773d28e1bb1baca1ae7aeb71c70f0; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 4e606663-f7a0-4486-bcc4-c9d9e96a78bf
X-Runtime:
schema:
type: number
example: '24.075809'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
errors:
skill_ids:
- Not allowed skills
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
noauthAuth:
type: http
scheme: noauth