Table of Contents

Class XapiErrorCodes

Namespace
Xapi
Assembly
Xapi.Core.dll

The stable error codes used in Code. Codes name the rule; Path says where it was broken. Section numbers refer to IEEE 9274.1.1 (LRS book unless stated).

public static class XapiErrorCodes
Inheritance
XapiErrorCodes
Inherited Members

Fields

AttachmentLength

An attachment length below zero.

public const string AttachmentLength = "attachment.length.negative"

Field Value

string

AttachmentPayloadMissing

An Attachment without a fileUrl and without attachment data of the same SHA-2 to send with it (4.1.3). Reported by Xapi.Client and Xapi.Client.Outbox before sending, not by the statement validator; Path is the Attachment, for example $.attachments[0].

public const string AttachmentPayloadMissing = "attachment.payload.missing"

Field Value

string

AttachmentPayloadUnreferenced

Attachment data that no Attachment of the Statements refers to by SHA-2 (4.1.3). Reported by Xapi.Client before sending. The data is not part of the JSON, so Path is its index in the list of attachment data passed with the Statements, for example attachments[0], without the $ of a JSON path.

public const string AttachmentPayloadUnreferenced = "attachment.payload.unreferenced"

Field Value

string

AuthorityGroup

A Group authority that is not an anonymous Group of exactly two Agents (the OAuth 3-legged form of xAPI 1.0.3, Data 2.4.9; still tested by the conformance suite for 2.0).

public const string AuthorityGroup = "authority.group"

Field Value

string

BatchDuplicateId

Two statements in one batch share an id (4.1.6.1).

public const string BatchDuplicateId = "batch.id.duplicate"

Field Value

string

ContextPlatform

context.platform on a Statement whose object is not an Activity. Same background as ContextRevision.

public const string ContextPlatform = "context.platform.object"

Field Value

string

ContextRevision

context.revision on a Statement whose object is not an Activity. A 1.0.3 rule (Data 2.4.6) that the conformance suite also applies to 2.0 (ADL CTS issue #278); enforced in both versions.

public const string ContextRevision = "context.revision.object"

Field Value

string

ContextVersion

contextAgents or contextGroups used with the 1.0.3 profile.

public const string ContextVersion = "context.version"

Field Value

string

Duration

Not an ISO 8601:2004 4.4.3.2 duration (4.2.7 "Duration").

public const string Duration = "format.duration"

Field Value

string

GroupMemberMissing

An anonymous Group without members (4.2.2.1, "member" is required).

public const string GroupMemberMissing = "group.member.missing"

Field Value

string

GroupMemberNotAgent

A Group used inside the member property of a Group (4.2.4.2).

public const string GroupMemberNotAgent = "group.member.not-agent"

Field Value

string

IfiMissing

An Agent or identified Group without an inverse functional identifier (4.2.2.1).

public const string IfiMissing = "actor.ifi.missing"

Field Value

string

IfiMultiple

An Agent or Group with more than one inverse functional identifier (4.2.4.2).

public const string IfiMultiple = "actor.ifi.multiple"

Field Value

string

InteractionComponentDuplicate

Two interaction components in the same list share an id.

public const string InteractionComponentDuplicate = "interaction.component.duplicate"

Field Value

string

InteractionComponentsNotAllowed

An interaction component list that the interactionType does not support (4.2.2.3).

public const string InteractionComponentsNotAllowed = "interaction.components.not-allowed"

Field Value

string

InteractionType

An interactionType outside the controlled vocabulary (4.2.2.3).

public const string InteractionType = "format.interaction-type"

Field Value

string

InteractionTypeMissing

Interaction properties (correctResponsesPattern, component lists) without an interactionType (4.2.4.2).

public const string InteractionTypeMissing = "interaction.type.missing"

Field Value

string

Iri

Not an absolute IRI, or the default (empty) Iri (4.2.7 "IRIs").

public const string Iri = "format.iri"

Field Value

string

JsonNull

An explicit null outside extension values (4.2.1). Strict mode only.

public const string JsonNull = "json.null"

Field Value

string

JsonSyntax

The input is not well-formed JSON, or has content after the first value.

public const string JsonSyntax = "json.syntax"

Field Value

string

JsonType

A value has the wrong JSON type, for example a string where a number or an object is required (4.2.1).

public const string JsonType = "json.type"

Field Value

string

LanguageTag

Not a well-formed RFC 5646 language tag (4.2.7 "Language Maps", context.language).

public const string LanguageTag = "format.language-tag"

Field Value

string

Mbox

Not a mailto: IRI with an e-mail address (4.2.2.1).

public const string Mbox = "format.mbox"

Field Value

string

MediaType

Not an Internet media type (contentType, 4.2.2.6).

public const string MediaType = "format.media-type"

Field Value

string

ObjectType

An objectType value that is not allowed at this location, or has the wrong case (4.2.1).

public const string ObjectType = "format.object-type"

Field Value

string

PropertyCase

A property name that matches a defined property only when case is ignored (4.2.1). Strict mode only.

public const string PropertyCase = "json.property.case"

Field Value

string

PropertyDuplicate

The same property appears more than once in one object (4.2.1). Strict mode only.

public const string PropertyDuplicate = "json.property.duplicate"

Field Value

string

PropertyRequired

A required property is missing.

public const string PropertyRequired = "json.property.required"

Field Value

string

PropertyUnknown

A property the standard does not define at this location (4.2.1). Strict mode only.

public const string PropertyUnknown = "json.property.unknown"

Field Value

string

PropertyVersion

A property that exists only in a later xAPI version, such as contextAgents under 1.0.3.

public const string PropertyVersion = "json.property.version"

Field Value

string

RelevantTypesEmpty

relevantTypes present but empty; it must hold one or more IRIs (4.2.2.5).

public const string RelevantTypesEmpty = "context.relevant-types.empty"

Field Value

string

ScoreMinMax

score.min not less than score.max (4.2.2.4).

public const string ScoreMinMax = "score.min-max"

Field Value

string

ScoreNotFinite

A score value that is NaN or infinite.

public const string ScoreNotFinite = "score.not-finite"

Field Value

string

ScoreRaw

score.raw below min or above max (4.2.2.4).

public const string ScoreRaw = "score.raw.range"

Field Value

string

ScoreScaled

score.scaled outside -1..1 (4.2.2.4).

public const string ScoreScaled = "score.scaled.range"

Field Value

string

Sha1

Not a 40-character hexadecimal SHA-1 digest (mbox_sha1sum, 4.2.2.1).

public const string Sha1 = "format.sha1"

Field Value

string

Sha2

Not a hexadecimal SHA-2 digest (sha2, 4.2.2.6).

public const string Sha2 = "format.sha2"

Field Value

string

SubStatementNested

A SubStatement whose object is another SubStatement (4.2.4.2).

public const string SubStatementNested = "substatement.nested"

Field Value

string

Timestamp

Not an RFC 3339 timestamp with a UTC offset (4.2.7 "Timestamps").

public const string Timestamp = "format.timestamp"

Field Value

string

Uuid

Not a UUID in the standard 8-4-4-4-12 hexadecimal form (4.2.7 "UUIDs").

public const string Uuid = "format.uuid"

Field Value

string

Version

A statement version the profile does not accept: 1.0.x for 1.0.3; 1.0.x or 2.0.0 for 2.0.0.

public const string Version = "format.version"

Field Value

string

VoidingObject

A Statement using the voided Verb whose object is not a StatementRef (4.2.5).

public const string VoidingObject = "statement.voiding.object"

Field Value

string
Edit this page