API Specification Documentation v4.3 July 2021 2

Download as pdf or txt
Download as pdf or txt
You are on page 1of 100

TANZANIA COMMISSION FOR UNIVERSITIES

API Specification Documentation for Integrated Admission System


(Higher Learning Institutions)

July 2021

Tanzania Commission for Universities

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

API Application Programming Interfaces

AVN Award Verification Number

GPA Grade Points Average

GUI Graphical User Interface

HEIs Higher Education Institutions

IAS Integrated Admission System

NACTE National Accreditation Council for Technical Education

NECTA National Examination Council of Tanzania

NIDA National Identification Authority

NIN National Identification Number

SOAP Simple Object Access Protocol

TCU Tanzania Commission for Universities

UDDI Universal Description Discovery and Integration

UIMS Universities Information Management System

WSDL Web Services Description Language

XML eXtensible Markup Language

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.

Details of technical requirements in establishing the system integration are illustrated in


this document. External stakeholders should be able to proceed with their integration
development and later carry on the necessary testing based on this document.

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

This document is intended for the following audience


o Technical Manager
o Software Engineer / Developers

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.

b. Credential & Notification Web Service Security

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:

No Web Service Method Description Usage


Check the applicant status in TCU Undergraduate
1. Check Applicant Status database to determine whether the admission
applicant is a prior admitted student,
2
discontinued, graduated or already
admitted applicant (subsequent rounds
after first round)
** exclude current year form six and
diploma graduates for first round of
application. However, subsequent
rounds should use the end point to
exclude applicants already admitted.
Add a new applicant by inserting Undergraduate
institution id, form 4 index number, admission
form 6 index number (or AVN for
Add Applicant diploma holders) and category, other
2.
form four index number(s) and other
form six index number(s). This endpoint
is for applicants applying for bachelor
degree programmes
After selection for admission has been Undergraduate
done, submit the list of applicants with admission
their choices and other contact details to
TCU (TCU’s template)
Submit Applicant Institution Code, form four index
3 Programme Choices number, form six index number,
programme choices, mobile number,
email, admission status, programme of
admission, reason, applicant category,
other form four index number(s) and
other form six index number(s).
Each applicant with multiple selections Undergraduate
Confirm Applicant
shall use a TCU provided token/code to admission
4 Admission
confirm selection to ONLY one HLI, and
the same shall be confirmed with TCU.
An applicant that had confirmed can Undergraduate
Unconfirm Applicant
reject the admission via the respective admission
5 Admission
HLI online system, and the same shall be
passed on to TCU.
Update TCU on applicant details that Undergraduate
Resubmit rectified
6 might be different from the initial admission
applicants
submission.
Update latest application statistics to the Undergraduate
Populate Dashboard TCU dashboard (update once a day) i.e. admission
7
programme code, number of males and
number of females.
Download a list of applicants with their Undergraduate
8 Get applicant status
admission status. admission

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

3.1 Check Applicant Status

Web Service Method Description


Check the applicant status in TCU database to determine whether the
Check status applicant is a prior admitted student, discontinued, graduated or holder
of current admission (during subsequent rounds).

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

(a) Request Parameters

Name Form Four Index number


Direction Input
Type checkStatus
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 generated by TCU
system.
Body String
Form Four Index Number in given format.
For applicants with NECTA certificate the format for Form
Four Index Number is “S1001/0012/2014”

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
f4indexno Varchar, 15 Mandatory Form Four Index Number in specific format
Form Four Index Number format
“S1001/0012/2014”

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding applicant’s
admission status i.e. status code and status description.

6
(d) Response Payload

Attribute, Type & Length Field Format Description


f4inde Varchar, 15 Form Four Index Number
xno
StatusCode Varchar, 50 Service Response Code
StatusDescription Varchar, 128 Description of Service Response

Example request

For single index number

<?xml version="1.0" encoding="UTF-8"?>


<Request>
<UsernameToken>
<Username>DM</Username>
< SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno> S1001/0012/2018</f4indexno>
</RequestParameters>
</Request>

For Multiple index numbers

<?xml version="1.0" encoding="UTF-8"?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<f4indexno> S1001/0015/2016</f4indexno>
</RequestParameters>
</Request>

Example response

For single index number

<?xml version="1.0" encoding="UTF-8"?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>202</StatusCode>
<StatusDescription> Applicant has no prior admission</StatusDescription>
</ResponseParameters>
</Response>
7
For Multiple index numbers

<?xml version="1.0" encoding="UTF-8"?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>No Prior Admission</StatusDescription>
</ResponseParameters>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>202</StatusCode>
<StatusDescription>Applicant has no prior admission</StatusDescription>
</ResponseParameters>
</Response>

Example Curl call:

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'

3.2 Add Applicant

Web Service Method Description


Add a new applicant by inserting institution code, form four index
Add Applicant number, form six index number (or AVN for diploma holders) , applicant
category, other form four index number(s) and other form six index
number(s).

Url: https://api.tcu.go.tz/applicants/add
Call method: POST

8
(a) Request Parameters

Name i. Institution Code


ii. Form Four Index number
iii. Form Six Index Number (or AVN for diploma holders)
iv. Applicant Category (Diploma or Form 6)
v. Other f4 index numbers (separated by comma)
vi. Other f6 index numbers (separated by comma)
Direction Input
Type Add
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 application with Session token
SessionToken String System generated Token used to authenticate request before
processing generate by TCU System.
Body Request Body Section
Contains Elements
Body contains the form 4 and form 6 Index numbers as well as applicant
category.

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

Attribute, Type & Field Format Usage Description


Length
f4indexno Varchar, 15 Mandatory Form Four Index Number in
specific format.
For applicants with NECTA
certificate the format for Form
Four Index Number is
“S1001/0512/2018”
f6indexno Varchar, 15 Mandatory Form Six Index Number in
specific format.
For applicants with NECTA
certificate the format for Form
Four Index Number is
“S1001/0512/2018”
Category Character,1 Mandatory ‘A’ for A-level and ‘D’ for Diploma
holders
Otherf4indexno Varchar, 100 Optional Separated by comma other form
four index numbers.
Otherf6indexno Varchar, 100 Optional Separated by comma other form
six index numbers.

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding applicant’s insert
status i.e. status code and status description objects
(d) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 Form Four Index Number
StatusCode Varchar, 20 Insertion status code
StatusDescription Varchar, 128 Status Description of Service Response

10
Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken >
<RequestParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<f6indexno> S1001/0562/2018 </f6indexno>
<Category>A</Category>
<Otherf4indexno> P1001/0012/2016, P1020/0289/2015</Otherf4indexno>
<Otherf6indexno> P1001/0562/2016, P0234/0002/2014 </Otherf6indexno>
</RequestParameters>
<RequestParameters>
<f4indexno> S1001/0013/2018</f4indexno>
<f6indexno>S1001/0563/2018 </f6indexno>
<Category>A</Category>
<Otherf4indexno> P1001/0012/2016, P1020/0289/2015</Otherf4indexno>
<Otherf6indexno> P1001/0562/2016, P0234/0002/2014 </Otherf6indexno>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno>S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>Data successfully inserted</StatusDescription>
</ResponseParameters>
</Response>

3.3 Submit Applicant Programme Choices

Web Service Description


Method
Submit Applicant Programme Choices After selection for admission has been done,
submit the list of applicants with their choices and other contact details to TCU
Submit (TCU’s template).
Programme
Form four index number, form six index number, programme choices, mobile
number, email, admission status, programme of admission, reason, nationality,
impairment, date of birth, other form four index number, National Identification
Number (NIN) and other form six index number.

11
Url: https://api.tcu.go.tz/applicants/submitProgramme
Call method: POST

(a) Request Parameters

Name i. Form Four Index number


ii. Form Six Index number
iii. Selected programmes (separated by comma)
iv. Mobile number
v. Other Mobile number
vi. Email address
vii. Applicant category
viii. Admission status
ix. Programme admitted
x. Reason
xi. Nationality
xii. Impairment
xiii. Date of birth
xiv. Other form four index number
xv. Other form six index number
xvi. National Identification Number
Direction Input
Type submitProgramme
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 the Form four and form six index numbers
or AVN number, applicant’s selected programmes , National
Identification Number, nationality, impairment (disability)
as well as date of birth

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

Attribute, Type & Field Format Usage Description


Length
f4indexno Varchar, 15 Mandatory Form Four Index Number in specific format
Form Four Index Number format
“S1001/0012/2018”
f6indexno Varchar, 15 Mandatory Form Six Index number
SelectedProgrammes Varchar, 100 Mandatory List of selected programmes separated by
comma.
MobileNumber Varchar,15 Mandatory Applicant’s mobile number
OtherMobileNumber Varchar,15 Optional Other Applicant’s mobile number (Next of kin)
EmailAddress Varchar,30 Mandatory Applicant’s email address
Category Character,1 Mandatory Applicant Category
AdmissionStatus Varchar,10 Mandatory Admission status
ProgrammeAdmitted Varchar,10 Optionals Programme the applicant is admitted to
Reason Varchar, 100 Mandatory Reason for not being admitted
Nationality Varchar, 50 Mandatory Applicant’s nationality
Impairment Varchar, 20 Mandatory Applicant’s disability
DateOfBirth Varchar, 12 Mandatory Applicant’s date of birth
Otherf4indexno Varchar , 100 Optional Additional A-level sittings
Otherf6indexno Varchar, 100 Optional Additional O-level sittings
NationalIdNumber Varchar, 50 Optional National Identification Number

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant Status,
status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 Form Four Index Number
StatusCode Varchar, 50 Service Status Code
StatusDescription Varchar, 128 Description of Status Code
14
Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>UDSM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno> S1001/0012/2018</f4indexno >
<f6indexno> S1001/0562/2018 </f6indexno>
<SelectedProgrammes>UD023, UD038, UD022</SelectedProgrammes>
<MobileNumber> 0766345678</MobileNumber>
<OtherMobileNumber> 0766345678</OtherMobileNumber>
<EmailAddress> [email protected] </EmailAddress>
<Category>A</Category>
<AdmissionStatus>provisional admission </AdmissionStatus>
<ProgrammeAdmitted>UD038</ProgrammeAdmitted>
<Reason>eligible</Reason>
<Nationality >Tanzanian</Nationality>
<Impairment>None</Impairment>
<DateOfBirth>1980-12-09</DateOfBirth>
<NationalIdNumber>19620228-00001-00001-19</NationalIdNumber>
<Otherf4indexno>S0001/0001/2009, S0001/0001/2010</Otherf4indexno>
<Otherf6indexno> S0001/0501/2009, S0001/0501/2010</Otherf6indexno>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was performed successfully</StatusDescription>
</ResponseParameters>
</Response>

3.4 Confirm Applicant Selection

Web Service Method Description


Applicant Confirm Applicant Selection
Confirmation Each applicant with multiple selections shall use a TCU provided token/code to
confirm selection to ONLY one HLI, and the same shall be confirmed with TCU.

15
Url: https://api.tcu.go.tz/admission/confirm
Call method: POST

(a) Request Parameters

Name i. Form Four Index number


ii. Confirmation code
Direction Input
Type confirm
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 in given format.
Form Four Index Number format “S1001/0012/2018”

II. String
Confirmation Code

(b) Request Payload

Attribute, Type Field Format Usage Description


& Length
f4indexno Varchar, 15 Mandatory Form Four Index Number in specific format
Form Four Index Number format
“S1001/0012/2018”
ConfirmationCode Varchar , 12 Mandatory A confirmation code

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements

16
Body of the response contains the information regarding
applicant status, status code and status description objects

(d) Response Payload

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

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

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<ConfirmationCode>A5267Y</ConfirmationCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>

3.5 Unconfirm Admission

Web Service Method Description


Unconfirm Admission
Unconfirm Admission An applicant that had confirmed can unconfirm the admission via the
respective HLI online system, and the same shall be passed on to TCU.

17
Url: https://api.tcu.go.tz/admission/unconfirm
Call method: POST

(a) Request Parameters

Name i. Form four index number


ii. Confirmation code
Direction Input
Type unconfirm
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 in given format.
Form Four Index Number format “S1001/0012/2018”

ii. String
Confirmation Code

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
f4indexno Varchar, 15 Mandatory Form Four Index Number in specific format
Form Four Index Number format
“S1001/0012/2018”
ConfirmationCode Varchar , 12 Mandatory “REJECT” to imply a previously confirmed admission
is now being released

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type

18
Body Response Body Section
Contains elements
Body of the response contains the information regarding
Applicant Status and error code objects
(d) Response Payload

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

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>UDSM</Username>
< SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters >
<f4indexno> S1001/0012/2018</f4indexno>
<ConfirmationCode>36R96P</ConfirmationCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>

3.6 Resubmit Applicant Details

Web Service Method Description

Resubmit rectified applicants:


Update TCU on applicant details that might be different from the initial
Resubmit
submission=> form four index number, form six index number, programme
Programme
choices, mobile number, other mobile number, email, admission status,
programme of admission , reason, applicant category, other form four index
19
number(s), other form six index number(s), nationality, impairment, date of birth

Url: https://api.tcu.go.tz/applicants/resubmit
Call method: POST
(a) Request Parameters

Name i. Form four index number


ii. Form six index number
iii. Programme choices
iv. Mobile number
v. Other mobile number
vi. Email address
vii. Admission status
viii. Programme admitted
ix. Reason
x. Applicant category
xi. Other form four index number(s)
xii. Other form six index number(s)
xiii. Nationality
xiv. Impairment
xi. Date of birth
Direction Input
Type resubmit
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 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 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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
f4indexno Varchar, 15 Mandatory Form Four Index Number in given format.
For applicants with NECTA certificate the format
for Form Four Index Number is
“S1001/0012/2014”
f6indexno Varchar , 15 Mandatory Form Six Index Number in given format.
For applicants with NECTA certificate the format
for Form Six Index Number is S1001/0012/2014”
SelectedProgrammes Varchar, 100 Mandatory Comma separated List of selected programmes

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

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding
Applicant Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 Form Four Index Number
StatusCode Varchar, 50 Response status code
StatusDescription Varchar, 128 Description of status code
Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken >
<RequestParameters>
<f4indexno> S1001/0012/2018</f4indexno >
<f6indexno> S1001/0562/2018 </f6indexno>
<SelectedProgrammes>UD023, UD038, UD022</SelectedProgrammes>
22
<MobileNumber> 0766345678</MobileNumber>
<OtherMobileNumber>0766345679<OtherMobileNumber>
<EmailAddress>[email protected] </EmailAddress>
<AdmissionStatus>Provisional admission </AdmissionStatus>
<ProgrammeAdmitted>UD038</ProgrammeAdmitted>
<Category>eligible</Category>
<Reason>eligible</Reason>
<Nationality >Tanzanian</Nationality>
<Impairment>None</Impairment>
<DateOfBirth>1980-12-09</DateOfBirth>
<Otherf4indexno> P1001/0012/2016, P1020/0289/2015</Otherf4indexno>
<Otherf6indexno> P1001/0562/2016,P0234/0002/2014 </Otherf6indexno>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was performed successfully</StatusDescription>
</ResponseParameters>
</Response>

3.7 Populate Dashboard

Web Service Method Description

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

Name i. Programme Code


ii. Males
iii. Females
Direction Input
Type populate
Content type
Component Type
23
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

ii. Integer
Males: Number of male applicants
iii. Integer
Females: Number of female applicants

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 5 Mandatory Programme code as per TCU Guide Book
Males integer, 4 Mandatory Number of male applicants
Females integer, 4 Mandatory Number of female applicants

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding applicant status,
status code and status description objects

(d) Response Payload

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
description

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

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<ProgrammeCode> DM038</ProgrammeCode>
<StatusCode>200</StatusCode>
<StatusDescription>The operation was performed
successfully</StatusDescription>
</ResponseParameters>
</Response>

3.8 Get Admitted Applicants

Web Service Method Description

Get admitted applicants:


Get Admitted
Download a list of admitted and confirmed applicants (per institution, per
course)

Url: https://api.tcu.go.tz/admission/getAdmitted
Call method: POST

(a) Request Parameters

Name i. Programme Code


Direction Input
Type getAdmitted
Content type
Component Type
Header Request header section
Contains elements as define in the following table
Component Type Description

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

(b) Request Payload

Attribute, Type Field Usage Description


& Length Format
ProgrammeCode Varchar, 5 Mandatory Programme code as per TCU Guide Book

(c) Response Parameters

Name i. Programme Code


ii. Status Code
iii. Status Description
iv. Applicant’s details
Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the InstitutionCode, programme and array of
Form Four Index Numbers

i. String
Programme Code

ii. Integer
Status Code

iii. String
Status Description

iv. String
Containing list of form four index numbers
(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service response status code
StatusDescription Varchar, 128 Description of service response status code
ProgrammeCode Varchar, 5 Programme code
f4indexno Varchar, 15 Form four index number
f6indexno Varchar, 15 Form six index number
MobileNumber Varchar, 15 Applicant’s mobile number
EmailAddress Varchar, 70 Applicant’s email address

26
AdmissionStatus Varchar, 128 Applicant’s admission status

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>DM023</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters >
<ProgrammeCode>DM023</ProgrammeCode>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was successful</StatusDescription>
<Applicant>
<f4indexno> S1001/0012/2016</f4indexno >
<f6indexno> S1001/0562/2018 </f6indexno>
<MobileNumber> 0766345678</MobileNumber>
<EmailAddress>[email protected]</EmailAddress>
<AdmissionStatus>Provisional admission</AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0013/2016</f4indexno >
<f6indexno> S1001/0565/2018 </f6indexno>
<MobileNumber> 0766345678</MobileNumber>
<EmailAddress> [email protected] </EmailAddress>
<AdmissionStatus>Provisional admission </AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0042/2016</f4indexno >
<f6indexno> S1001/0572/2018 </f6indexno>
<MobileNumber> 0766345678</MobileNumber>
<EmailAddress> [email protected] </EmailAddress>
<AdmissionStatus>provisional admission </AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0016/2016</f4indexno >
<f6indexno> S1001/0662/2018 </f6indexno>
<MobileNumber> 0766345678</ MobileNumber>
27
<EmailAddress> [email protected] </ EmailAddress>
<AdmissionStatus>provisional admission </AdmissionStatus>
</Applicant>
</ResponseParameters>
</Response>

3.9 Get Programmes with Admitted Candidates

Web Service Method Description

Get programmes with Admitted candidates


Get Programmes with
Download a list of institutions with all programmes with admitted
Admitted applicants
applicants

Url: https://api.tcu.go.tz/admission/getProgrammes
Call method: POST

(a) Request Parameters

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.

(b) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information: list of programmes that has
at least one selected applicant

28
(c) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 20 Service response status code
StatusDescription Varchar, 128 Description of service response status code
ProgrammeCode Varchar, 5 Programme code
NumberOfApplicant Integer Number of applicants

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<StatusDescription>Data successfully retrieved</StatusDescription>
<Programme>
<ProgrammeCode>DM001 </ProgrammeCode>
<NumberOfApplicant>90 </NumberOfApplicant>
</Programme>
<Programme>
<ProgrammeCode>DM002 </ProgrammeCode>
<NumberOfApplicant>120 </NumberOfApplicant>
</Programme>
<Programme>
<ProgrammeCode>DM003 </ProgrammeCode>
<NumberOfApplicant>140 </NumberOfApplicant>
</Programme>
</ResponseParameters>
</Response>

3.10 Get applicants’ Admission Status

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

(a) Request Parameters

Name i. Programme code


Direction Input
Type getStatus
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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 5 Mandatory Programme code as per TCU Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type

30
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code
f4indexno Varchar,15 Form four index number
AdmissionStatus Varchar , 100 Applicant’s admission status

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>DM023</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<StatusDescription>The operation was performed
successfully</StatusDescription>
<ProgrammeCode> DM023</ProgrammeCode>
<Applicant>
<f4indexno> S1001/0012/2016</f4indexno>
<AdmissionStatusCode>225</AdmissionStatusCode>
<AdmissionStatusDescription>The applicant has multiple
admission</AdmissionStatusDescription>
</Applicant>
<Applicant>
<f4indexno> S1001/0013/2016</f4indexno>
<AdmissionStatusCode>225</AdmissionStatusCode>
<AdmissionStatusDescription>The applicant has multiple
admissions</AdmissionStatusDescription>
</Applicant>
31
<Applicant>
<f4indexno> S1001/0042/2016</f4indexno>
<AdmissionStatusCode>226</AdmissionStatusCode>
<AdmissionStatusDescription>The applicant has single
admission</AdmissionStatusDescription>

</Applicant>
<Applicant>
<f4indexno> S1001/0016/2016</f4indexno>
<AdmissionStatusCode>226</AdmissionStatusCode>
<AdmissionStatusDescription>The applicant has single
admission</AdmissionStatusDescription>
</Applicant>
</ResponseParameters>
</Response>

3.11 Get a list of confirmed applicants

Web Service Method Description

Get list of •confirmed


Get a list of confirmed applicants
applicants• Get a list of applicants with multiple admission but who confirmed elsewhere

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

(a) Request Parameters

Name i. Programme Code


Directio Input
n
Type getConfirmed
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

32
(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode String,5 Mandatory Programme code

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information :
programme code, list of confirmed applicants

(d) Response Payload

Attribute, Type & Length Field Format Description


ProgrammeCode Varchar, 5 Programme code
f4indexno Varchar, 15 List of index numbers
StatusCode Varchar, 20 Service response status code
StatusDescription Varchar, 128 Description of service response status code
ConfirmationStatusCode Varchar, 5 Confirmation status Code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode> DM023</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<ProgrammeCode> DM023</ProgrammeCode>
<StatusCode>200</StatusCode>

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>

3.12 Request confirmation code

Web Service Method Description

Request confirmation code


An applicant that had multiple admission can request confirmation code
Request confirmation code
via the respective HLI online system, and the same shall be passed on to
TCU.

Url: https://api.tcu.go.tz/admission/requestConfirmationCode
Call method: POST
(a) Request Parameters

Name i. Form four index number


ii. Mobile Number
iii. Email Address
Direction Input
Type requestConfirmationCode
Content type
Component Type
Header Request header section
34
Contains elements as define in the following table
Component Type Description
Username String Username provided by TCU
SessionTok String System generated Token used to authenticate request before
en processing generate by TCU system.
Body i. String
Form four index number
ii. String
Mobile number
iii. String
Email address

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
f4indexno String,5 Mandatory Form four index number
MobileNumber String,12 Mandatory Mobile number
EmailAddress String, 50 Mandatory Email address

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information :
form four index number, status code and status description

(c) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 List of index numbers
StatusCode Varchar, 20 Service response status code
StatusDescription Varchar, 128 Description of service response status code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno>S0001/0118/2019</f4indexno>
35
<MobileNumber>06XXXXXXXX</MobileNumber>
<EmailAddress>[email protected]</ EmailAddress >
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno>S0001/0118/2019</f4indexno>
<StatusCode>223</StatusCode>
<StatusDescription>Confirmation code has been sent to your email address and
mobile number</StatusDescription>
</ResponseParameters>
</Response>

3.13 Cancel/Reject Admission

Web Service Method Description

Cancel/ Reject Admission


Cancel/Reject Admission An applicant that had prior admission can cancel his admission via the
respective HLI online system, and the same shall be passed on to TCU.

Url: https://api.tcu.go.tz/admission/reject
Call method: POST

(a) Request Parameters

Name i. Form four index number

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

(b) Request Payload


36
Attribute, Type & Field Format Usage Description
Length
f4indexno String,15 Mandatory Form four index number

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information :
form four index number, status code and status description

(d) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 List of index numbers
StatusCode Varchar, 20 Service response status code
StatusDescription Varchar, 128 Description of service response status code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno>S0001/0018/2019</f4indexno>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno>S0001/0118/2019</f4indexno>
<StatusCode>224</StatusCode>
<StatusDescription>You have no admission to this institution. </StatusDescription>
</ResponseParameters>
</Response>
37
3.14 Submit Internal Transfers

Web Service Method Description

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

(a) Request Parameters

Name i. Form four index number


ii. Form six index number
iii. Previous Programme Code
iv. Current Programme Code

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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
f4indexno String,15 Mandatory Form four index number
f6indexno String,15 Mandatory Form six index number
CurrentProgrammeCode Varchar,5 Mandatory Current programme code

38
PreviousProgrammeCode Varchar,5 Mandatory Previous programme code

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information:
form four index number, status code and status description

(d) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 List of index numbers
StatusCode Varchar, 20 Service response status code
StatusDescription Varchar, 128 Description of service response status code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno>S0001/0018/2015</f4indexno>
<f6indexno>S0001/0018/2019</f6indexno>
<CurrentProgrammeCode>DM002</CurrentProgrammeCode>
<PreviousProgrammeCode>DM001</PreviousProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno>S0001/0018/2015</f4indexno>
<StatusCode>208</StatusCode>
39
<StatusDescription>The applicant has already been submitted
previously <StatusDescription>
</ResponseParameters>
</Response>

3.15 Submit Inter Institutional Transfers

Web Service Method Description

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

(a) Request Parameters

Name i. Form four index number


ii. Form six index number
iii. Previous Programme Code
iv. Current Programme Code
Direction Input
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
SessionToke String System generated Token used to authenticate request before
n 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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
f4indexno String,15 Mandatory Form four index number
f6indexno String,15 Mandatory Form six index number
CurrentProgrammeCode Varchar,5 Mandatory Current programme code
40
PreviousProgrammeCode Varchar,5 Mandatory Previous programme code

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information:
form four index number, status code and status description

(d) Response Payload

Attribute, Type & Length Field Format Description


f4indexno Varchar, 15 List of index numbers
StatusCode Varchar, 20 Service response status code
StatusDescription Varchar, 128 Description of service response status code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<f4indexno>S0001/0018/2015</f4indexno>
<f6indexno>S0001/0018/2019</f6indexno>
<CurrentProgrammeCode>DM002</CurrentProgrammeCode>
<PreviousProgrammeCode>DM001</PreviousProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno>S0001/0118/2019</f4indexno>
<StatusCode>224</StatusCode>
<StatusDescription>You have no admission to this institution.</StatusDescription>
</ResponseParameters>
</Response>

41
3.16 Get applicants’ Verification Status

Web Service Method Description


Get Applicant’s Verification Get applicants’ Verification Status
Status Download a list of applicants with their 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

(a) Request Parameters

Name i. Programme code


Direction Input
Type getApplicantVerificationStatus
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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 5 Mandatory Programme code as per TCU Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
42
Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code
f4indexno Varchar,15 Form four index number
AdmissionStatus Varchar , 100 Applicant’s admission status
VerificationStatusCode Varchar, 6 Applicant’s verification status code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>DM</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>DM023</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<StatusDescription>The operation was performed
successfully</StatusDescription>
<ProgrammeCode> DM023</ProgrammeCode>
<Applicant>
<f4indexno> S1001/0012/2016</f4indexno>
< VerificationStatusCode > 232</ VerificationStatusCode >
<AdmissionStatus>Did not meet minimum
requirements</AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0013/2016</f4indexno>
< VerificationStatusCode > 232</ VerificationStatusCode >
<AdmissionStatus>Failed Mandatory subject</AdmissionStatus>
</Applicant>
<Applicant>
<f4indexno> S1001/0042/2016</f4indexno>
< VerificationStatusCode >232 </ VerificationStatusCode >
<AdmissionStatus>Does not meet minimum
entry requirements</AdmissionStatus>
43
</Applicant>
<Applicant>
<f4indexno> S1001/0016/2016</f4indexno>
< VerificationStatusCode >231 </ VerificationStatusCode >
<AdmissionStatus>Qualified</AdmissionStatus>
</Applicant>
</ResponseParameters>
</Response>

3.17 Submit enrolled/registered students

Web Service Method Description


Submit to TCU the list of registered/enrolled students into a programme of
study in the academic year. This endpoint is used to submit students
Submit enrolled in all programmes from Certificate to PhD in university institutions
enrolled/registered
and students registered into Undergraduate programmes in Non-University
students
institutions.

Url: https://api.tcu.go.tz/applicants/submitEnrolledStudents
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Gender
v. Nationality
vi. Date of birth
vii. Programme category
viii. Field of specialization
ix. Year of study
x. Study mode
xi. Status of whether repeating a year or not
xii. Entry mode (qualification)
xiii. Sponsorship information
xiv. Physical challenges/impairment
xv. F4 index number
xvi. Programme name
xvii. Registration number
xviii. Programme code
xix. Year of admission
Direction Input
Type submitEnrolledStudents
Content type
44
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 the names, form four index number, Gender,
Nationality, Date of birth, Programme category, Field of
specialization, Year of study, Study mode, Status of whether
repeating a year or not, Entry mode (qualification),
Sponsorship information, Physical challenges/impairment,
Programme name, Registration number, Programme code
and Year of admission

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

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
Fname Varchar, 35 Mandatory Students first name as appearing on the form four
certificate
Mname Varchar, 35 Optional Students Middle/Second name as appearing on the
form four certificate
Surname Varchar, 35 Mandatory Students surname as appearing on the form four
certificate
F4indexno Varchar, 35 Mandatory Form four index number
Gender Varchar,2 Mandatory Students sex
Nationality Varchar,50 Mandatory Nationality of the student

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.

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Student
registration number, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


RegistrationNumber Varchar, 35 Registration Number
StatusCode Varchar, 50 Service Status Code
StatusDescription Varchar, 128 Description of Status Code
Example request

<?xml version=”1.0” encoding=” UTF-8”?>


<Request>
<UsernameToken>
<Username>UDSM</Username>

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

<?xml version=”1.0” encoding=” UTF-8”?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<RegistrationNumber>TZ017/9999/2018</RegistrationNumber>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>

3.18 Submit graduates

Web Service Method Description


Submit to TCU the list of graduates in the graduation year. This endpoint is
used to submit graduates for all programmes from Certificate to PhD from
Submit graduates university institutions and Bachelor and Postgraduate graduates from Non-
University institutions.
Url: https://api.tcu.go.tz/applicants/submitGraduates
Call method: POST

48
(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Gender
v. Registration number
vi. Field of specialization
vii. Category of award
viii. Award class
ix. Award name
x. Grade Points Average (GPA)
xi. Graduation year
xii. Registration year
xiii. F4 index number
xiv. Programme code
xv. National Identification Number (NIN- Issued by NIDA)
Direction Input
Type submitGraduates
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 the names, form four index number, Gender,
Registration number, Programme code, field of
specialization, category of the award, award classification
(class), name of the award, GPA, graduation year,
registration year and National Identification Number (NIN)

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

Attribute, Type & Field Usage Description


Length Format
Fname Varchar, 35 Mandatory Graduates first name as appearing on the form four
certificate
Mname Varchar, 35 Optional Graduates Middle/Second name as appearing on the
form four certificate
Surname Varchar, 35 Mandatory Graduates surname as appearing on the form four
certificate
F4indexno Varchar, 35 Mandatory Form four index number
Gender Varchar,2 Mandatory Graduates sex
ProgrammeCode Varchar, 10 Mandatory Programme Code
RegistrationNumber Varchar, 50 Mandatory Graduates’s registration number
FieldOfSpecialization Varchar, Mandatory Graduates area of specialization
255
AwardCategory Varchar, Mandatory Category of the award e.g. “Bachelor Degree”
100
AwardClass Varchar, 30 Mandatory Classification of the award e.g. “First Class”
AwardName Varchar, Mandatory The name of the award/programme
255
GPA Varchar, 5 Mandatory Overall scored GPA for classified degrees
GraduationYear Varchar, 6 Mandatory The year of graduation
RegistrationYear Varchar, 6 Mandatory The year registered into the programme
NationalIdNumber Varchar, 30 Optional National Identification Number (NIN) issued by
NIDA

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding
Student registration number, status code and status
description objects

51
(d) Response Payload

Attribute, Type & Length Field Format Description


RegistrationNumber Varchar, 35 Registration Number
StatusCode Varchar, 50 Service Status Code
StatusDescription Varchar, 128 Description of Status Code

Example request

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>XYZ</Username>
<SessionToken>sWqW8majE2T22M4cerT</SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>JUMA</Fname>
<Mname>M</Mname>
<Surname>HAMZA</Surname>
<F4indexno>S1546/0122/1980</F4indexno>
<Gender>M</Gender>
<FieldOfSpecialization>Architecture</FieldOfSpecialization>
<AwardCategory>Bachelor Degree</AwardCategory>
<AwardClass> Upper Second</AwardClass>
<AwardName>Bachelor of Architecture</AwardName>
<GPA>4.0</GPA>
<RegistrationNumber>8228/T.1991</RegistrationNumber>
<GraduationYear>2019</GraduationYear>
<RegistrationYear>2014</RegistrationYear>
<ProgrammeCode>XY001</ProgrammeCode>
<NationalIdNumber>19620228-00001-00001-19</NationalIdNumber>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<RegistrationNumber>8228/T.1991</RegistrationNumber>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>
</xml>
52
3.19 Submit Institution Staff

Web Service Method Description


Submit Institution Submit to TCU the list of both academic and administrative staff
Staff

Url: https://api.tcu.go.tz/applicants/submitInstitutionStaff
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Gender
v. Tittle
vi. Email
vii. Highest qualification
viii. Employment status
ix. Source institution
x. Year of birth
xi. Nationality
xii. Physical challenges
xiii. Staff rank
xiv. Staff role
xv. Level of teaching
xvi. Staff specialization
xvii. Staff Identification Number
xviii. National Identification Number (NIN- Issued by NIDA)
Direction Input
Type submitInstitutionStaff
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
53
Contains Elements
Body contains the names, tittle, gender, highest
qualifications, source institution, employment status, year
of birth, nationality, physical challenges, staff rank, staff
role, email address, level of teaching, staff field of
specialization, staff Identification Number and National
Identification Number (NIN)

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

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
Fname Varchar, 35 Mandatory Staff first name as appearing on the form four
certificate/payroll
Mname Varchar, 35 Optional Staff Middle/Second name as appearing on the form
four certificate/payroll
Surname Varchar, 35 Mandatory Staff surname as appearing on the form four
certificate/payroll
Tittle Varchar, 5 Mandatory Staff tittle/salutation
Gender Varchar,2 Mandatory Staff sex
HighestQualifications Varchar, 20 Mandatory The highest level of education attained e.g. PhD,
Master’s Degree etc.
EmploymentStatus Varchar, 50 Mandatory The employment status e.g. “Full Time”
StaffSpecialization Varchar, Mandatory Staff field of specialization e.g. ICT
255
SourceInstitution Varchar, Mandatory The institution at which the staff is permanently
200 employed
PhysicalChallenges Varchar, Mandatory Physical challenges or impairment
255
StaffRank Varchar, Mandatory Staff rank e.g. Senior Lecturer, Associate Professor,
255 Director etc.
StaffRole Varchar, 50 Mandatory Staff role in the institution e.g. “Academic Staff”,
“Administrative Staff” or “Both Academic and
Administrative Staff”
YearOfBirth Varchar, 6 Mandatory The year of birth e.g. 1972
Nationality Varchar, Mandatory Staff nationality
255

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

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding
Staff Identification number, status code and status
description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StaffId Varchar, 35 Staff Identification Number
StatusCode Varchar, 50 Service Status Code
StatusDescription Varchar, 128 Description of Status Code

Example request

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>XYZ</Username>
<SessionToken> sWqW8majE2T22M4cerT </SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>HAMISI</Fname>
<Mname>M.</Mname>
<Surname> HAMISI </Surname>
<Tittle>Dr.</Tittle>
<Gender>M</Gender>
56
<HighestQualifications>PhD</HighestQualifications>
<EmploymentStatus>Full time</EmploymentStatus>
<SourceInstitution> Ardhi University</SourceInstitution>
<YearOfBirth>1962</YearOfBirth>
<Nationality>Tanzanian</Nationality>
<PhysicalChallenges>None</PhysicalChallenges>
<StaffRank>Senior Lecturer</StaffRank>
<Email>[email protected]</Email>
<StaffRole>Academic Staff</StaffRole>
<LevelOfTeaching>PhD</LevelOfTeaching>
<StaffSpecialization>ICT</StaffSpecialization>
<StaffId>PF/1989/AC</StaffId>
<NationalIdNumber>19620228-00001-00001-19</NationalIdNumber>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<StaffId> PF/1989/AC < /StaffId >
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.20 Get verification status for internally transferred students

Web Service Method Description


Get verification status for
internally transferred Download applicants who have requested for internal transfers and their
students TCU verification status

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

(a) Request Parameters

Name i. Programme code


Direction Input
Type getInternalTransferStatus
Content type
57
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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 5 Mandatory Programme code as per TCU Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Verification Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code
f4indexno Varchar,15 Form four index number
VerificationStatus Varchar , 100 Applicant’s TCU verification status
VerificationStatusCode Varchar , 6 Applicant’s TCU verification status Code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>MN</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ389i</SessionToken>
</UsernameToken>
<RequestParameters>

58
<ProgrammeCode>MN062</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="UTF-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode> <StatusDescription>Operation was
successful</StatusDescription>
<ProgrammeCode>MN062</ProgrammeCode>
<Applicant>
<f4indexno>S1025/0058/2013</f4indexno>
<VerificationStatusCode>231</ VerificationStatusCode >
<VerificationStatus>APPROVED</VerificationStatus>
</Applicant>
<Applicant>
<f4indexno>S0149/0070/2004</f4indexno>
<VerificationStatusCode>231</ VerificationStatusCode >
<VerificationStatus>APPROVED</VerificationStatus>
</Applicant>
<Applicant>
<f4indexno>S0931/0188/2015</f4indexno>
<VerificationStatusCode>231</ VerificationStatusCode >
<VerificationStatus>APPROVED</VerificationStatus>
</Applicant>
</ResponseParameters>
</Response>
</xml>

3.21 Get verification status for inter-institutional transferred students

Web Service Method Description


Get verification status for
inter-institutional Download applicants who have requested for inter-institutional (from
transferred students one institution to another) transfers and their TCU verification status

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

(a) Request Parameters

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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 5 Mandatory Programme code as per TCU Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Verification Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code
f4indexno Varchar,15 Form four index number
VerificationStatus Varchar , 100 Applicant’s TCU verification status
VerificationStatusCode Varchar, 6 Applicant’s TCU verification status Code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
60
<UsernameToken>
<Username>MN</Username>
<SessionToken>OTcyMURGMTY5QTRENU3MUJ389i</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>MN068</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="UTF-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode> <StatusDescription>Operation was
successful</StatusDescription>
<ProgrammeCode>MN068</ProgrammeCode>
<Applicant>
<f4indexno>S1025/0058/2013</f4indexno>
<VerificationStatusCode>231</ VerificationStatusCode >
<VerificationStatus>APPROVED</VerificationStatus>
</Applicant>
<Applicant>
<f4indexno>S0149/0070/2004</f4indexno>
<VerificationStatusCode>231</ VerificationStatusCode >
<VerificationStatus>APPROVED</VerificationStatus>
</Applicant>
<Applicant>
<f4indexno>S0931/0188/2015</f4indexno>
<VerificationStatusCode>231</ VerificationStatusCode >
<VerificationStatus>APPROVED</VerificationStatus>
</Applicant>
</ResponseParameters>
</Response>
</xml>

3.22 Restore cancelled admission

Web Service Method Description


Restore cancelled Restore admission for applicants who previously cancelled their
admission admissions

Url: https://api.tcu.go.tz/admission/restoreCancelledAdmission
Call method: POST

(a) Request Parameters


61
Name i. Form four index number
ii. Programme code
Direction Input
Type restoreCancelledAdmission
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 in given format.
Form Four Index Number format “S1001/0012/2018”

II. String
Programme Code

(b) Request Payload

Attribute, Type Field Usage Description


& Length Format
f4indexno Varchar, 20 Mandatory Form Four Index Number in specific format
Form Four Index Number format
“S1001/0012/2018”
ProgrammeCode Varchar, 8 Mandatory Programme code as appearing in the Undergraduate
Admissions Guidebook

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant Status
and error code objects

(d) Response Payload

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

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>UDSM</Username>
< SessionToken>OTcyMURGMTY5QTRENU3MUJ</SessionToken>
</UsernameToken>
<RequestParameters >
<f4indexno> S1001/0012/2018</f4indexno>
<ProgrammeCode>UD009</ ProgrammeCode >
</RequestParameters>
</Request>

Example response

<?xml version=”1.0” encoding=”UTF-8”?>


<Response>
<ResponseParameters>
<f4indexno> S1001/0012/2018</f4indexno>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>

3.23 Submit students drop-outs

Web Service Method Description


Submit students Add/Submit to TCU students who dropped their studies
drop-outs

Url: https://api.tcu.go.tz/applicants/submitStudentsDropOuts
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Gender
63
v. Form Four index number
vi. Year terminated
vii. Year of study
viii. Termination reason(s)
ix. Registration number
x. Programme category
xi. Programme name
xii. Programme code
Direction Input
Type submitStudentsDropOuts
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 the names, gender, form four index number,
year terminated, year of study, termination reason(s),
registration number, programme category, programme
name and programme code.

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

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
Fname Varchar, 35 Mandatory Student first name as appearing on the form four
certificate
Mname Varchar, 35 Optional Student Middle/Second name as appearing on the
form four certificate
Surname Varchar, 35 Mandatory Student surname as appearing on the form four
certificate
F4indexno Varchar, 20 Mandatory The form four index number
Gender Varchar,2 Mandatory Student sex
YearTerminated Varchar, 4 Mandatory Year a student terminated his/her studies e.g. 2019
YearOfStudy Varchar, 15 Mandatory Year of study e.g. “First Year”
TerminationReason Varchar, 255 Mandatory The reasons for dropping studies
RegistrationNumber Varchar, 255 Mandatory Student registration number
ProgrammeCategory Varchar, 255 Mandatory The programme level e.g. “Bachelor Degree”,
“Master’s Degree” etc.
ProgrammeName Varchar, 255 Mandatory The programme name
ProgrammeCode Varchar, 255 Mandatory The programme name as appearing on the
Undergraduate Admissions Guidebook

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type

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

(d) Response Payload

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

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>XYZ</Username>
<SessionToken> sWqW8majE2T22M4cerT456i </SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>HAMISI</Fname>
<Mname>M</Mname>
<Surname>HAMZA</Surname>
<Gender>M</Gender>
<F4indexno>S1111/0001/2020</F4indexno>
<YearTerminated>2019</YearTerminated>
<YearOfStudy>First Year</ YearOfStudy >
<TerminationReason>Failure to pay school fees</TerminationReason>
<RegistrationNumber>T.2008/0002/1</RegistrationNumber>
<ProgrammeCategory>Bachelor Degree</ProgrammeCategory>
<ProgrammeName>Bachelor of Architecture</ProgrammeName>
<ProgrammeCode>NM009</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>208</StatusCode>
<F4indexno>S1111/0001/2020</F4indexno>
<StatusDescription>The student has already been submitted
previously</StatusDescription>
</ResponseParameters>
</Response>
66
</xml>

3.24 Submit students who postponed studies

Web Service Method Description


Submit students Submit students who postponed studies in the current academic year
who postponed
studies

Url: https://api.tcu.go.tz/applicants/submitPostponedStudents
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Gender
v. Form Four index number
vi. Postponement year
vii. Year of study
viii. Reason for postponement
ix. Registration number
x. Programme name
xi. Programme code
Direction Input
Type submitPostponedStudents
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 the names, gender, form four index number,
postponement year, year of study, postponement reason(s),
registration number, programme name and programme

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

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
Fname Varchar, 35 Mandatory Student first name as appearing on the form four
certificate
Mname Varchar, 35 Optional Student Middle/Second name as appearing on the
form four certificate
Surname Varchar, 35 Mandatory Student surname as appearing on the form four
certificate

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

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
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

(d) Response Payload

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

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>XYZ</Username>
<SessionToken> sWqW8majE2T22M4cerT456i </SessionToken>
</UsernameToken>
69
<RequestParameters>
<Fname>HAMISI</Fname>
<Mname>M</Mname>
<Surname>HAMZA</Surname>
<Gender>M</Gender>
<F4indexno>S1111/0001/2020</F4indexno>
<RegistrationNumber>T.2008/0002/1</RegistrationNumber>
<YearOfStudy>First Year</YearOfStudy>
<PostponmentYear>2018</PostponmentYear>
<PostponmentReason>Failure to pay fees</PostponmentReason>
<ProgrammeCode>NM009</ProgrammeCode>
<ProgrammeName>Bachelor of Architecture</ProgrammeName>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<F4indexno>S1111/0001/2020</F4indexno>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.25 Submit admitted students into non-degree programmes

Web Service Method Description


Submit admitted Add/submit students admitted into non-degree programmes (Certificates,
students into non- Diplomas or Foundation Programme)
degree programmes

Url: https://api.tcu.go.tz/applicants/submitAdmittedNonDegree
Call method: POST

(a) Request Parameters

Name i. Form Four index number


ii. Form Six index number/AVN
iii. Certificate registration number
iv. Gender
v. Nationality
vi. Impairment
vii. Date of birth
viii. Programme Code

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

(b) Request Payload

Attribute, Type & Field Usage Description


Length Format
F4indexno Varchar, 35 Mandatory The form four index number
F6indexno Varchar, 35 Optional The form six index number
CertificateRegNumb Varchar, 55 Optional Certificate registration number for applicants with
certificate or AVN for applicants with diploma
qualifications
Gender Varchar, 20 Mandatory Student sex
Nationality Varchar,255 Mandatory Student nationality
Impairment Varchar, Mandatory Student impairment/disability
255
DateOfBirth Varchar, 15 Mandatory Date of birth e.g. “28-02-1978”
ApplicantCategory Varchar, Mandatory Category of the programme an applicant was
255 admitted to e.g. “Diploma”, “Certificate” or”
Foundation programme”
ProgrammeName Varchar, Mandatory The programme name
255
ProgrammeCode Varchar, 10 Mandatory The programme name as appearing on the
Undergraduate Admissions Guidebook

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
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

(d) Response Payload

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

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>XYZ</Username>
<SessionToken>sWqW8majE2T22M4cerT456i </SessionToken>
</UsernameToken>
<RequestParameters>
<F4indexno>S1111/0001/2020</F4indexno>
<F6indexno>S1111/0901/2022</F6indexno>
<CertificateRegNumb>19TC191919ME</CertificateRegNumb>
<Gender>M</Gender>
<Nationality>Tanzanian</Nationality>
<Impairment>None</Impairment>
<DateOfBirth>28-02-1960</DateOfBirth>
<ApplicantCategory>Diploma</ApplicantCategory>
<ProgrammeName>Diploma in Architecture</ProgrammeName>
<ProgrammeCode>NM009</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<F4indexno>S1111/0001/2020</F4indexno>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.26 Get verification status for non-degree admitted students

Web Service Method Description


Get verification status for
Download admitted students into non-degree programmes and their
non-degree admitted
verification status
students
73
Url: https://api.tcu.go.tz/applicants/getNonDegreeAdmittedStatus
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 non-degree admitted students

(a) Request Parameters

Name i. Programme code


Direction Input
Type getNonDegreeAdmittedStatus
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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 10 Mandatory Programme code as per TCU Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code

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

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>
<Username>MNX</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>MNM01</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>210</StatusCode>
<ProgrammeCode> MNM01</ProgrammeCode>
<StatusDescription>No Record Found</StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.27 Submit applicants applied for Postgraduate programmes

Web Service Method Description


Submit applicants applied for Submit to TCU the list of applicants applied for Postgraduate
Postgraduate programmes degree programmes in University Institutions

Url: https://api.tcu.go.tz/applicants/submitPostgraduateApplicants
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Form Four index number
v. Gender
75
vi. Nationality
vii. Impairment
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. Selected Programmes (programme choices)
xvi. Mode of entry
Direction Input
Type submitPostgraduateApplicants
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),
Selected Programmes (programme choices) and Mode of
entry.

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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
Fname Varchar, 255 Mandatory Applicant first name
Mname Varchar, 255 Optional Applicant second name
Surname Varchar, 255 Mandatory Applicant surname
F4indexno Varchar, 35 Mandatory The form four index number
Mobilenumber Varchar, 35 Mandatory Applicant Mobile number
Emailaddress Varchar, 60 Mandatory Applicant Email address
Gender Varchar, 6 Mandatory Applicant sex
Nationality Varchar,255 Mandatory Applicant nationality
Impairment Varchar, 255 Mandatory Student impairment/disability
DateOfBirth Varchar, 15 Mandatory Date of birth e.g. “28-02-1978”
ProgrammeCategory Varchar, 255 Mandatory Category of the programme an applicant was

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

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
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

(d) Response Payload

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

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>MNX</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>MICHAEL</Fname>
<Mname>M</Mname>
<Surname>JOHN</Surname>
<F4indexno>S1547/0122/2099</F4indexno>
78
<Gender>M</Gender>
<Nationality>Tanzanian</Nationality>
<DateOfBirth>1994</DateOfBirth>
<ProgrammeCategory>Masters Degree</ProgrammeCategory>
<Mobilenumber>079666666 </Mobilenumber>
<Emailaddress>[email protected]</Emailaddress>
<BachelorRegNumb>AGF/0019/11-20291</BachelorRegNumb>
<MastersRegNumb></MastersRegNumb>
<Impairment>None</Impairment>
<NationalIdNumber></NationalIdNumber>
<SelectedProgrammes>MMMC2,MMMC3,MMC44</SelectedProgrammes>
<EntryMode>Bachelor degree</EntryMode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>208</StatusCode>
<F4indexno>S1547/0122/2099</F4indexno>
<StatusDescription>The student has already been submitted
previously</StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.28 Submit admitted students into Postgraduate programmes

Web Service Method Description


Submit admitted students into Submit to TCU the list of admitted students into Postgraduate
Postgraduate programmes degree programmes in University Institutions

Url: https://api.tcu.go.tz/applicants/submitAdmittedPostgraduate
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Form Four index number
v. Gender
vi. Nationality
vii. Impairment

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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
Fname Varchar, 255 Mandatory Applicant first name
Mname Varchar, 255 Optional Applicant second name
Surname Varchar, 255 Mandatory Applicant surname
F4indexno Varchar, 35 Mandatory The form four index number
Mobilenumber Varchar, 35 Mandatory Applicant Mobile number
Emailaddress Varchar, 60 Mandatory Applicant Email address
Gender Varchar, 6 Mandatory Applicant sex
Nationality Varchar,255 Mandatory Applicant nationality
Impairment Varchar, 255 Mandatory Student impairment/disability
81
DateOfBirth Varchar, 15 Mandatory Date of birth e.g. “28-02-1978”
ProgrammeCategory Varchar, 255 Mandatory Category of the programme an applicant was
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)
ProgrammeAdmitted Varchar, 10 Optional Programme the applicant is admitted to
AdmissionStatus Varchar, 255 Mandatory Applicant’s admission status
EntryMode Varchar,255 Mandatory Mode of entry

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
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

(d) Response Payload

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

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>MNX</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>MAKAME</Fname>
<Mname>M</Mname>
<Surname>HAMZA</Surname>
<F4indexno>S1547/0122/2099</F4indexno>
82
<Gender>M</Gender>
<Nationality>Tanzanian</Nationality>
<DateOfBirth>1994</DateOfBirth>
<ProgrammeCategory>Masters Degree</ProgrammeCategory>
<Mobilenumber>079668866 </Mobilenumber>
<Emailaddress>[email protected]</Emailaddress>
<BachelorRegNumb>AGF/0019/11-20291</BachelorRegNumb>
<MastersRegNumb></MastersRegNumb>
<Impairment>None</Impairment>
<NationalIdNumber></NationalIdNumber>
<ProgrammeAdmitted>MMMC2 </ProgrammeAdmitted>
<AdmissionStatus>Admitted</AdmissionStatus>
<EntryMode>Bachelor degree</EntryMode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<F4indexno>S1547/0122/2099</F4indexno>
<StatusDescription> Operation was successful </StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.29 Get verification status for admitted students into Postgraduate


programmes

Web Service Method Description


Get verification status for
Download admitted students into Postgraduate programmes and their
admitted students into
verification status
Postgraduate programmes

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

(a) Request Parameters

Name i. Programme code

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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 10 Mandatory Programme code as per TCU Postgraduate
Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Status, status code and status description objects

(d) Response Payload

Attribute, Type & Length Field Format Description


StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code
f4indexno Varchar,15 Form four index number
AdmissionStatus Varchar , 255 Applicant’s admission verification status
VerificationStatusCode Varchar, 6 Applicant’s admission verification status Code

Example request

<?xml version=”1.0” encoding=”UTF-8”?>


<Request>
<UsernameToken>

84
<Username>MNX</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>MNXM01</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="UTF-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was successful</StatusDescription>
<ProgrammeCode> MNXM01</ProgrammeCode>
<Applicant>
<f4indexno>S1547/0122/2099</f4indexno>
<BachelorRegNumber>AGF/0019/11-20291</BachelorRegNumber>
<VerificationStatusCode>231</VerificationStatusCode>
<VerificationStatus>Cleared</VerificationStatus>
<StatusDescription>Has requisite qualifications</StatusDescription>
</Applicant>
</ResponseParameters>
</Response>
</xml>

3.30 Submit transferred students from one Postgraduate programme to


another within the same institution or from one institution to another

Web Service Method Description


Submit Postgraduate Submit to TCU the list of transferred students into Postgraduate
transferred students degree programmes in University Institutions. The transfer may
be from one programme to another within the same institution
or from one institution to another.

Url: https://api.tcu.go.tz/applicants/submitPostgraduateTransfers
Call method: POST

(a) Request Parameters

Name i. First name


ii. Middle name
iii. Surname
iv. Form Four index number
v. Gender

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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
Fname Varchar, 255 Mandatory Applicant first name
Mname Varchar, 255 Optional Applicant second name
Surname Varchar, 255 Mandatory Applicant surname
F4indexno Varchar, 35 Mandatory The form four index number
Gender Varchar, 6 Mandatory Applicant sex
Nationality Varchar,255 Mandatory Applicant nationality
DateOfBirth Varchar, 15 Mandatory Date of birth e.g. “28-02-1978”
ProgrammeCategory Varchar, 255 Mandatory Category of the programme an applicant is
transferring to e.g. “Masters Degree”,
“Doctorate Degree”
CurrentProgrammeCode Varchar,10 Optional The programme code an applicant is
transferring to
PreviousProgrammeCode Varchar, 10 Optional The Programme the applicant was
admitted to

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
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

(d) Response Payload

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

<?xml version="1.0" encoding="UTF-8" ?>


<Request>
<UsernameToken>
<Username>AMM</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<Fname>MAKAME</Fname>
<Mname>M</Mname>
<Surname>HAMZA</Surname>
<F4indexno>S1547/0122/2019</F4indexno>
<Gender>M</Gender>
<Nationality>Tanzanian</Nationality>
<DateOfBirth>1994</DateOfBirth>
<ProgrammeCategory>Masters Degree</ProgrammeCategory>
<PreviousProgrammeCode>AMMM01</PreviousProgrammeCode>
<CurrentProgrammeCode>HKM02</CurrentProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="utf-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<F4indexno>S1547/0122/2019</F4indexno>
<StatusDescription>Operation was successful</StatusDescription>
</ResponseParameters>
</Response>
</xml>

3.31 Get verification status for transferred students into Postgraduate


programmes

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

(a) Request Parameters

Name i. Programme code


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

(b) Request Payload

Attribute, Type & Field Format Usage Description


Length
ProgrammeCode Varchar, 10 Mandatory Programme code as per TCU Postgraduate
Guide Book

(c) Response Parameters

Name TCU Information


Direction Output
Type TCUInformationResponse
Content type
Component Type
Body Response Body Section
Contains elements
Body of the response contains the information regarding Applicant
Status, status code and status description objects

(d) Response Payload


89
Attribute, Type & Length Field Format Description
StatusCode Varchar, 50 Service status code
StatusDescription Varchar, 128 Description of status code
f4indexno Varchar,15 Form four index number
VerificationStatus Varchar , 255 Applicant’s admission verification status
VerificationStatusCode Varchar, 6 Applicant’s admission verification status Code

Example request

<?xml version="1.0" encoding="UTF-8"?>


<Request>
<UsernameToken>
<Username>MNX</Username>
<SessionToken>aTcuM3838jjKLMUOP0jL</SessionToken>
</UsernameToken>
<RequestParameters>
<ProgrammeCode>HMKM02</ProgrammeCode>
</RequestParameters>
</Request>

Example response

<?xml version="1.0" encoding="UTF-8" ?>


<Response>
<ResponseParameters>
<StatusCode>200</StatusCode>
<StatusDescription>Operation was successful</StatusDescription>
<ProgrammeCode> HMKM02</ProgrammeCode>
<Applicant>
<F4indexno>S1547/0122/2019</F4indexno>
<VerificationStatusCode>231</VerificationStatusCode>
<VerificationStatus>Cleared</VerificationStatus>
</Applicant>
</ResponseParameters>
</Response>
</xml>

4. API Resources and End Points

Resource End points Summary url

Add a single or multiple https://api.tcu.go.tz/applicants/add


add
applicant
Applicants
Resubmit Details for one https://api.tcu.go.tz/applicants/resubmit
resubmit
or multiple applicants

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 Applicant https://api.tcu.go.tz/applicants/submitPr


submitProgramme
Programme Choices ogramme

getApplicantVerifi Get Applicant’s https://api.tcu.go.tz/applicants/getApplic


cationStatus Verification Status antVerificationStatus

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

Request confirmation https://api.tcu.go.tz/dashboard/requestC


requestConfirmati
code for multiple onfirmationCode
onCode
admission student

submitInterInstitu Submit inter institutional https://api.tcu.go.tz/admission/submitInt


tionalTransfers transfers erInstitutionalTransfers
submitInternalTra https://api.tcu.go.tz/admission/submitInt
Submit internal transfers ernalTransfers
nsfers
Dashboard populate Populate Dashboard https://api.tcu.go.tz/dashboard/populate

5. Message codes and their descriptions

Code Message Message Description


200 SUCCESSFUL Operation was performed successfully.
201 PRIOR ADMISSION Applicant record was found in prior admission list.
202 CLEAR Applicant has no prior admission.

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

232 APPLICANT NOT CLEARED Applicant NOT cleared by the Commission


93
233 CONFIRMED ADMISSION IN THIS Applicant confirmed in this programme
PROGRAMME
234 CONFIRMED ADMISSION TO OTHER Applicant Confirmed to other HLI
INSTITUTION

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.

● Message components: Form4indexno, confirmation code, deadline of


confirmation and directive to confirm with one HLI only.

● 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

● In HLI systems Mobile number and email address should be


MANDATORY fields for each applicant during application phase.

b. Broadcast admission status

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)

7.2 Get Admission Status


Download the admission status of all applicants in a programme

7.3 Populate Dashboard


Upload summary of applications for statistical purposes

7.4 Add Applicant(s)


Upload applicants’ f4indexno and f6indexno

7.5 Submit Applicant Programme


PUSH applicants with their selected programmes, programme admitted to
and contact details

7.6 Resubmit Applicant(s)


PUSH applicants whose details have changed since last submission

7.7 Get Applicant Status


Fetch a list of all applicants in a given programme

7.8 Get a list of confirmed applicants


PULL a list of confirmed applicants (from those with multiple admissions)

7.9 Confirm Admission


PUSH to TCU special confirmation code entered by applicants with multiple
admissions

7.10 Unconfirm Admission


PUSH to TCU applicants who chose to reject their admission

7.11 Request Confirmation Code


PUSH to TCU applicant who request to confirmation code.

7.12 Cancel/ Reject Admission


PUSH to TCU applicant who request to cancel/reject his admission at your
institution.

7.13 Submit inter institutional transfers


PUSH to TCU applicant who request to transfer from another institution to
tour institution.

7.14 Submit internal transfers


PUSH to TCU applicant who request to transfer from one programme to
another within your institution.

7.15 Get Applicant’s Verification Status


95
PULL the list of applicants with their status after TCU verification per
programme

7.16 Get Programmes


PULL a list of programme codes for programmes with selected applicants.

7.17 Submit enrolled/registered students


Submit to TCU the list of registered/enrolled students into a programme of
study in the academic year.

7.18 Submit graduates


Submit to TCU the list of graduates in the graduation year. This endpoint is
used to submit graduates for all programmes from Certificate to PhD from
university institutions and Bachelor and Postgraduate graduates from Non-
University institutions.

7.19 Submit Institution Staff


Submit to TCU the list of both academic and administrative staff

7.20 Get verification status for internally transferred students


Download applicants who have requested for internal transfers and their
TCU verification status

7.21 Get verification status for inter-institutional transferred students


Download applicants who have requested for inter-institutional (from one
institution to another) transfers and their TCU verification status

7.22 Restore cancelled admission


Restore admission for applicants who previously cancelled their admissions

7.23 Submit students drop-outs


Add/Submit to TCU students who dropped their studies

7.24 Submit students who postponed studies


Submit/add students who postponed studies in the current academic year

7.25 Submit admitted students into non-degree programmes


Add students admitted into non-degree programmes (Certificates, Diplomas
or Foundation Programme)

7.26 Get verification status for non-degree admitted students


Download admitted students into non-degree programmes and their
verification statuses

7.27 Submit applicants applied for Postgraduate programmes


Submit to TCU the list of applicants applied for Postgraduate programmes in
University institutions

7.28 Submit admitted students into Postgraduate programmes


Submit to TCU the list of admitted students into Postgraduate programmes
in University institutions

96
7.29 Get verification status for admitted students into Postgraduate programmes
Download admitted students into Postgraduate programmes and their
verification statuses

7.30 Submit transferred students from one Postgraduate programme to


another within the same institution or from one institution to another
Submit to TCU the list of admitted students into Postgraduate programmes
in University institutions

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

You might also like