Riktig Docs
StartHelp CenterDeveloperBasic ItemCourse Certificate

Developer

Item specifications are named schemas/templates that are identified by a 32-bit value, and specifies the recognized item specifications, with examples and schemas.

The item specification schema is used by compatible apps to draw an appropriate GUI for the scanned item.

NameData FormatSchema Format
Basic ItemJSONJSONSchema
Course CertificateJSONJSONSchema

Basic Item

Any item which is simple and does not require it's own template. It is suitable for testing or one-off issuances but does not support advanced GUI displays.

Identifier (hex): 0000000000000000000000000000000000000000000000000000000000000002

Example

{
"name": "John Doe's Leatherworking",
"description": "110 cm rugged leather belt"
}

Schema

{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "http://example.com/example.json",
"type": "object",
"title": "The root schema",
"description": "The root schema comprises the entire JSON document.",
"default": {},
"required": ["name", "description"],
"additionalProperties": true,
"properties": {
"name": {
"$id": "#/properties/name",
"type": "string",
"title": "The name schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["John Doe's Leatherworking"]
},
"description": {
"$id": "#/properties/description",
"type": "string",
"title": "The description schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["110 cm rugged leather belt"]
}
}
}

Course Certificate

Describes a certificate, which is usually awarded at the end of some period of education or training.

Identifier: 0000000000000000000000000000000000000000000000000000000000000001

Example

{
"name": "Cloud Infrastructure Associate Level",
"description": "Basic cloud skills for beginner cloud gurus",
"trainingFrom": "",
"trainingTo": "",
"issuedAt": "",
"validUntil": "",
"image": "ipfs://18XlJcnu37PfxNish1",
"instructor": "John Doe",
"location": "Gothenburg, Sweden",
"recipient": "Jane Doe",
"externalId": "19LABC148392",
"remark": "Outstanding performance! Test score: 98 %"
}

Schema

{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "http://example.com/example.json",
"type": "object",
"title": "The Root Schema",
"description": "The root schema comprises the entire JSON document.",
"default": {},
"additionalProperties": true,
"required": ["name", "recipient"],
"properties": {
"name": {
"$id": "#/properties/name",
"type": "string",
"title": "The Name Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["Cloud Infrastructure Associate Level"]
},
"description": {
"$id": "#/properties/description",
"type": "string",
"title": "The Description Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["Basic cloud skills for beginner cloud gurus"]
},
"trainingFrom": {
"$id": "#/properties/trainingFrom",
"type": "string",
"title": "The Trainingfrom Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [""]
},
"trainingTo": {
"$id": "#/properties/trainingTo",
"type": "string",
"title": "The Trainingto Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [""]
},
"issuedAt": {
"$id": "#/properties/issuedAt",
"type": "string",
"title": "The Issuedat Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [""]
},
"validUntil": {
"$id": "#/properties/validUntil",
"type": "string",
"title": "The Validuntil Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [""]
},
"image": {
"$id": "#/properties/image",
"type": "string",
"title": "The Image Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["ipfs://18XlJcnu37PfxNish1"]
},
"instructor": {
"$id": "#/properties/instructor",
"type": "string",
"title": "The Instructor Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["John Doe"]
},
"location": {
"$id": "#/properties/location",
"type": "string",
"title": "The Location Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["Gothenburg, Sweden"]
},
"recipient": {
"$id": "#/properties/recipient",
"type": "string",
"title": "The Recipient Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["Jane Doe"]
},
"externalId": {
"$id": "#/properties/externalId",
"type": "string",
"title": "The Externalid Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["19LABC148392"]
},
"remark": {
"$id": "#/properties/remark",
"type": "string",
"title": "The Remark Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": ["Outstanding performance! Test score: 98 %"]
}
}
}