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

Name	Description	Type	Additional information
id	Unique reference id representing student to contact to USI Service and response back the result. It can be any Id you specify to start the request. Use	string	Required
firstname	Student first/given name If single name, specify in this field and put 'LastName' field as dot (.).	string	Required
lastname	Student last/family name If single name, specify in 'firstname field and put this field as dot (.).	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

Sample:

{
  "id": "sample string 1",
  "firstname": "sample string 2",
  "lastname": "sample string 3",
  "dateofbirth": "2024-05-01T08:51:59.1098619+10:00",
  "usi": "sample string 5"
}

application/xml, text/xml

Sample:

<ObjVerifyUSIRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Classification">
  <dateofbirth>2024-05-01T08:51:59.1098619+10: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

Name	Type	Additional information
ApplicationId	string	None.
Status	ResponseStatus	None.
ServiceStage	Stage	None.
Message	string	None.
USI	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ApplicationId": "sample string 1",
  "Status": "UNKNOWN",
  "ServiceStage": "Instantiated",
  "Message": "sample string 2",
  "USI": "sample string 3"
}

application/xml, text/xml

Sample:

<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>