POST api/Vet/V1/Students/Validate
Validate if the provided student information is matching to any existing data or not by FORM POST.
The combination of 2 matching fields are required.
Request Information
URI Parameters
None.
Body Parameters
Valid student validation parameter. This is required.
ModelStudentValidationV1Name | Description | Type | Additional information |
---|---|---|---|
stdid |
Student Id |
string |
None. |
Primary contact email address |
string |
None. |
|
dob |
Date of birth (e.g. dd/mm/yyyy) |
string |
None. |
username |
Username that use to login to RTOManager system |
string |
None. |
Request Formats
application/json, text/json
{ "stdid": "sample string 1", "email": "sample string 2", "dob": "sample string 3", "username": "sample string 4" }
application/xml, text/xml
<ModelStudentValidationV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.SearchFilter.V1"> <dob>sample string 3</dob> <email>sample string 2</email> <stdid>sample string 1</stdid> <username>sample string 4</username> </ModelStudentValidationV1>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ValidationResponse object
ValidationResponseName | Description | Type | Additional information |
---|---|---|---|
IsValid |
True/False identification |
boolean |
None. |
Message |
Response text |
string |
None. |
ReferenceId |
If 'IsValid' id true, ReferenceId will be unique Id representing the person validated. Default is empty. |
string |
None. |
Response Formats
application/json, text/json
{ "IsValid": true, "Message": "sample string 2", "ReferenceId": "sample string 3" }
application/xml, text/xml
<ValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Code.Utility"> <IsValid>true</IsValid> <Message>sample string 2</Message> <ReferenceId>sample string 3</ReferenceId> </ValidationResponse>