List Fault Types

get/api/fault-types

Lists all fault types.

Response

Successful operation.

Body application/json

itemsobject[]
Items
- namestring
  The name of the fault type.
- valueTypestring
  The type of configuration value the fault type accepts.
- effectstring
  The effect the fault type produces.
- allowedAccountTypesstring[]
  The account types that are permitted to configure this fault type.
- descriptionstring

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://api.immersve.com/api/fault-types \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "items": [
    {
      "name": "payment-handle-http-error",
      "valueType": "boolean",
      "effect": "error",
      "allowedAccountTypes": [
        "partner",
        "cardholder"
      ],
      "description": "Causes an error when submitting on-chain transaction for approval based funding."
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}