Retrieves a list of students for a specific university.
To send this request, you must provide a university ID in the request path.
The students included in the response can be filtered by university account ID and by full or partial student ID.
You can also sort the students in descending or ascending order by their creation date.
OAuth Grant type, Private JWT
Client ID header
University ID to be used in the query
Maximum number of rows to be included on each page in the response.
Fewer rows can be returned, if the query does not yield that many.
Pagination identifier that is returned to the app by the API response when this uses the HATEOAS '_prev' or '_next' links.
The app can navigate from the last returned page to the next or previous page, or to the first page if no offset is specified, but to no other pages.
Sorting order for the retrieved students.
The possible values are:
- +created_at = Ascending order by creation date
- -created_at = Descending order by creation date
The default value is '-created_at'.
University account ID for the students to be included in the response.
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.
Full or partial student ID of the students to be returned in the response, in the format defined in the 'student_id_type' parameter
Format used for the student ID in the 'student_id' parameter.
The possible values are:
- uuid = Internal UUID
- external = External ID
The default value is 'uuid'.
Whether the students returned in the response need to be a full or partial match to the student ID provided in the 'student_id' parameter.
The possible values are:
- like = Student ID can be a case sensitive partial match
- ilike = Student ID can be a case insensitive partial match
- equal = Student ID must be an exact match
Response to a request to retrieve a list of students, 200 OK
{
"data": [
{
"id": "9c485e92-9c25-41e2-b6a5-a54381716670",
"type": "EXTENDED",
"universityId": "d317d060-0d41-43ec-ba43-e47e8a25aa5b",
"iban": "GB92PAGO72899000000263",
"firstName": "George",
"lastName": "Washington",
"email": "gwpresi@yahoo.com",
"externalId": "2507b89c-b680-46df-9505-e0b6f78cf295",
"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"
},
"fileInfoId": "2507b89c-b680-46df-9505-e0b6f78cf295",
"universityAccountId": "2507b89c-b680-46df-9505-e0b6f78cf333",
"createdAt": "2022-03-14T12:09:49.955Z",
"updatedAt": "2022-03-14T12:09:49.955Z"
}
],
"_count": "1",
"_links": {
"_first": "/universities/univeristyId/students?_offset=0&_limit=1",
"_last": "/universities/univeristyId/students?_offset=40&_limit=1",
"_prev": "/universities/univeristyId/students?_offset=10&_limit=1",
"_next": "/universities/univeristyId/students?_offset=30&_limit=1"
}
}Data structure containing student details
Array of students
Data structure containing student details
Unique student ID generated by One Trade
Deprecated. Now students can always access full functionality. We keep this field for legacy compatibility.
University ID.
The value is the university ID used in the request path.
Student's first name
Student's last name
Student's email address
Student's external ID used to identify the student in the university system
Student's national ID number.
The value is the national ID in the country of which the student is a citizen.
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
Qualification level of the student's university course
Area of study of the student's university course
Title of the student's university course
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.
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.
Date and time when the entry was created
Date and time when the entry was updated
Data structure containing information about the country where the student resides
Country code.
The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).
Country name In English.
Data structure containing information about the country of which the student is a citizen.
Country code.
The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).
Student's nationality in English.
ID of the file containing the student's details. Applies only when the student was created using a batch process outside of this API.
Number of records in the list
Data structure containing the links for moving between the list pages
Link to the first page of the list.
The exact value depends on the data to be accessed.
The exact content of the page depends on the input parameters provided in the request, such as the offset.
Link to the last page of the list.
The exact value depends on the data to be accessed.
The exact content of the page depends on the input parameters provided in the request, such as the offset.
Link to the previous page of the list.
The exact value depends on the data to be accessed.
The exact content of the page depends on the input parameters provided in the request, such as the offset.
Link to the next page of the list.
The exact value depends on the data to be accessed.
The exact content of the page depends on the input parameters provided in the request, such as the offset.
No content
Bad request
{
"errors": [
{
"code": "BAD_REQUEST",
"level": "FATAL",
"message": "Bad Request",
"description": "Error validating schema"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"message": "Unauthorized",
"level": "ERROR",
"description": "Unauthorized description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Forbidden
{
"errors": [
{
"code": "FORBIDDEN",
"level": "FATAL",
"message": "Forbidden",
"description": "Forbidden description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Not found
{
"errors": [
{
"code": "NOT_FOUND",
"level": "FATAL",
"message": "Not Found",
"description": "Not Found description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Not Acceptable
{
"errors": [
{
"code": "NOT_ACCEPTABLE",
"level": "FATAL",
"message": "Not Acceptable",
"description": "Not Acceptable description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Payload Too Large
{
"errors": [
{
"code": "PAYLOAD_TOO_LARGE",
"level": "FATAL",
"message": "Payload Too Large",
"description": "Payload Too Large description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
URI Too Long
{
"errors": [
{
"code": "URI_TOO_LONG",
"level": "FATAL",
"message": "URI Too Long",
"description": "URI Too Long description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Unprocessable Entity
{
"errors": [
{
"code": "UNPROCESSABLE_ENTITY",
"level": "FATAL",
"message": "Unprocessable Entity",
"description": "Unprocessable Entity description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Too Many Requests
{
"errors": [
{
"code": "TOO_MANY_REQUESTS",
"level": "ERROR",
"message": "Too Many Requests",
"description": "Too Many Requests description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Internal server error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"level": "FATAL",
"message": "Internal server error",
"description": "Internal server error description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Service unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"level": "ERROR",
"message": "Service unavailable",
"description": "Service unavailable error description"
}
]
}{
"errors": [
{
"code": "fail",
"level": "ERROR",
"message": "Health check failed",
"description": "Health check failed"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Gateway timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"level": "ERROR",
"message": "Gateway timeout",
"description": "Gateway timeout error description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Default error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"level": "FATAL",
"message": "Error message",
"description": "Error description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue