Question

Module endpoints

DELETE /questions/:id

DELETE http://api.slyk.io/questions/:id

Deletes the question with given id.

204 No Content

GET /questions

GET https://api.slyk.io/questions

Returns a paginated list of questions.

Name

Type

Example

id

= in nin

filter[id]=7938e446-1c77-4513-8cb0-8b1f2e9f47b9

productTypeCode

ilike

filter[productTypeCode]=bar

title

ilike

filter[title]=foo

typeCode

= in nin

filter[typeCode]=nin:foo

GET /questions/:id

GET https://api.slyk.io/questions/:id

Gets the question details of the given id.

{
  "data": {
      "configurations": { "values": ["39-40", "40-41"] },
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Boot size by number",
      "id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c2",
      "metadata": {},
      "productTypeCode": "physical",
      "required": true,
      "title": "Boot size",
      "typeCode": "single",
      "updatedAt": "2020-08-10T10:00:00.000Z"
    }
}

GET /question-types

GET https://api.slyk.io/question-types

Returns a paginated list of question types.

Name

Type

Example

code

= in nin

filter[code]=foo

PATCH /questions/:id

PATCH https://api.slyk.io/questions/:id

Patches the questions details of the given id.

Field

Type

Required

Description

configurations

object

false

Question configurations that contains possible values.

customData

object

false

Can store any additional information about the question.

description

string

false

Question description.

productTypeCode

string

false

Associated product type code.

required

boolean

false

Require indicator.

title

string

false

Question title.

typeCode

string

false

Associated question type code. One of date, multiple, single, text, time

POST /questions

POST https://api.slyk.io/questions

Creates a new question.

Field

Type

Required

Description

configurations

object

false

Question configurations that contains possible values.

customData

object

false

Can store any additional information about the question.

description

string

false

Question description.

productTypeCode

string

true

Associated product type code.

required

boolean

false

Require indicator.

title

string

true

Question title.

typeCode

string

true

Associated question type code. One of date, multiple, single, text, time

Last updated