Categorization

Some content types can be categorized, allowing for e.g. connecting technical FAQ answers with users to contact about technical issues.

News, suppliers and units can also be categorized and used for filtering.

Get FAQ Categories

curl "https://example.ziik.io/api/faq/categories"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
[{
    "id": "142",
    "name": "Administration"
}, {
    "id": "141",
    "name": "Sales"
}, {
    "id": "140",
    "name": "Technical"
}]

This endpoint retrieves a list of FAQ categories.

HTTP Request

GET https://example.ziik.io/api/faq/categories

Query Parameters

None

Get Single FAQ Category

Create FAQ Category

curl -i -X POST "https://example.ziik.io/api/faq/categories"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 201 Created with a location header for where to find the newly created category

HTTP/1.0 201 Created
Location: https://example.ziik.io/api/faq/categories/1234
{
    "message": "Category created"
}

This endpoint creates a new FAQ category.

HTTP Request

POST https://example.ziik.io/api/faq/categories

Request Parameters

ParameterTypeRequiredDescription
nameStringYesCategory name

Permissions Required

  • Administer permission to FAQ

Edit FAQ Category

curl -i -X PATCH "https://example.ziik.io/api/faq/categories/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing FAQ category.

HTTP Request

PATCH https://example.ziik.io/api/faq/categories/ID

Request Parameters

ParameterTypeRequiredDescription
nameStringNoNew category name

Permissions Required

  • Administer permission to FAQ

Delete FAQ Category

curl -i -X DELETE "https://example.ziik.io/api/faq/categories/123"
  -H "Authorization: Bearer aaaaaa.bbbbbbb.ccccccc"

The above command returns a 204 No Content header on success:

HTTP/1.0 204 No Content

This endpoint deletes a FAQ category.

HTTP Request

DELETE https://example.ziik.io/api/faq/categories/ID

URL Parameters

ParameterTypeDescription
IDIntegerThe ID of the category to delete

Permissions Required

  • Administer permission to FAQ

Get Supplier Categories

curl "https://example.ziik.io/api/suppliers/categories"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
[{
    "id": "151",
    "name": "IT"
}, {
    "id": "162",
    "name": "Office supply"
}]

This endpoint retrieves a list of supplier categories.

HTTP Request

GET https://example.ziik.io/api/suppliers/categories

Query Parameters

None

Get Single Supplier Category

Create Supplier Category

curl -i -X POST "https://example.ziik.io/api/suppliers/categories"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 201 Created with a location header for where to find the newly created category

HTTP/1.0 201 Created
Location: https://example.ziik.io/api/suppliers/categories/1234
{
    "message": "Category created"
}

This endpoint creates a new supplier category.

HTTP Request

POST https://example.ziik.io/api/suppliers/categories

Request Parameters

ParameterTypeRequiredDescription
nameStringYesCategory name

Permissions Required

  • Administer permission to supplier chain

Edit Supplier Category

curl -i -X PATCH "https://example.ziik.io/api/suppliers/categories/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing supplier category.

HTTP Request

PATCH https://example.ziik.io/api/suppliers/categories/ID

Request Parameters

ParameterTypeRequiredDescription
nameStringNoNew category name

Permissions Required

  • Administer permission to supplier chain

Delete Supplier Category

curl -i -X DELETE "https://example.ziik.io/api/suppliers/categories/123"
  -H "Authorization: Bearer aaaaaa.bbbbbbb.ccccccc"

The above command returns a 204 No Content header on success:

HTTP/1.0 204 No Content

This endpoint deletes a supplier category.

HTTP Request

DELETE https://example.ziik.io/api/suppliers/categories/ID

URL Parameters

ParameterTypeDescription
IDIntegerThe ID of the category to delete

Permissions Required

  • Administer permission to supplier chain

Get Unit Features

curl "https://example.ziik.io/api/units/features"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
[{
    "id": "175",
    "name": "Firstline support"
}, {
    "id": "178",
    "name": "Secondline support"
}]

This endpoint retrieves a list of unit features.

HTTP Request

GET https://example.ziik.io/api/units/features

Query Parameters

None

Get Single Unit Feature

Create Unit Feature

curl -i -X POST "https://example.ziik.io/api/units/features"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 201 Created with a location header for where to find the newly created feature

HTTP/1.0 201 Created
Location: https://example.ziik.io/api/units/features/1234
{
    "message": "Feature created"
}

This endpoint creates a new unit feature.

HTTP Request

POST https://example.ziik.io/api/units/features

Request Parameters

ParameterTypeRequiredDescription
nameStringYesFeature name

Permissions Required

  • Administer permission to units

Edit Unit Feature

curl -i -X PATCH "https://example.ziik.io/api/units/features/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing unit feature.

HTTP Request

PATCH https://example.ziik.io/api/units/features/ID

Request Parameters

ParameterTypeRequiredDescription
nameStringNoNew feature name

Permissions Required

  • Administer permission to units

Delete Unit Feature

curl -i -X DELETE "https://example.ziik.io/api/units/features/123"
  -H "Authorization: Bearer aaaaaa.bbbbbbb.ccccccc"

The above command returns a 204 No Content header on success:

HTTP/1.0 204 No Content

This endpoint deletes a unit feature.

HTTP Request

DELETE https://example.ziik.io/api/units/features/ID

URL Parameters

ParameterTypeDescription
IDIntegerThe ID of the feature to delete

Permissions Required

  • Administer permission to units

Get User Specialties

curl "https://example.ziik.io/api/users/specialties"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
[{
    "id": "187",
    "name": "Development"
}, {
    "id": "181",
    "name": "Franchise"
}, {
    "id": "185",
    "name": "Sales"
}, {
    "id": "189",
    "name": "Support"
}]

This endpoint retrieves a list of user specialties.

HTTP Request

GET https://example.ziik.io/api/users/specialties

Query Parameters

None

Get Single User Specialty

Create User Specialty

curl -i -X POST "https://example.ziik.io/api/users/specialties"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 201 Created with a location header for where to find the newly created specialty

HTTP/1.0 201 Created
Location: https://example.ziik.io/api/users/specialties/1234
{
    "message": "Specialty created"
}

This endpoint creates a new user specialty.

HTTP Request

POST https://example.ziik.io/api/users/specialties

Request Parameters

ParameterTypeRequiredDescription
nameStringYesCategory name

Permissions Required

  • Administer permission to users

Edit User Specialty

curl -i -X PATCH "https://example.ziik.io/api/users/specialties/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing user specialty.

HTTP Request

PATCH https://example.ziik.io/api/users/specialties/ID

Request Parameters

ParameterTypeRequiredDescription
nameStringNoNew specialty name

Permissions Required

  • Administer permission to users

Delete User Specialty

curl -i -X DELETE "https://example.ziik.io/api/users/specialties/123"
  -H "Authorization: Bearer aaaaaa.bbbbbbb.ccccccc"

The above command returns a 204 No Content header on success:

HTTP/1.0 204 No Content

This endpoint deletes a user specialty.

HTTP Request

DELETE https://example.ziik.io/api/users/specialties/ID

URL Parameters

ParameterTypeDescription
IDIntegerThe ID of the specialty to delete

Permissions Required

  • Administer permission to users