Interface ITransAct
HTTP POST https://student-account-api.rollout.co.za/api/v1/ITransAct
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 |
---|---|---|
RequestTransaction |
student_number language format service amount trans_type trans_desc_eng trans_desc_afr |
Attempt to execute a transaction on the given student number. |
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, 'action' should be used. |
trans_type | int |
The type of transaction being requested. Possible defined:
Stellenbosch364: GYMNASIUM CARD365: US GYM SESSIONS AND MEMBER 366: US GYM TIME Tygerberg864: GYMNASIUM CARD865: US GYM SESSIONS AND MEMBER 866: US GYM TIME |
trans_desc_afr | string | The Afrikaans description of the transaction being requested. |
trans_desc_eng | string | The English description of the transaction being requested. |
amount | int | The total amount of the transaction in South African cents. |