Badge

Processes the specified outcome.

post

For internal use only.

Path parameters

strTokenstringRequired

The login token

outcomeCodestringRequired

The outcome code

Responses

200

Success

application/json

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post/api/v2/Outcome/{strToken}/{outcomeCode}

POST /api/v2/Outcome/{strToken}/{outcomeCode} HTTP/1.1
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Processes a badge assignment.

post

For internal use only.

Body

refIdstring · min: 1Required

outcomestring · min: 1Required

badgeUrlstring · min: 1Required

Responses

200

Success

application/json

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post/api/v2/BadgeAssignment

POST /api/v2/BadgeAssignment HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "refId": "text",
  "outcome": "text",
  "badgeUrl": "text"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of Badge objects assigned to the currently logged in User.

get

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

Response of a List Badges request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get/api/v2/Badges/{strToken}

GET /api/v2/Badges/{strToken} HTTP/1.1
Accept: */*

200

Success

{
  "badges": [
    {
      "badgeID": "text",
      "date": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "description": "text",
      "imageURL": "text",
      "tags": [
        "text"
      ],
      "issuerName": "text",
      "issuerDescription": "text",
      "issuerEmail": "text",
      "issuerURL": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of Badge objects assigned to the currently logged in User.

get

Path parameters

strTokenstringRequired

The login token

strBadgeIDstringRequired

The ID of the Badge object

Responses

200

Success

application/json

Response of a Get Badge request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get/api/v2/Badge/{strToken}/{strBadgeID}

GET /api/v2/Badge/{strToken}/{strBadgeID} HTTP/1.1
Accept: */*

200

Success

{
  "badge": {
    "badgeID": "text",
    "date": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "description": "text",
    "imageURL": "text",
    "tags": [
      "text"
    ],
    "issuerName": "text",
    "issuerDescription": "text",
    "issuerEmail": "text",
    "issuerURL": "text"
  },
  "requestID": 1,
  "requestDateTime": "2026-01-01T00:00:00.000Z",
  "resultCode": 1,
  "resultMessage": "text"
}