FeedbackBuzzer API API Reference

This is the API documentation for the FeedbackBuzzer API. For authentication, we are using auth0 as provider enabling several out-of-the-box identify provider like LinkedIn, Github, Facebook etc. Therefore, oauth 2.0 as protocol is implemented and strictly enforced for all API requests.

API Endpoint
/nyc.feedback.next-gen.club/
Terms of Service: /next-gen.club/terms/
Contact: 815-247-5214
Schemes: http, https
Version: 1.0.0

Authentication

sheinnovates_auth

authorizationUrl
/sapnextgen.auth0.com
flow
implicit

api_key

name
X-Authorization
in
header

profiles

Get all available profiles

GET /profiles
search

String which should be included in either title, name or description

type
string
in
query

successful operation

400 Bad Request

Invalid status value

Response Content-Types: text/html, application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "title": "string",
    "description": "string",
    "image": "string",
    "created_at": "string (date-time)",
    "updated_at": "string (date-time)"
  }
]
530-252-4429 read:all

Add a new profile as resources

POST /profiles

Profile object that needs to be added as resource

Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "description": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
405 Method Not Allowed

Invalid input

Response Content-Types: plain/html, application/json
5856711837 write:all , read:all

Update an existing profile

PUT /profiles

Profile object that needs to be added or altered as resource

Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "description": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
400 Bad Request

Invalid ID supplied

404 Not Found

Profile not found

405 Method Not Allowed

Validation exception

Response Content-Types: plain/html, application/json
sheinnovates_auth write:all , read:all

Find profile by ID

GET /profiles/{profileId}

Returns a single profile

profileId

ID of profile to return

type
integer (int64)
in
path
200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Profile not found

Response Content-Types: text/html, application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "title": "string",
  "description": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
4153589254 read:all

Deletes an profile

DELETE /profiles/{profileId}
api_key

(no description)

type
string
in
header
profileId

Profile id to delete

type
integer (int64)
in
path
400 Bad Request

Invalid ID supplied

404 Not Found

Profile not found

Response Content-Types: application/xml, application/json
sheinnovates_auth write:all

Update an existing profile

PUT /profiles/{profileId}

Profile object that needs to be added or altered as resource

profileId

Profile id to delete

type
integer (int64)
in
path
Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "description": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
400 Bad Request

Invalid ID supplied

404 Not Found

Profile not found

405 Method Not Allowed

Validation exception

Response Content-Types: plain/html, application/json
7348174304 write:all , read:all

thankyous

Get all available thankyous

GET /thankyous
search

String which should be included in either title, name or description

type
string
in
query
200 OK

successful operation

400 Bad Request

Invalid status value

Response Content-Types: text/html, application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "title": "string",
    "video": "boolean",
    "image": "string",
    "created_at": "string (date-time)",
    "updated_at": "string (date-time)"
  }
]
2708681477 read:all

Add a new thankyou as resources

POST /thankyous

Thankyou object that needs to be added as resource

Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "video": "boolean",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
405 Method Not Allowed

Invalid input

Response Content-Types: plain/html, application/json
8166767155 write:public , read:public

Update an existing thankyou

PUT /thankyous

Thankyou object that needs to be added or altered as resource

Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "video": "boolean",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
400 Bad Request

Invalid ID supplied

404 Not Found

Thankyou not found

405 Method Not Allowed

Validation exception

Response Content-Types: plain/html, application/json
7819716154 write:all , read:all

Random thankyou

GET /thankyous/random

Returns a single randomly selected thankyou

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Thankyou not found

Response Content-Types: text/html, application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "title": "string",
  "video": "boolean",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
9086385470 read:public

Find thankyou by ID

GET /thankyous/{thankyouId}

Returns a single thankyou

thankyouId

ID of thankyou to return

type
integer (int64)
in
path
200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Thankyou not found

Response Content-Types: text/html, application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "title": "string",
  "video": "boolean",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}

Deletes an thankyou

DELETE /thankyous/{thankyouId}
api_key

(no description)

type
string
in
header
thankyouId

Thankyou id to delete

type
integer (int64)
in
path
400 Bad Request

Invalid ID supplied

404 Not Found

Thankyou not found

Response Content-Types: application/xml, application/json
sheinnovates_auth write:all

Update an existing thankyou

PUT /thankyous/{thankyouId}

Thankyou object that needs to be added or altered as resource

thankyouId

Thankyou id to delete

type
integer (int64)
in
path
Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "video": "boolean",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
400 Bad Request

Invalid ID supplied

404 Not Found

Thankyou not found

405 Method Not Allowed

Validation exception

Response Content-Types: plain/html, application/json
collineate write:all , read:all

feedbacks

Get all available feedbacks

GET /feedbacks
search

String which should be included in either title, name or description

type
integer
in
query
start_datetime

Datetime as integer defining the earliest feedback for consideration

type
string
in
query
end_datetime

Datetime as integer defining the latest feedback for consideration

type
integer
in
query
200 OK

successful operation

400 Bad Request

Invalid status value

Response Content-Types: text/html, application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "rating": "integer (int64)",
    "name": "string",
    "comment": "string",
    "image": "string",
    "created_at": "string (date-time)",
    "updated_at": "string (date-time)"
  }
]
(925) 899-6186 read:all

Add a new feedback as resources

POST /feedbacks

Feedback object that needs to be added as resource

Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "rating": "integer (int64)",
  "name": "string",
  "comment": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
405 Method Not Allowed

Invalid input

Response Content-Types: plain/html, application/json
sheinnovates_auth write:all , read:all

Update an existing feedback

PUT /feedbacks

Feedback object that needs to be added or altered as resource

Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "rating": "integer (int64)",
  "name": "string",
  "comment": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
400 Bad Request

Invalid ID supplied

404 Not Found

Feedback not found

405 Method Not Allowed

Validation exception

Response Content-Types: plain/html, application/json
952-285-1387 write:all , read:all

Get analytics about feedbacks

GET /feedbacks/analytics
200 OK

successful operation

400 Bad Request

Invalid status value

Response Content-Types: text/html

Generate a feedback

GET /feedbacks/generate
rating

Rating of feedback

type
integer (int64)
in
query
200 OK

successful operation, will be automatically redirecty to random thankyou

Response Content-Types: text/html, application/json

Generate a feedback

POST /feedbacks/generate

Feedback object that needs to be added as resource

Request Example
{
  "id": "integer (int64)",
  "rating": "integer (int64)",
  "name": "string",
  "comment": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
200 OK

successful operation, will be automatically redirecty to random thankyou

Response Content-Types: text/html, application/json

Find feedback by ID

GET /feedbacks/{feedbackId}

Returns a single feedback

feedbackId

ID of feedback to return

type
integer (int64)
in
path
200 OK

successful operation

400 Bad Request

Invalid ID supplied

404 Not Found

Feedback not found

Response Content-Types: text/html, application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "rating": "integer (int64)",
  "name": "string",
  "comment": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}

Deletes an feedback

DELETE /feedbacks/{feedbackId}
api_key

(no description)

type
string
in
header
feedbackId

Feedback id to delete

type
integer (int64)
in
path
400 Bad Request

Invalid ID supplied

404 Not Found

Feedback not found

Response Content-Types: application/xml, application/json
sheinnovates_auth write:all

Update an existing feedback

PUT /feedbacks/{feedbackId}

Feedback object that needs to be added or altered as resource

feedbackId

Feedback id to delete

type
integer (int64)
in
path
Request Content-Types: application/json, multipart/form-data, application/x-www-form-urlencoded
Request Example
{
  "id": "integer (int64)",
  "rating": "integer (int64)",
  "name": "string",
  "comment": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}
400 Bad Request

Invalid ID supplied

404 Not Found

Feedback not found

405 Method Not Allowed

Validation exception

Response Content-Types: plain/html, application/json
sheinnovates_auth write:all , read:all

Schema Definitions

Profile: object

id: integer (int64)
title: string
description: string
image: string
created_at: string (date-time)
updated_at: string (date-time)
Example
{
  "id": "integer (int64)",
  "title": "string",
  "description": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}

Feedback: object

id: integer (int64)
rating: integer (int64)
name: string
comment: string
image: string
created_at: string (date-time)
updated_at: string (date-time)
Example
{
  "id": "integer (int64)",
  "rating": "integer (int64)",
  "name": "string",
  "comment": "string",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}

Thankyou: object

id: integer (int64)
title: string
video: boolean
image: string
created_at: string (date-time)
updated_at: string (date-time)
Example
{
  "id": "integer (int64)",
  "title": "string",
  "video": "boolean",
  "image": "string",
  "created_at": "string (date-time)",
  "updated_at": "string (date-time)"
}

ApiResponse: object

code: integer (int32)
type: string
message: string
Example
{
  "code": "integer (int32)",
  "type": "string",
  "message": "string"
}