API Specification Documentation v4.3 July 2021 2
API Specification Documentation v4.3 July 2021 2
API Specification Documentation v4.3 July 2021 2
July 2021
P.o.Box 6562
Dar Es Salaam
Version 4.3
Table of Contents
Acronyms .................................................................................................................................................................................... ii
1. Introduction ................................................................................................................................................................ 1
2. System Requirements ............................................................................................................................................. 2
3. Web Services ............................................................................................................................................................... 2
3.1 Check Applicant Status.............................................................................................................................................. 5
3.2 Add Applicant ............................................................................................................................................................... 8
3.3 Submit Applicant Programme Choices ............................................................................................................. 11
3.4 Confirm Applicant Selection ................................................................................................................................. 15
3.5 Unconfirm Admission .............................................................................................................................................. 17
3.6 Resubmit Applicant Details ................................................................................................................................... 19
3.7 Populate Dashboard ................................................................................................................................................. 23
3.8 Get Admitted Applicants ........................................................................................................................................ 25
3.9 Get Programmes with Admitted Candidates ................................................................................................. 28
3.10 Get applicants’ Admission Status ..................................................................................................................... 29
3.11 Get a list of confirmed applicants..................................................................................................................... 32
3.12 Request confirmation code................................................................................................................................. 34
3.13 Cancel/Reject Admission..................................................................................................................................... 36
3.14 Submit Internal Transfers ................................................................................................................................... 38
3.15 Submit Inter Institutional Transfers............................................................................................................... 40
3.16 Get applicants’ Verification Status ................................................................................................................... 42
3.17 Submit enrolled/registered students............................................................................................................. 44
3.18 Submit graduates .................................................................................................................................................... 48
3.19 Submit Institution Staff ........................................................................................................ ................................53
3.20 Get verification status for internally transferred students ........................................................................ 57
3.21 Get verification status for inter-institutional transferred students ....................................................... 59
3.22 Restore cancelled admission .................................................................................................................................. 61
3.23 Submit students drop-outs ...................................................................................................................................... 63
3.24 Submit students who postponed studies .......................................................................................................... 67
3.25 Submit admitted students into non-degree programmes .......................................................................... 70
3.26 Get verification status for non-degree admitted students ......................................................................... 73
3.27 Submit applicants applied for Postgraduate programmes ........................................................................ 75
3.28 Submit admitted students into Postgraduate programmes ...................................................................... 79
Web Service Method............................................................................................................................................................. 79
3.29 Get verification status for admitted students into Postgraduate ......................................................... 83
programmes............................................................................................................................................................................. 83
3.30 Submit transferred students from one Postgraduate programme to another within the same
institution or from one institution to another ........................................................................................................... 85
3.31 Get verification status for transferred students into Postgraduate .................................................... 88
programmes............................................................................................................................................................................. 88
4. API Resources and End Points................................................................................................................................ 90
5. Message codes and their descriptions................................................................................................................. 92
6. Automated Processes ................................................................................................................................................. 94
7. APIs and/or Processes on HEIs Online Systems ............................................................................................. 95
8. Contact Details .............................................................................................................................................................. 97
i
Acronyms
ii
Application Programming Interface (API) Specification Documentation for
Integrated Admission System (IAS)
1. Introduction
a. Purpose
This document aims to specify end points implemented and thus enable admission
stakeholders to electronically exchange information with TCU required during the
admission process.
b. Scope
The scope of this document is to specify and illustrate the integration requirements in terms
of end points, data sets and connectivity requirements for technical experts. Services
available for external stakeholders of TCU’s Integrated Admission System are as follows:
o Check Applicant Status
o Add Applicant
o Submit Applicant Programme Choices
o Confirm Applicant Admission
o Unconfirm Applicant Admission
o Resubmit rectified applicants
o Populate Dashboard
o Get applicant Status
o Get programmes with Admitted candidates
o Get admitted/verified applicants
o Get a list of confirmed applicants (multiple selection Only)
o Send sms to Applicants
o Cancel/reject admission
o Request confirmation code
o Internal Transfers
o Inter-institutional transfers
o Get applicants with multiple/single admission status
o Submit enrolled/registered students
o Submit Graduates
o Submit Institution Staff
o Get verification status for internally transferred students
o Get verification status for inter-institutional transferred students
o Submit students drop-outs
o Submit students who postponed studies
o Submit admitted students into non-degree programmes (foundation, diploma,
certificates)
o Get verification status for non-degree admitted students
1
o Submit applicants applied for Postgraduate programmes
o Submit admitted students into Postgraduate programmes
o Get verification status for admitted students into Postgraduate programmes
o Submit transferred students from one Postgraduate programme to another within the
same institution or from one institution to another
o Get verification status for transferred students into Postgraduate programmes
c. Intended Audience
2. System Requirements
a. Development environment
API services shall use XML, SOAP, WSDL and UDDI open standards over an internet protocol
backbone. XML is used to tag the data, SOAP is used to transfer the data, WSDL is used to
describe the services available and UDDI is used for listing what services are available. The
environment will allow external stakeholders to obtain certified identity information
through a programmatic interface across networks. External stakeholder can then add the
services to a GUI (such as web page or an executable program) to offer specific functionality
based on agreed requirements.
Since services are communicated using XML, the integration is not tied to any one of the
operating systems or programming languages. For example, external stakeholder can
develop their application in .Net, php, java or Perl in windows or UNIX operating system.
NOTE: Owing to the need to pass a number of parameters for each API call, POST
method is used for all such calls.
The Web service shall be secured using username and Security Token in header as per WSS
standard. This user name and security token will be generated from TCU Application by the
system Administrator.
3. Web Services
The Following is the summary of the web service methods available for external stakeholders:
3
Download a list of selected and Undergraduate
9 Get admitted applicants confirmed applicants (per institution, admission
per course).
Get programmes with Download a list of programme codes for Undergraduate
10
Admitted candidates programmes with selected applicants. admission
Get a list of confirmed applicants who Undergraduate
Get a list of confirmed
11 had multiple admissions and their admission
applicants
confirmation status per programme.
An applicant that had multiple Undergraduate
admission can request confirmation admission
12 Request confirmation code code via the respective HLI online
system, and the same shall be passed on
to TCU.
An applicant that had admission can Undergraduate
cancel his admission via the respective admission
13 Cancel/ Reject Admission
HLI online system, and the same shall be
passed on to TCU.
An applicant that has been admitted but Undergraduate
14 Submit internal transfers wishes to transfer to another admission
programme within the same institution.
Get Applicant’s Get applicants’ Verification Status Undergraduate
15 Download a list of applicants with their admission
Verification Status
verification status
Submit inter institutional An applicant that has been admitted and Undergraduate
16 admission
transfers wishes to transfer to another institution.
Submit Both Undergraduate
A student registered/enrolled into a
17 enrolled/registered and Postgraduate
programme of study in an academic year
students
All who have graduated from a Both Undergraduate
18 Submit Graduates and Postgraduate
particular institution
Institution staff i.e. both academic and Used to submit the list
19 Submit Institution Staff of all employees
administrative staff
Get verification status for Download applicants who have Undergraduate
20 internally transferred requested for internal transfers and transfers
students their TCU verification status
Download applicants who have Undergraduate
Get verification status for
21 requested for inter-institutional transfers
inter-institutional
transfers and their TCU verification
transferred students
status
Restore cancelled Restore admission for applicants who Undergraduate
22 admission
admission previously cancelled their admissions
Both Undergraduate
23 Submit students drop-outs Add students who dropped their studies and Postgraduate
dropouts
Both Undergraduate
Submit students who Submit students who postponed studies
24 and Postgraduate
postponed studies in the current academic year
postponements
4
Used to submit to TCU
Submit admitted students the list of admitted
Add students admitted into non-degree
into non-degree students into non-
25 programmes (Certificates, Diplomas or
programmes (foundation, degree programmes
Foundation Programme)
diploma, certificates) by University
institutions
Check verification
status of admitted
Get verification status for Download admitted students into non-
students into non-
26 non-degree admitted degree programmes and their
degree programmes
students verification status
by University
institutions
Submit applicants applied Postgraduate
Submit to TCU the list of applicants
27 for Postgraduate admission
applied for Postgraduate degree
programmes
programmes in University Institutions
Submit admitted students Submit to TCU the list of admitted Postgraduate
28 into Postgraduate students into Postgraduate degree admission
programmes programmes in University Institutions
Download admitted students into Postgraduate
Get verification status for
Postgraduate programmes and their admission
29 admitted students into
verification statuses
Postgraduate programmes
Submit transferred Postgraduate
students from one Submit to TCU the list of admitted admission
30 Postgraduate programme students into Postgraduate programmes
to another within the same in University institutions
institution or from one
institution to another
Get verification status for Download transferred students into Postgraduate
31 transferred students into Postgraduate programmes and their admission
Postgraduate programmes verification status
Url: https://api.tcu.go.tz/applicants/checkStatus
Call method: POST
Note:
- Exclude current year form six and diploma graduates for first round of application. In
subsequent rounds check everybody.
- For applicants with multiple o-level sittings, check all index numbers
5
- Can be used for an individual or batch of applicants
6
(d) Response Payload
Example request
Example response
curl -i -X POST \
-H "Content-Type:application/xml" \
-d \
'<?xml version="1.0" encoding="UTF-8"?>
<Request>
<UsernameToken>
<Username>DM</Username >
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken >
<RequestParameters >
<f4indexno> S1001/0012/2018</f4indexno>
</RequestParameters>
</Request>' \
'https://api.tcu.go.tz/applicants/checkStatus'
Url: https://api.tcu.go.tz/applicants/add
Call method: POST
8
(a) Request Parameters
i. String
Form Four Index Number in given format.
For applicants with NECTA certificate the Format for Form Four
Index Number is “S1001/0012/2014”
ii. String
Form Six Index Number in given format.
For applicants with NECTA certificate the Format for Form Four
Index Number is “S1001/0512/2018”
iii. Character
Applicant Category.
‘A’ for A-level, ‘D’ for Diploma holders, 'F' for Foundation holders
and 'B' for bachelor degree holders
iv. String
Other form four index number(s)
v. String
Other form six index number(s)
9
(b) Request Payload
10
Example request
Example response
11
Url: https://api.tcu.go.tz/applicants/submitProgramme
Call method: POST
i. String
Form Four Index Number in given format.
For applicants with NECTA certificate the
Format for Form Four Index Number is
“S1001/0012/2014”
12
ii. String
Form Six Index Number in given format.
For applicants with NECTA certificate the
Format for Form Four Index Number is
“S1001/0512/2018”
iii. String
Selected programmes (separated by comma)
iv. Character
Applicant Category.
‘A’ for A-level and ‘D’ for Diploma holders
v. String
Mobile number
vi. String
Other Mobile number
vii. String
Email address
viii. String
Admission Status
ix. String
Programme admitted
x. String
Reason
xi. String
Nationality
xii. String
Impairment
xiii. String
Date of birth.
Date format YYYY-MM-DD
xiv. String
Other form four index number
xiii: String
Other form six index number
xiii: String
National Identification Number
13
(b) Request Payload
Example response
15
Url: https://api.tcu.go.tz/admission/confirm
Call method: POST
II. String
Confirmation Code
16
Body of the response contains the information regarding
applicant status, status code and status description objects
N.B. HEIs should ONLY consider the applicant as confirmed If and only if the appropriate
confirmation status from TCU is received. If not another HLI could claim the confirmation should
the applicant decide to change his/her mind and confirm elsewhere.
Example request
Example response
17
Url: https://api.tcu.go.tz/admission/unconfirm
Call method: POST
ii. String
Confirmation Code
18
Body Response Body Section
Contains elements
Body of the response contains the information regarding
Applicant Status and error code objects
(d) Response Payload
Example request
Example response
Url: https://api.tcu.go.tz/applicants/resubmit
Call method: POST
(a) Request Parameters
ii. String
Form Six Index Number in given format. For applicants with
NECTA certificate the format for Form Six Index Number is
“S1001/0012/2014”
iii. String
Programme choices
iv. String
20
Mobile number
v. String
Other Mobile number
vi. String
Email
vii. String
Admission status
viii. String
Programme admitted
ix. String
Reason
x. Character
Applicant category
xi. String
Other form four index number(s)
xii. String
Other form six index number(s)
xiii. String
Nationality
xiv. String
Date of birth
xv. String
Impairment
21
MobileNumber Varchar,15 Mandatory Applicant’s mobile number
OtherMobileNumber Varchar,15 Optional Other Applicant’s mobile number
EmailAddress Varchar,30 Mandatory Applicant’s email address
AdmissionStatus Varchar,10 Mandatory Admission status
ProgrammeAdmitted Varchar,10 Mandatory Programme the applicant is admitted to
Reason Varchar, 100 Mandatory Reason for not being admitted
Category char , 1 Mandatory Applicant category ‘A’ for Form Six and ‘D’ for
Diploma holders
Otherf4indexno Varchar, 100 Optional Comma separated other form four index numbers
Otherf6indexno Varchar, 100 Optional Comma separated other form six index numbers
Nationality Varchar, 50 Mandatory Applicant’s nationality
Impairment Varchar, 20 Mandatory Applicant’s disability
Date of Birth Varchar, 12 Mandatory Applicant’s date of birth
Example response
Populate Dashboard
Populate Dashboard Update latest application statistics to the TCU dashboard (update once a day) =>
programme code, number of males and number of females
Url: https://api.tcu.go.tz/dashboard/populate
Call method: POST
(a) Request Parameters
ii. Integer
Males: Number of male applicants
iii. Integer
Females: Number of female applicants
Example request
24
<?xml version=”1.0” encoding=”UTF-8”?>
<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>DM038</ProgrammeCode>
<Males>45</Males>
<Females>60</Females>
</RequestParameters>
</Request>
Example response
Url: https://api.tcu.go.tz/admission/getAdmitted
Call method: POST
25
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate request before
processing generate by TCU system.
Body i. Varchar : Programme Code
i. String
Programme Code
ii. Integer
Status Code
iii. String
Status Description
iv. String
Containing list of form four index numbers
(d) Response Payload
26
AdmissionStatus Varchar, 128 Applicant’s admission status
Example request
Example response
Url: https://api.tcu.go.tz/admission/getProgrammes
Call method: POST
Direction Input
Type getProgrammes
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to
authenticate request before processing
generate by TCU system.
28
(c) Response Payload
Example request
Example response
29
Web Service Method Description
Get applicants’ Admission Status
Get Applicant’s Admission
Download a list of applicants with their admission status i.e whether they
Status
have single or multiple admissions
Url: https://api.tcu.go.tz/applicants/getStatus
Call method: POST
Note: This is an alternative to broadcasting multiple/single admission status (PUSH from TCU’s
Side). Now HEIs can PULL the admission status
30
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Status, status code and status description objects
Example request
Example response
</Applicant>
<Applicant>
<f4indexno> S1001/0016/2016</f4indexno>
<AdmissionStatusCode>226</AdmissionStatusCode>
<AdmissionStatusDescription>The applicant has single
admission</AdmissionStatusDescription>
</Applicant>
</ResponseParameters>
</Response>
Url: https://api.tcu.go.tz/applicants/getConfirmed
Call method: POST
Note: This is similar to 3.11 only that it narrows down to applicants with multiple admissions only.
This is useful for feedback after some students have confirmed their admission to some HEIs
32
(b) Request Payload
Example request
Example response
33
<StatusDescription>Data successfully retrieved</StatusDescription>
<Applicant>
<f4indexno> S1001/0013/2016</f4indexno>
<f6indexno> S1001/0590/2018</f6indexno>
<DiplomaRegNo>AVN2018927682</DiplomaRegNo>
<ProgrammeCode> UD034</ProgrammeCode>
<ConfirmationStatusCode>234</ConfirmationStatusCode>
<AdmissionStatus> confirmed to other HLI </AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0042/2016</f4indexno>
<f6indexno> S1001/0545/2018</f6indexno>
<DiplomaRegNo>AVN20180982FE</DiplomaRegNo>
<ProgrammeCode> DD034</ProgrammeCode>
<ConfirmationStatusCode>233</ConfirmationStatusCode>
<AdmissionStatus>Confirmed </AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0016/2016</f4indexno>
<f6indexno> S1001/0516/2018</f6indexno>
<DiplomaRegNo>AVN20189282ME</DiplomaRegNo>
<ProgrammeCode> UD034</ProgrammeCode>
<ConfirmationStatusCode>234</ConfirmationStatusCode>
<AdmissionStatus>confirmed to other HLI</AdmissionStatus>
</Applicant>
</ResponseParameters>
</Response>
Url: https://api.tcu.go.tz/admission/requestConfirmationCode
Call method: POST
(a) Request Parameters
Example request
Example response
Url: https://api.tcu.go.tz/admission/reject
Call method: POST
Directio Input
n
Type requestConfirmationCode
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate request before
processing generate by TCU system.
Body i. String
Form four index number
Example request
Example response
Submit internal transfers An applicant that has been admitted but wishes to transfer to another
programme within the same institution.
Url: https://api.tcu.go.tz/admission/submitInternalTransfers
Call method: POST
Directio Input
n
Type submitInternalTransfers
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate request before
processing generate by TCU system.
Body i. String
Form four index number
ii. String
Form six index number
iii. String
Previous Programme Code
iv. String
Current Programme Code
38
PreviousProgrammeCode Varchar,5 Mandatory Previous programme code
Example request
Example response
Submit inter institutional An applicant that has been admitted and wishes to transfer to another
transfers institution.
Url: https://api.tcu.go.tz/admission/submitInterInstitutionalTransfers
Call method: POST
Example request
Example response
41
3.16 Get applicants’ Verification Status
Url: https://api.tcu.go.tz/applicants/getApplicantVerificationStatus
Call method: POST
Note: This is an alternative to broadcasting the admission verification status (PUSH from TCU’s
Side). Now HEIs can PULL the admission verification status
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitEnrolledStudents
Call method: POST
i. String
First name
ii. String
Middle name
iii. String
Surname
iv. Character
Gender
v. String
Nationality
vi. Year
Date of birth e.g. 1981
vii. String
Programme category e.g. “Bachelor Degree”
viii. String
Field of specialization e.g. “Architecture”
ix. String
Year of study e. g. “First Year”
x. String
Study mode e.g. “Full Time”
45
xi. String
Status of whether repeating a year or not e.g.
for student repeating the year, the status is
“YES”
xii. String
Entry mode (qualification)
xiii. String
Sponsorship information
xiv. String
Physical challenges/impairment,
xv. String
Form Four Index Number in given format.
For applicants with NECTA certificate the
format for Form Four Index Number is
“S1001/0012/2014”
xvi. String
Programme name
xvii. String
Registration number issued by the institution to
a student during registration
xviii. String
Programme code
xix. Year
Year of admission e.g. 2017
46
DateOfBirth Year,4 Mandatory Student’s year of birth
ProgrammeCategory Varchar,50 Mandatory Category of the programme the student is
undertaking e.g. “Bachelor Degree”
Specialization Varchar,50 Mandatory Field of specialization
AdmissionYear Year,4 Mandatory Year the student was admitted into the programme
e.g. 2018
ProgrammeCode Varchar, 10 Mandatory Programme Code
RegistrationNumber Varchar, 50 Mandatory Student’s registration number
ProgrammeName Varchar, 200 Mandatory Programme name
YearOfStudy Varchar, 15 Mandatory Student’s year of study
StudyMode Varchar, 15 Mandatory Mode of study
IsYearRepeat Varchar, 3 Mandatory Status whether the student is repeating a year or
not. The values should be either “YES” or “No”
EntryMode Varchar, 10 Mandatory Student’s mode of entry e.g. “Form Six” or
“Diploma”
Sponsorship Varchar, 150 Mandatory Student’s Sponsorship information e.g. “HESLB” for
those receiving loans from HESLB
PhysicalChallenges Varchar, 150 Mandatory Physical challenges or impairments if any.
47
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>xxxxxx</Fname>
<Mname></Mname>
<Surname>zzzzzzz</Surname>
<F4indexno>TZ76666668</F4indexno>
<Gender>M</Gender>
<Nationality>Tanzanian</Nationality>
<DateOfBirth>1982</DateOfBirth>
<ProgrammeCategory>Diploma</ProgrammeCategory>
<Specialization>Health Sciences</Specialization>
<AdmissionYear>2018</AdmissionYear>
<ProgrammeCode>CW001</ProgrammeCode>
<RegistrationNumber>TZ017/9999/2018</RegistrationNumber>
<ProgrammeName>Bsc in applied Chemistry</ProgrammeName>
<YearOfStudy>Second Year</YearOfStudy >
<StudyMode>Full Time</StudyMode >
<IsYearRepeat>NO</IsYearRepeat >
<EntryMode>Diploma</EntryMode >
<Sponsorship>ZHELB</Sponsorship >
<PhysicalChallenges>None</PhysicalChallenges>
</RequestParameters>
</Request>
Example response
48
(a) Request Parameters
i. String
First name
ii. String
Middle name
iii. String
49
Surname
iv. Character
Gender
v. String
Field of specialization e.g. “Architecture”
vi. String
Category of award
vii. String
Award class
viii. String
Award name
ix. String
Grade Points Average (GPA)
x. String
Graduation year
xi. String
Registration year
xii. String
Form Four Index Number in given format.
For applicants with NECTA certificate the
format for Form Four Index Number is
“S1001/0012/1980”
xiii. String
Programme code
xiv. String
Registration number issued by the institution to
a student during registration
xv. String
National Identification Number
50
(b) Request Payload
51
(d) Response Payload
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitInstitutionStaff
Call method: POST
i. String
First name
ii. String
Middle name
iii. String
Surname
iv. Character
Gender
v. String
Staff specialization e.g. “Architecture”
vi. String
Tittle
vii. String
Email
viii. String
Highest qualification
ix. String
Employment status
x. String
Source institution
xi. String
Year of birth
xii. String
Nationality
xiii. String
Physical challenges
xiv. String
54
Staff rank
xv. String
Staff role
xvi. String
Level of teaching
xvii. String
Staff Identification Number
xviii. String
National Identification Number
55
Email Varchar, Mandatory Staff email address
255
LevelOfTeaching Varchar, Mandatory The highest level the staff is allowed to teach based
255 on his qualifications e.g. Tutorial Assistants are
allowed to teach Diploma and Certificate students
StaffId Varchar, Mandatory Staff Identification Number
255
NationalIdNumber Varchar, 30 Optional National Identification Number (NIN) issued by
NIDA
Example request
Example response
Url: https://api.tcu.go.tz/applicants/getInternalTransferStatus
Call method: POST
Note: This is an alternative to broadcasting the internal transfer verification status (PUSH from
TCU’s Side). Now HEIs can PULL the internal transfer verification status
Example request
58
<ProgrammeCode>MN062</ProgrammeCode>
</RequestParameters>
</Request>
Example response
Url: https://api.tcu.go.tz/applicants/getInterInstitutionalTransferStatus
Call method: POST
Note: This is an alternative to broadcasting the inter-institutional transfer verification status (PUSH
from TCU’s Side). Now HEIs can PULL the inter-institutional transfer verification status
59
Name i. Programme code
Direction Input
Type getInterInstitutionalTransferStatus
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate
request before processing generate by TCU
system.
Body i. String
Programme code
Example request
Example response
Url: https://api.tcu.go.tz/admission/restoreCancelledAdmission
Call method: POST
II. String
Programme Code
62
Attribute, Type & Length Field Format Description
f4indexno Varchar, 15 Form four index number
StatusCode Varchar, 50 Service response status code
StatusDescription Varchar, 128 Description of service response status code
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitStudentsDropOuts
Call method: POST
i. String
First name
ii. String
Middle name
iii. String
Surname
iv. Character
Gender
v. String
Year terminated
vi. String
Termination reason
vii. String
Programme category
64
viii. String
Programme name
ix. String
Programme code
x. String
Form four index number
xi. String
Registration number
xii. String
Year of study
65
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Student
form four index number, status code and status description objects
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitPostponedStudents
Call method: POST
67
code.
i. String
First name
ii. String
Middle name
iii. String
Surname
iv. Character
Gender
v. String
Postponement reason
vi. String
Postponement year
vii. String
Programme name
viii. String
Programme code
ix. String
Form four index number
x. String
Registration number
xi. String
Year of study
68
F4indexno Varchar, 20 Mandatory The form four index number
Gender Varchar,2 Mandatory Student sex
RegistrationNumber Varchar, Mandatory Student registration number
255
YearOfStudy Varchar, 15 Mandatory Year of study e.g. “First Year”
PostponmentYear Varchar, Mandatory Postponement year e.g. 2018
255
PostponmentReason Varchar, Mandatory The reasons for postponing studies
255
ProgrammeName Varchar, Mandatory The programme name
255
ProgrammeCode Varchar, 10 Mandatory The programme name as appearing on the
Undergraduate Admissions Guidebook
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitAdmittedNonDegree
Call method: POST
70
ix. Programme Name
x. Applicant Category
Direction Input
Type submitAdmittedNonDegree
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate
request before processing generate by TCU
System.
Body Request Body Section
Contains Elements
Body contains form four index number, form six index
number, certificate registration number/AVN, date of birth,
impairment, gender, applicant category, nationality,
programme name and programme code.
i. String
Form four index number
ii. String
Form six index number String
iii. Character
Gender
iv. String
Certificate registration number
v. String
Applicant category
vi. String
Programme code
vii. String
Programme name
viii. String
Date of birth
ix. String
Impairment
x. String
71
Nationality
72
Attribute, Type & Length Field Format Description
F4indexno Varchar, 20 Form four index number
StatusCode Varchar, 50 Service Status Code
StatusDescription Varchar, 128 Description of Status Code
Example request
Example response
Note: This is an alternative to broadcasting the admission verification status (PUSH from TCU’s
Side). Now HEIs can PULL the admission verification status for non-degree admitted students
74
f4indexno Varchar,15 Form four index number
AdmissionStatus Varchar , 100 Applicant’s admission verification status
VerificationStatusCode Varchar, 6 Applicant’s admission verification status Code
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitPostgraduateApplicants
Call method: POST
i. String
Form four index number
ii. String
First name
iii. String
Middle name
iv. String
Surname
v. String
Gender
76
vi. String
Mobile number
vii. String
Programme Category
viii. String
Bachelor registration number
ix. String
Masters registration number
x. String
National Identification Number (NIN)
xi. String
Selected Programmes
xii. String
Mode of entry
xiii. String
Email address
xiv. String
Date of birth
xv. String
Impairment
xvi. String
Nationality
77
admitted to e.g. “Masters Degree”, “Doctorate
Degree”
BachelorRegNumb Varchar,100 Mandatory Bachelor registration number
MastersRegNumb Varchar,100 Optional Masters registration number
NationalIdNumber Varchar,255 Optional Applicant National Identification Number (NIN)
SelectedProgrammes Varchar, 255 Mandatory List of programmes (programme codes) an
applicant has applied for. The codes should be as
it appears on Postgraduate Admissions
Guidebook
EntryMode Varchar,255 Mandatory Mode of entry
Example request
Example response
Url: https://api.tcu.go.tz/applicants/submitAdmittedPostgraduate
Call method: POST
79
viii. Date of birth
ix. Programme Category
x. Mobile number
xi. Email address
xii. Bachelor registration number
xiii. Masters registration number
xiv. National Identification Number (NIN)
xv. Admitted programme
xvi. Mode of entry
xvii. Admission status (for not admitted applicants give reason(s))
Direction Input
Type submitAdmittedPostgraduate
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate
request before processing generate by TCU
System.
Body Request Body Section
Contains Elements
Body contains First name, Middle name, Surname, Form
Four index number, Gender, Nationality, impairment, Date
of birth, Programme Category, Mobile number, Email
address, Bachelor registration number, Masters
registration number, National Identification Number (NIN),
Admitted Programme, Admission Status and Mode of entry.
i. String
Form four index number
ii. String
First name
iii. String
Middle name
iv. String
Surname
v. String
Gender
vi. String
Mobile number
80
vii. String
Programme Category
viii. String
Bachelor registration number
ix. String
Masters registration number
x. String
National Identification Number (NIN)
xi. String
Admitted Programme
xii. String
Mode of entry
xiii. String
Email address
xiv. String
Date of birth
xv. String
Impairment
xvi. String
Nationality
xvii. String
Admission status
Example request
Example response
Url: https://api.tcu.go.tz/applicants/getPostgraduateAdmittedStatus
Call method: POST
Note: This is an alternative to broadcasting the admission verification status (PUSH from TCU’s
Side). Now HEIs can PULL the admission verification status for admitted students into Postgraduate
programmes
83
Direction Input
Type getPostgraduateAdmittedStatus
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate
request before processing generate by TCU
system.
Body i. String
Programme code
Example request
84
<Username>MNX</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>MNXM01</ProgrammeCode>
</RequestParameters>
</Request>
Example response
Url: https://api.tcu.go.tz/applicants/submitPostgraduateTransfers
Call method: POST
85
vi. Nationality
vii. Date of birth
viii. Programme Category
ix. Previous programme code
x. Current programme code
Direction Input
Type submitPostgraduateTransfers
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionToken String System generated Token used to authenticate
request before processing generate by TCU
System.
Body Request Body Section
Contains Elements
Body contains First name, Middle name, Surname, Form
Four index number, Gender, Nationality, Date of birth,
Programme Category, Current programme code and
previous programme code.
i. String
Form four index number
ii. String
First name
iii. String
Middle name
iv. String
Surname
v. String
Gender
vi. String
Programme Category
vii. String
Current Programme code
viii. String
Previous Programme code
ix. String
86
Date of birth
x. String
Nationality
87
Attribute, Type & Length Field Format Description
F4indexno Varchar, 20 Form four index number
StatusCode Varchar, 50 Service Status Code
StatusDescription Varchar, 128 Description of Status Code
Example request
Example response
88
Web Service Method Description
Get verification status for
Download transferred students into Postgraduate programmes and their
transferred students into
verification status
Postgraduate programmes
Url: https://api.tcu.go.tz/applicants/getPostgraduateTransferStatus
Call method: POST
Note: This is an alternative to broadcasting the admission verification status (PUSH from TCU’s
Side). Now HEIs can PULL the admission verification status for transferred students into
Postgraduate programmes
Example request
Example response
90
Check admission Status https://api.tcu.go.tz/applicants/checkStat
checkStatus of one or more us
Applicants during
application phase
Get the multiple/single https://api.tcu.go.tz/applicants/getStatus
admission status of a list
getStatus of applicants per
programme after
selection
Get a list of confirmed https://api.tcu.go.tz/applicants/getConfir
getConfirmed applicants per med
programme
Submit https://api.tcu.go.tz/applicants/submitEn
submitEnrolledStu rolledStudents
enrolled/registered
dents
students
https://api.tcu.go.tz/applicants/submitGr
submitGraduates Submit graduates
aduates
submitInstitutionS https://api.tcu.go.tz/applicants/submitIns
Submit Institution Staff titutionStaff
taff
getInternalTransfe Get verification status for https://api.tcu.go.tz/applicants/getIntern
rStatus internally transferred alTransferStatus
students
Get verification status for https://api.tcu.go.tz/applicants/getInterIn
getInterInstitution
inter-institutional stitutionalTransferStatus
alTransferStatus
transferred students
restoreCancelledA Restore cancelled https://api.tcu.go.tz/admission/restoreCa
dmission admission ncelledAdmission
submitStudentsDr Submit students drop- https://api.tcu.go.tz/applicants/submitStu
opOuts outs dentsDropOuts
submitPostponedS Submit students who https://api.tcu.go.tz/applicants/submitPo
tudents postponed studies stponedStudents
Submit admitted https://api.tcu.go.tz/applicants/submitAd
submitAdmittedNo
students into non-degree mittedNonDegree
nDegree
programmes
Get verification status for https://api.tcu.go.tz/applicants/getNonDe
getNonDegreeAdm
non-degree admitted greeAdmittedStatus
ittedStatus
students
https://api.tcu.go.tz/applicants/submitPo
Submit applicants
submitPostgraduat stgraduateApplicants
applied for Postgraduate
eApplicants
programmes
91
Submit admitted https://api.tcu.go.tz/applicants/submitAd
submitAdmittedPo students into mittedPostgraduate
stgraduate Postgraduate
programmes
Get verification status for https://api.tcu.go.tz/applicants/getPostgr
getPostgraduateAd admitted students into aduateAdmittedStatus
mittedStatus Postgraduate
programmes
Submit transferred https://api.tcu.go.tz/applicants/submitPo
students from one stgraduateTransfers
Postgraduate
submitPostgraduat
programme to another
eTransfers
within the same
institution or from one
institution to another
Get verification https://api.tcu.go.tz/applicants/getPostgr
Download transferred
status for aduateTransferStatus
students into
transferred
Postgraduate
students into
programmes and their
Postgraduate
verification status
programmes
Confirm Applicant https://api.tcu.go.tz/admission/confirm
confirm
Selections
Unconfirm previous https://api.tcu.go.tz/admission/unconfirm
unconfirm
selection
Get programmes with https://api.tcu.go.tz/admission/getProgra
getProgrammes
Admitted candidates mmes
Get admitted applicants https://api.tcu.go.tz/admission/getAdmitt
getAdmitted
per programme ed
Admission
reject Cancel/Reject admission https://api.tcu.go.tz/dashboard/reject
92
203 ALREADY ADMITTED Applicant is already admitted in current admission
cycle.
204 SESSION TOKEN DOES NOT EXISTS The given session token does not exist in system,
please contact system administrator.
205 MALFORMED XML REQUEST Invalid xml request.
206 EMPTY FORM FOUR INDEX NUMBER Form four index number cannot be null.
207 OPERATION FAIL Data was not successfully submitted to TCU.
208 DUPLICATE RECORD The applicant has already been submitted previously.
209 RE-SUBMITTED SUCCESSFUL The applicant has already been re-submitted
previously.
210 NOT FOUND No record found
211 MANDATORY PARAMETERS Empty mandatory parameters
212 CONFIRMED SUCCESSFUL Applicant successfully confirmed
213 CONFIRM TO OTHER HLI Applicant has already confirmed to other institution
214 CONFIRM TO YOUR HLI Applicant has already confirmed to this institution
215 NO MULTIPLE ADMISSION The applicant has no multiple admission
216 PROGRAMME CAPACITY IS FULL The programme capacity is full. No more
confirmations are allowed
217 INVALID CONFIRMATION CODE Invalid confirmation code
218 U-CONFIRMED SUCCESSFULLY Un-confirmed successfully
219 OPERATION FAILED Failed to un-confirm the admission
220 NOT CONFIRMED The applicant has not confirmed admission to any
institution
221 FAILED TO UN-CONFIRM Unable to un-confirm since the applicant has not
confirmed to this institution
222 CONFIRMATION CODE SENT TO EMAIL Confirmation code has been sent to your email
address.
223 CONFIRMATION CODE SENT TO EMAIL Confirmation code has been sent to your email
AND SMS address and mobile number.
224 NO ADMISSION FOUND You have no admission to this institution
225 MULTIPLE ADMISSION The applicant has multiple admissions
226 SINGLE ADMISSION The applicant has single admission
227 OPERATION NOT ALLOWED Operation not allowed at the moment
228 NOT CANCELLED ADMISSION HERE Applicant have not cancelled admission in this
programme
229 NOT CANCELLED ADMISSION Applicant have not cancelled admission in any
ANYWHERE institution
230 ADMISSION RESTORED Applicant admission restored successfully
231 APPLICANT CLEARED Applicant cleared by the Commission
6. Automated Processes
a. Send sms/email to Applicants
● For each applicant with multiple admissions send a sms and/or email with a
unique code that will be used for confirming the selection with one of the
HEIs.
● The applicant will use the received code to initiate the confirmation via the
HEIs online system. The Online system will make a call to Confirm Selection
API defined under 3.4 above
● The confirmation code should also be sent via email to each applicant with
multiple admissions
For each applicant TCU shall notify the HEIs (PUSH) the final admission status. The
following are possible statuses that can be communicated:
o clear admission
o multiple admission
o unqualified
o name mismatch
o prior admission
● HEIs will populate in their systems and allow students to get the necessary
feedback;
● TCU should also provide an alternative for HEIs to download their own lists
of applicants with their admission status for further processing;
● Alternatively, HEIs can PULL the lists via an API defined above under 3.10.
94
7. APIs and/or Processes on HEIs Online Systems
7.1 Check Status
Check the status of an applicant (eligibility for application)
96
7.29 Get verification status for admitted students into Postgraduate programmes
Download admitted students into Postgraduate programmes and their
verification statuses
7.31 Get verification status for transferred students into Postgraduate programmes
Download transferred students into Postgraduate programmes and their
verification status
8. Contact Details
In case of any enquiries, please contact TCU Technical Team through the email [email protected]
or [email protected] and phone number +255 (0) 22 2113691
97