Interface IValidate
HTTP POST https://student-account-api.rollout.co.za/api/v1/IValidate
The validate interface provides for basic look ups on a student number. All methods on the interface accept both HTTP GET and HTTP POST methods however GET is deprecated.
Method Definitions
| Name | Required Fields | Description |
|---|---|---|
| ValidStudent |
student_number language format service |
Check whether or not the given student number is valid. |
| CanTransact |
student_number language format service |
Check whether or not the student can transact. |
Field Definitions
| Name | Type | Description |
|---|---|---|
| student_number | int | A valid student number. |
| language | string | Language string in which the Student API should return error messages. Possible values are 'english' or 'afrikaans'. |
| format | string | The format in which the wrapper should respond. Possible values are 'XML', 'JSON', 'CSV', 'YAML' or 'ARRAY' |
| service | string | The service type being executed. Possible global values are 'action', 'lookup' or 'find'. For this instantiation, 'lookup' should be used. |