What is Free Post? Free Post is basically a type of `post`, with `post_type = 22` * free post requires `postable_type` and `postable_id` * current user must has visibility of `postable` to create a free_post for it. * free post does not take a `channel_id` as input * any API targeting on a single post can be used for `free_post` Please use the regular post `create` API to create a free_post * Here we are applying `compact` serializer to the result.
openapi: 3.0.0
info:
title: Shyft Customer Authentication > Email Compact > Posts 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 > Posts
description: "What is Free Post? \n\nFree Post is basically a type of `post`, with `post_type = 22` \n\n* free post requires `postable_type` and `postable_id`\n* current user must has visibility of `postable` to create a free_post for it. \n* free post does not take a `channel_id` as input\n* any API targeting on a single post can be used for `free_post`\n\nPlease use the regular post `create` API to create a free_post\n\n* Here we are applying `compact` serializer to the result. \n"
paths:
/api/compact/posts/{post_id}/free_posts:
get:
tags:
- Compact > Posts
summary: get a post's free_posts
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: 1f01adc9-16a9-49e4-8329-2e8cd8245dad
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: post_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Mon, 04 Jan 2021 18:48:44 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/"b655633e741807e188a8badd0230e5fb"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=ZVJxK2RvN1BCMmY5cE9OV1oxZ3NHREc4ZFZXcXQ0NkxnaHVWWm96K29kc0lDZk53ZjFpaUFtZTJocGNTbDdVV1E2ZlJqV2VLeWxzUFB0bDFGdldaZEE9PS0tbkNxMDhOTnpnMDcrUENBQ2hxeVkzQT09--354de754d06583a23f894b9027c4baf19cb26ea4; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 7e9e3e5a-0a7e-45c1-8a0d-7a2c42e68e73
X-Runtime:
schema:
type: number
example: '4.455284'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
posts:
- _parent_object_id: null
id: 90207
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:36:19.713Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Post
postable_id: 90204
final_allow_delete: true
final_allow_comment: null
final_allow_like: null
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90206
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:32:13.682Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Post
postable_id: 90204
final_allow_delete: true
final_allow_comment: null
final_allow_like: null
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90205
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:11:14.450Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Post
postable_id: 90204
final_allow_delete: true
final_allow_comment: null
final_allow_like: null
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
meta:
pagination:
current_page: 1
per_page: 500
/api/compact/posts/{post_id}/get_current_applicants:
get:
tags:
- Compact > Posts
summary: get a post's applicants
description: 'NOTE: Only applicable for `shift post` , otherwise raise `403`'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: post_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/compact/applicants/{applicant_id}/free_posts:
get:
tags:
- Compact > Posts
summary: get a applicant's free_posts
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: applicant_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Tue, 06 Jul 2021 19:56:21 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/"d961bac53ea237f583f80266c47ab6a2"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=bFVuZVZycGExWVVnT25WNmRCeEpOdDJFa1FXVVlwMjdsOWRjQTJaYUxjYVE3RTZQTzYzY3RTUXBHaXltbFIzd1pIR203aERwODZ6Z2V2Qi9qTituQnc9PS0tMnRjTGg4WW5WMjdadDNsKzcxbG5OUT09--a05195ad7177051ff455bcdd7f103819baad657e; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: e8bb03b9-9a88-46f5-b05a-8da94d52d6a5
X-Runtime:
schema:
type: number
example: '17.731976'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
posts:
- _parent_object_id: null
id: 90208
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:49:26.940Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90209
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:49:46.083Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90210
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:56:02.386Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90211
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:56:33.933Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90212
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:58:46.439Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90213
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2020-12-28T22:58:52.005Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
- _parent_object_id: null
id: 90217
org_id: 1
channel_id: null
title: Free Post
content: This is a sample free posts 2
comments_count: 0
likes_count: 0
views_count: 0
read_count: 0
created_at: '2021-01-04T18:56:00.143Z'
attachment: null
user_group: 0
location: 2622
post_type: 22
pinned: false
pinned_by_id: null
url_meta: null
giphy_meta: null
postable_type: Applicant
postable_id: 3227
final_allow_delete: true
final_allow_comment: null
final_allow_like: true
final_allow_read: false
owner_id: 11284
read: false
liked: false
commented: false
meta:
pagination:
current_page: 1
per_page: 500
/api/compact/posts/{post_id}/like_owner_ids:
get:
tags:
- Compact > Posts
summary: get a post's like user ids
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: post_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Tue, 23 Feb 2021 00:00:31 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/"8b7c1eaa1f5075f74aa267e37733ca50"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=d0xBRkgwOWhZaUxTeEJodFZYemZLeVh0Q3pKWjZMYy83QjArMW1WSzR3NVVJc0dXYTlNWm1RaU5Wd3pQUU14UWtsOVFDeElFUnJESktSZ1lxNmY3dmc9PS0tSVc1VEU1MGNFY1g3UG9tcU9oZmlWUT09--ead651306fd1e7c1ae26e38b95c739de346e69d4; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 2ccee61b-52a6-47b6-bcca-ea869d961ba7
X-Runtime:
schema:
type: number
example: '22.151550'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
ids:
- 1
/api/compact/posts/{post_id}/receipt_user_ids:
get:
tags:
- Compact > Posts
summary: get a post's read user ids
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: post_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
example: nginx/1.19.3
Date:
schema:
type: string
example: Tue, 23 Feb 2021 00:00:42 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/"8f05bafd61f29998ca102b333f853628"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=RFBidm1QVXZyMzNzL1A5a09XdStuSWVTKytwN0E0MVFKSFFCMVY5dm5KaFdCY3hyeS8wMCtENWJzUnNaSFFoUVV4M1dpVEtlZzZSSjFEbWVCVTU3dmc9PS0tbTdlZTFTTFRPeExZQXlnbHJaOXZRQT09--3d440073bd9899ef563ccddcc27627f0ebf9d5f4; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: d57f09cd-fa28-4a2b-92f4-0ac4b7e3c99d
X-Runtime:
schema:
type: number
example: '0.466136'
Vary:
schema:
type: string
example: Origin
content:
application/json:
schema:
type: object
example:
ids: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
noauthAuth:
type: http
scheme: noauth