POST api/V1/StudentOffers/USI
Validate provided student USI before submit the application.
Remarks: The integration service is configured with USI Service live environment (regardless of live or sandbox WEB API).
Request Information
URI Parameters
None.
Body Parameters
ObjVerifyUSIRequest
ObjVerifyUSIRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Unique reference id representing student to contact to USI Service and response back the result. |
string |
Required |
| firstname |
Student first/given name |
string |
Required |
| lastname |
Student last/family name |
string |
Required |
| dateofbirth |
Student date of birth |
date |
Required |
| usi |
Unique Student Identifier (USI) of the student to verify. |
string |
Required |
Request Formats
application/json, text/json
{
"id": "sample string 1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"dateofbirth": "2025-11-03T16:23:38.5097198+11:00",
"usi": "sample string 5"
}
application/xml, text/xml
<ObjVerifyUSIRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Classification"> <dateofbirth>2025-11-03T16:23:38.5097198+11:00</dateofbirth> <firstname>sample string 2</firstname> <id>sample string 1</id> <lastname>sample string 3</lastname> <usi>sample string 5</usi> </ObjVerifyUSIRequest>
Response Information
Resource Description
ObjUSIResponse
ObjUSIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicationId | string |
None. |
|
| Status | ResponseStatus |
None. |
|
| ServiceStage | Stage |
None. |
|
| Message | string |
None. |
|
| USI | string |
None. |
Response Formats
application/json, text/json
{
"ApplicationId": "sample string 1",
"Status": "UNKNOWN",
"ServiceStage": "Instantiated",
"Message": "sample string 2",
"USI": "sample string 3"
}
application/xml, text/xml
<ObjUSIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Classification"> <ApplicationId>sample string 1</ApplicationId> <Message>sample string 2</Message> <ServiceStage>Instantiated</ServiceStage> <Status>UNKNOWN</Status> <USI>sample string 3</USI> </ObjUSIResponse>