This document describes the Bitstring Status List Vocabulary, i.e., the RDFS [[RDF-SCHEMA]] vocabulary used by the [[[VC-BITSTRING-STATUS-LIST]]] [[VC-BITSTRING-STATUS-LIST]].
Alternate versions of the vocabulary definition exist in Turtle and JSON-LD.
This vocabulary has been defined by the W3C Verifiable Credentials Working Group and provides the official RDFS vocabulary for Bitstring Status Lists. Comments regarding this document are welcome. Please file issues directly on GitHub, or send them to public-vc-comments@w3.org ( subscribe, archives).
In general, the terms — i.e., the properties and classes — used in the VCDM are formally specified in Recommendation Track documents published by the W3C Verifiable Credentials Working Group. In each case of such external definition, the term's description in this document contains a link to the relevant specification. Additionally, the `rdfs:definedBy` property in the RDFS representation(s) refers to the formal specification.
In some cases, a local explanation is necessary to complement, or to replace, the definition found in an external specification. For instance, this is so when the term is needed to provide a consistent structure to the RDFS vocabulary, such as when the term defines a common supertype for class instances that are used as objects of specific properties. For such cases, the extra definition is included in the current document (and the `rdfs:comment` property is used to include them in the RDFS representations).
cred: or sec: are not defined in this vocabulary;
they have only been added to the diagram for the sake of clarity.This specification makes use of the following namespaces:
cshttps://www.w3.org/ns/credentials/status#credhttps://w3.org/2018/credentials#sechttps://w3id.org/security#dchttp://purl.org/dc/terms/owlhttp://www.w3.org/2002/07/owl#rdfhttp://www.w3.org/1999/02/22-rdf-syntax-ns#rdfshttp://www.w3.org/2000/01/rdf-schema#xsdhttp://www.w3.org/2001/XMLSchema#vshttp://www.w3.org/2003/06/sw-vocab-status/ns#schemahttp://schema.org/jsonldhttp://www.w3.org/ns/json-ld#@context filesThe following @context files make use of the terms defined in this specification:
The following are property definitions in the cs namespace.
statusPurposeStatus purpose
See the formal definition of the term.
xsd:stringBitstringStatusListBitstringStatusListEntry@context:https://www.w3.org/ns/credentials/v2statusListIndexStatus list index
See the formal definition of the term.
xsd:stringBitstringStatusListEntry@context:https://www.w3.org/ns/credentials/v2statusListCredentialStatus list credential
See the formal definition of the term.
BitstringStatusListCredentialBitstringStatusListEntry@context:https://www.w3.org/ns/credentials/v2encodedListEncoded list
See the formal definition of the term.
sec:multibaseBitstringStatusList@context:https://www.w3.org/ns/credentials/v2ttlTime to live in milliseconds
See the formal definition of the term.
xsd:stringBitstringStatusList@context:https://www.w3.org/ns/credentials/v2statusSizeBitstring entry size in bits
See the formal definition of the term.
xsd:positiveIntegerBitstringStatusList@context:https://www.w3.org/ns/credentials/v2statusMessageStatus message
See the formal definition of the term.
BitstringStatusMessageBitstringStatusList@context:https://www.w3.org/ns/credentials/v2statusHexadecimal value of a status message
See the formal definition of the term.
xsd:stringBitstringStatusMessage@context:https://www.w3.org/ns/credentials/v2messageHuman-readable message of a status value
See the formal definition of the term.
xsd:stringBitstringStatusMessage@context:https://www.w3.org/ns/credentials/v2statusReferenceReference documentation for status messages
See the formal definition of the term.
The property's value should be a URL, i.e., not a literal.
BitstringStatusList@context:https://www.w3.org/ns/credentials/v2The following are class definitions in the cs namespace.
BitstringStatusListBitstring status list
See the formal definition of the term.
encodedList, ttl, statusSize, statusMessage, statusReferencestatusPurpose@context:https://www.w3.org/ns/credentials/v2BitstringStatusListEntryBitstring status list entry
See the formal definition of the term.
cred:CredentialStatusstatusListIndex, statusListCredentialstatusPurpose@context:https://www.w3.org/ns/credentials/v2BitstringStatusListCredentialBitstring status list credential
See the formal definition of the term.
cred:VerifiableCredentialstatusListCredential@context:https://www.w3.org/ns/credentials/v2BitstringStatusMessageBitstring status message
See the formal definition of the term.
statusMessagestatus, message@context:https://www.w3.org/ns/credentials/v2cred: or
sec: are not defined in this vocabulary; they have only been added to the diagram for the sake of clarity.The diagram uses boxes, ellipses, and connecting lines with different "styles" (border color, end marker, line type) to differentiate their semantic meaning: "Property", "Class", and "Datatype" are identified by the shape of the graph node (e.g., an ellipse signifies a "Class"); "Superclass", "Domain Of", or "Range" relationships are identified by the style of the connecting line. These style names are used in the explanation text that follows, below.
The diagram is roughly divided into three sections — left, middle, and right. To make this description easier to understand, these sections will be respectively referred to as the "Classes", "Properties", and "Values" sections. Shapes in the three sections are connected by lines of different styles.
The section contains three ellipses, labeled as "cred:CredentialStatus", "BitstringStatusListEntry", and "BitstringStatusList". It also contains a box, styled as "Property" and labeled as "cred:credentialStatus".
The "cred:CredentialStatus" ellipse, is connected to the ellipse, labeled as "cred:CredentialStatus", with a line styled "Range". The ellipse labeled as "BitstringStatusListEntry" is connected to the ellipse, labeled as "cred:CredentialStatus", with a line styled as "Superclass".
The ellipses labeled as "BitstringStatusListEntry" and "BitstringStatusList" are also connected to a number of boxes, all styled as "Property", with lines styled as "Domain Of"; see the "Properties" section below for further details.
The section contains a number of boxes, each styles as "Property". The labels of these boxes are "statusListIndex", "statusListCredential", "statusPurpose", "statusMessage", "ttl", "statusReference", "statusSize", and "encodedList". There is also a small, unlabeled circle, which serves as an intersection point for connector lines.
The ellipse labeled as "BitstringStatusListEntry", described in the previous section, is connected to the "statusListIndex", and "statusListCredential" boxes with lines styled as "Domain Of". The ellipse labeled as "BitstringStatusList", also described in the previous section, is connected to the "statusMessage", "ttl", "statusReference", "statusSize", and "encodedList" boxes, also with lines styled as "Domain Of".
Both the ellipses labeled as "BitstringStatusListEntry" and "BitstringStatusList" are connected to the intersection point with a line styled as "Domain Of", and the intersection point is connected to the box labeled as "statusPurpose with a line styled as "Domain Of".
The section contains and ellipse, labeled as "BitstringStatusListCredential", which is connected to another ellipse, labeled as "cred:VerifiableCredential", with a line styled as "Superclass". The box labeled as "statusListCredential", described in the previous section, is connected to the ellipse, labeled as "BitstringStatusListCredential", with a line styled as "Range".
Another ellipse, labeled as "BistringStatusMessage", is connected to two boxes with lines styled as "Domain Of". The boxes are styled as "Property" and are labeled with "status" and "message". The box labeled as "statusMessage", described in the previous section, is connected to the ellipse, labeled as "BistringStatusMessage", with a line styled as "Range".
The box labeled as "statusSize", described in the previous section, is connected to a box, styled as "Datatype", and labeled as "xsd:positiveInteger", with a line styled as "Range".
The box labeled as "encodedList", described in the previous section, is connected to a box, styled as "Datatype", and labeled as "sec:multibase", with a line styled as "Range".