This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /certification-schemes

Get list of certiciation schemes (max 100 records)

Description

Returns list of certiciation schemes (max 100 records)

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. name, code, weight, show_in_ingredients, updated_at, created_at
sortDirection optional Direction of sort. asc, desc
code[eq] optional Search for schemes by code. Allowed expression(s): eq, in  
keyword[ct] optional Search for schems by keyword. Allowed expression(s): ct  

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "description": "Id of the record",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "code": {
            "description": "Code for the scheme",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "name": {
            "description": "Name of the scheme",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "show_in_ingredients": {
            "description": "If this certification scheme schould be shown in ingredients",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "weight": {
            "description": "In what order this scheme should be represented",
            "type": "integer",
            "format": "int32",
            "example": 10
          },
          "created_at": {
            "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
            "type": "string",
            "format": "date-time",
            "example": "2019-01-01T13:25:32.312Z"
          },
          "updated_at": {
            "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
            "type": "string",
            "format": "date-time",
            "example": "2020-01-01T13:25:32.312Z"
          }
        },
        "type": "object"
      }
    },
    "links": {
      "description": "Links",
      "properties": {
        "first": {
          "description": "Link to the first page",
          "type": "string"
        },
        "last": {
          "description": "Link to the last page",
          "type": "string"
        },
        "next": {
          "description": "Link to the next page",
          "type": "string"
        },
        "prev": {
          "description": "Link to the previous page",
          "type": "string"
        }
      },
      "type": "object"
    },
    "meta": {
      "description": "Meta with pagination",
      "properties": {
        "current_page": {
          "description": "The current page",
          "type": "integer"
        },
        "from": {
          "description": "The starting position of the current page results",
          "type": "integer"
        },
        "last_page": {
          "description": "The last page",
          "type": "integer"
        },
        "path": {
          "description": "The current path of the request",
          "type": "string"
        },
        "per_page": {
          "description": "Records that are displayed pr request",
          "type": "integer"
        },
        "to": {
          "description": "The ending position of the current page results",
          "type": "integer"
        },
        "total": {
          "description": "Number of records that are matched by the current query",
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

406

not acceptable

500

internal server error

POST /certification-schemes

Create new CertificationScheme

Description

Create a new CertificationScheme

Request body

Description

Target CertificationScheme.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

{
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "code": {
      "description": "Code for the scheme",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "name": {
      "description": "Name of the scheme",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "show_in_ingredients": {
      "description": "If this certification scheme schould be shown in ingredients",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "weight": {
      "description": "In what order this scheme should be represented",
      "type": "integer",
      "format": "int32",
      "example": 10
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

201

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

{
  "properties": {
    "type": "array",
    "items": {
      "required": [
        "name"
      ],
      "properties": {
        "id": {
          "description": "Id of the record",
          "type": "string",
          "format": "uuid",
          "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
        },
        "code": {
          "description": "Code for the scheme",
          "type": "string",
          "format": "string",
          "example": "A string"
        },
        "name": {
          "description": "Name of the scheme",
          "type": "string",
          "format": "string",
          "example": "A string"
        },
        "show_in_ingredients": {
          "description": "If this certification scheme schould be shown in ingredients",
          "type": "string",
          "format": "string",
          "example": "A string"
        },
        "weight": {
          "description": "In what order this scheme should be represented",
          "type": "integer",
          "format": "int32",
          "example": 10
        },
        "created_at": {
          "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
          "type": "string",
          "format": "date-time",
          "example": "2019-01-01T13:25:32.312Z"
        },
        "updated_at": {
          "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
          "type": "string",
          "format": "date-time",
          "example": "2020-01-01T13:25:32.312Z"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

406

not acceptable

500

internal server error