Creates a student and assigns them a new virtual account.

  • Published on Feb 20, 2025
  • 12 minute(s) read
Prev Next
Post
/universities/{university_id}/students

Creates a student for a specific university and assigns them a new virtual account. To send this request, you must provide a university ID in the request path.

Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
universities.writeCreating university information
Header parameters
x-client-id
stringRequired

Client ID header

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Path parameters
university_id
stringRequired

University ID to be used in the query

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
Body parameters

Request body for creating a student

Simple student
{
  "externalId": "2507b89c-b680-46df-9505-e0b6f78cf295",
  "universityAccountId": "2507b89c-b680-46df-9505-e0b6f78cf333"
}
object

Data structure containing the request details for creating a student

type
string Deprecated

Deprecated. Now students can always access full functionality. We keep this field for legacy compatibility.

Valid values[ "SIMPLE", "EXTENDED" ]
Default"SIMPLE"
firstName
string | null

Student's first name.

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleGeorge
lastName
string | null

Student's last name.

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleWashington
email
string (email) | null

Student's email address.

Max length76
Pattern^\S+@\S+\.\S+$
Examplegwpresi@yahoo.com
externalId
string Required

Student's external ID used to identify the student in the university system

Max length36
Pattern^[a-zA-Z0-9-]*$
Example9c485e92-9c25-41e2-b6a5-a54381716670
idNumber
string | null

Student's national ID number.

The value is the national ID in the country of which the student is a citizen.

Max length50
Pattern^[XYZ]?\d{5,8}[A-Z]$
Example12345678A
birthDate
string (date) | null

Date when the student was born.

The value uses the complete data format defined in ISO 8601:

'YYYY-MM-DD'

Where:

  • YYYY: 4-digit year
  • MM: 2-digit month (for example, 01 = January)
  • DD: 2-digit day of the month (01 through 31).
Max length10
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example1970-01-01
residenceCountryId
string | null

Country code for the country where the student resides.

The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleES
nationalityCountryId
string | null

Country code for the country of which the student is a citizen.

The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleES
trainingType
string | null

Qualification level of the student's university course

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleMASTER
trainingArea
string | null

Area of study of the student's university course

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleENGINEERING
trainingTitle
string | null

Title of the student's university course

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleMECHANICAL ENGINEERING
universityAccountId
string Required

University account ID.

The university account ID represents an account created within the One Trade system that is associated with a university. A university can have multiple accounts within the One Trade system.

Max length36
Pattern^[a-zA-Z0-9-]*$
Example2507b89c-b680-46df-9505-e0b6f78cf333
Responses
201

Response, depending on the request type:

  • For a GET or PATCH request, '200 OK'
  • For a POST request, '201 Created'
StudentResponse
{
  "data": {
    "id": "9c485e92-9c25-41e2-b6a5-a54381716670",
    "universityId": "d317d060-0d41-43ec-ba43-e47e8a25aa5b",
    "externalId": "2507b89c-b680-46df-9505-e0b6f78cf295",
    "type": "EXTENDED",
    "iban": "GB92PAGO72899000000263",
    "firstName": "George",
    "lastName": "Washington",
    "email": "gwpresi@yahoo.com",
    "idNumber": "12345678A",
    "birthDate": "1970-01-01T00:00:00.000Z",
    "trainingType": "GRADE",
    "trainingArea": "ENGINEERING",
    "trainingTitle": "MECHANICAL ENGINEERING",
    "residenceCountry": {
      "code": "ES",
      "name": "Spain"
    },
    "nationalityCountry": {
      "code": "ES",
      "name": "Spain"
    },
    "universityAccountId": "2507b89c-b680-46df-9505-e0b6f78cf333",
    "fileInfoId": "2507b89c-b680-46df-9505-e0b6f78cf295",
    "createdAt": "2022-03-14T12:09:49.955Z",
    "updatedAt": "2022-03-14T12:09:49.955Z"
  }
}
Expand All
object

Response to a request to create, update, or retrieve the details of a student

data
object (Student)

Data structure containing student details

id
string

Unique student ID generated by One Trade

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
type
string Deprecated

Deprecated. Now students can always access full functionality. We keep this field for legacy compatibility.

Valid values[ "SIMPLE", "EXTENDED" ]
Default"SIMPLE"
universityId
string

University ID.

The value is the university ID used in the request path.

Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esESB76134758
firstName
string | null

Student's first name

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleGeorge
lastName
string | null

Student's last name

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleWashington
email
string (email) | null

Student's email address

Max length76
Pattern^\S+@\S+\.\S+$
Exampleemail@yopmail.com
externalId
string

Student's external ID used to identify the student in the university system

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
idNumber
string | null

Student's national ID number.

The value is the national ID in the country of which the student is a citizen.

Max length50
Pattern^[XYZ]?\d{5,8}[A-Z]$
Example12345678A
birthDate
string (date-time) | null

Date when the student was born.

The value uses the complete data format defined in ISO 8601:

'YYYY-MM-DDThh:mm:ss.sssTZD'

Where:

  • YYYY: 4-digit year
  • MM: 2-digit month (for example, 01 = January)
  • DD: 2-digit day of the month (01 through 31)
  • hh: 2-digit hour of the day (00 through 23)
  • mm: 2-digit minute of the hour (00 through 59)
  • ss.sss: 5-digit seconds and milliseconds, separated by a point
  • TZD: Time zone indicator
Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example1970-01-01T00:00:00Z
trainingType
string | null

Qualification level of the student's university course

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleMASTER
trainingArea
string | null

Area of study of the student's university course

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleENGINEERING
trainingTitle
string | null

Title of the student's university course

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleMECHANICAL ENGINEERING
iban
string

IBAN of the virtual account that has been automatically generated and assigned to the student.

The student makes payments for their course to the university into this account.

Max length50
Pattern^[0-9A-Z\s]*$
ExampleBR1800360305000010009795493C1
universityAccountId
string

University account ID.

The university account ID represents an account created within the One Trade system that is associated with a university. A university can have multiple accounts within the One Trade system.

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
createdAt
string (date-time)

Date and time when the entry was created

Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example2022-03-17T10:02:03.482Z
updatedAt
string (date-time)

Date and time when the entry was updated

Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example2022-03-17T10:02:03.482Z
residenceCountry
object

Data structure containing information about the country where the student resides

code
string | null

Country code.

The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleES
name
string | null

Country name In English.

Min length1
Max length50
Pattern^[A-zÀ-ú\- ]+(?:['_.\s][A-zÀ-ú]+)*$
ExampleSpain
nationalityCountry
object

Data structure containing information about the country of which the student is a citizen.

code
string | null

Country code.

The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleES
name
string | null

Student's nationality in English.

Min length1
Max length50
Pattern^[A-zÀ-ú\- ]+(?:['_.\s][A-zÀ-ú]+)*$
ExampleSpanish
fileInfoId
string | null

ID of the file containing the student's details. Applies only when the student was created using a batch process outside of this API.

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
400

Bad request

err400Example
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "level": "FATAL",
      "message": "Bad Request",
      "description": "Error validating schema"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
401

Unauthorized

err401Example
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "ERROR",
      "description": "Unauthorized description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
403

Forbidden

err403Example
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "level": "FATAL",
      "message": "Forbidden",
      "description": "Forbidden description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
404

Not found

err404Example
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "level": "FATAL",
      "message": "Not Found",
      "description": "Not Found description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
406

Not Acceptable

err406Example
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "FATAL",
      "message": "Not Acceptable",
      "description": "Not Acceptable description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
409

Conflict

err409Example
{
  "errors": [
    {
      "code": "CONFLICT",
      "level": "FATAL",
      "message": "Conflict",
      "description": "Conflict description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
413

Payload Too Large

err413Example
{
  "errors": [
    {
      "code": "PAYLOAD_TOO_LARGE",
      "level": "FATAL",
      "message": "Payload Too Large",
      "description": "Payload Too Large description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
414

URI Too Long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "FATAL",
      "message": "URI Too Long",
      "description": "URI Too Long description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
415

Unsupported Media Type

err415Example
{
  "errors": [
    {
      "code": "UNSUPPORTED_MEDIA_TYPE",
      "level": "FATAL",
      "message": "Unsupported Media Type",
      "description": "Unsupported Media Type description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
422

Unprocessable Entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESSABLE_ENTITY",
      "level": "FATAL",
      "message": "Unprocessable Entity",
      "description": "Unprocessable Entity description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
429

Too Many Requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "Too Many Requests description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
500

Internal server error

err500Example
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Internal server error",
      "description": "Internal server error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
503

Service unavailable

err503Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Service unavailable error description"
    }
  ]
}
healthFailedExample
{
  "errors": [
    {
      "code": "fail",
      "level": "ERROR",
      "message": "Health check failed",
      "description": "Health check failed"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Gateway timeout error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
default

Default error

errDefaultExample
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Error message",
      "description": "Error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length25
Pattern^[a-zA-Z_0-9 ]*$
ExampleXXX
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
level
string

Level of the reported issue. The possible values are.

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription