PUSL3111 API Software Development Course Work

This document outlines the coursework requirements for the API Software Development module. Students must develop a RESTful API application and accompanying report. The API aims to help track citizens' locations and COVID test results to facilitate contact tracing. It must allow registration, location updates, test result updates, account deactivation, and viewing citizen contacts. The report must document the API, tools used, individual contributions, and certificates of completed online courses. Academic integrity and assessment criteria are also covered.

Uploaded by

Aishwarya

Available Formats

Download as DOCX, PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

80 views

PUSL3111 API Software Development Course Work

Uploaded by

Aishwarya

Available Formats

Download as DOCX, PDF, TXT or read online on Scribd

You are on page 1/ 5

API Software Development

PUSL3111

Coursework
2020–2021

Term: Term 2
Submission Deadline: 23rd April 2021
Coursework Type: Group Assignment
Element of Assessment: C1
Module Leader: Dr. Rasika Ranaweera
E-mail: [email protected]

Coursework 2020/2021 1
Coursework
This coursework for PUSL3111 is worth 60% of the module marks and contains two
deliverables: A working API web application and a report. You may form in to groups of
maximum six members by yourself and enroll the groups in the DLE.

A scenario for the project

Center for Disease Control and Prevention (CDC) is the main body in managing the
pandemic situations such as COVID-19 in Sri Lanka. With the help of the ministry of health
and Public Health Inspectors (PHI) the CDC is planning to establish an internet service where
the citizens can report their locations when they are moving one place to another. CDC
hired you to develop a web API which can facilitate the below requirements.
i. Any citizen can become a member through a free online registration.
ii. The citizens must update their current location when they travel by scanning a QR
code at every super market, food outlets, schools, etc.
iii. The PHI officers monitor the citizens and update the PCR or Antigen test results for
each individual.
iv. The immediate contacts of the COVID positive patients are then traced by the CDC.
Deliverable 1

Develop a RESTful API web application to address the above scenario. You should alter the
path examples below according to the situation (e.g.: just like adding members [or in other
words registering themselves]) but all the functional requirements must be satisfied.
According to the scenario you should also suggest then implement APIs to address item (i)
to (iv).

Minimal Required APIs

 POST /citizens
Citizens and PHIs can register themselves with details including a national ID, name,
age, address, current location (latitude and longitude), profession, email, affiliation,
password, health status, etc.
 GET /citizens/:nid
PHI or CDC officers can collect the details of any citizen.
 PUT /citizens/:nid

Coursework 2020/2021 2
Individual citizens should be able to update their current locations.
 PUT /citizens/:nid
While the PHIs should be able to update the citizen’s health status (such as COVID
positive or negative, deceased, recovered, etc.)
 DELETE /citizens/:nid
The CDC staff can deactivate an individual’s account if the patient is deceased.
 GET /citizens/:nid/contacts
The CDC staff should be able to collect information about contacts of any citizen.

It is very important that your APIs work, the public interfaces you create should conform to
industry good practices (security, paging, documentation, ease of understanding, etc.) for
creating web APIs. The web API should be developed using Java, C#, PHP, React JS, or Ruby
on Rails. The interface must use the REST architecture and deliver the data in both XML and
JSON formats. You must also develop two example client applications, a mobile app and
any other client such as a web application, standalone application, etc. that consume your
own API.

Deliverable 2
Write a comprehensive report containing documentation for your API, tools and
technologies, individual contributions, and certificates. You must also include the controller
classes as an appendix of the report.

API Documentation
List down all the APIs in your project including the routes, parameters, and a
description. For each and every method there must be supporting evidence such as
screenshots of code and run-time results.
Tools & Technologies
Discuss why you have selected your platform and how you have tested your APIs
before releasing to public.
Individual Contribution
Each and every member should write a full page of his/her contribution. All
members must contribute development of the API. All members should attach
evidence of the LinkedIn certificates/screenshots.

Coursework 2020/2021 3
Detailed Assessment Criteria
Category and Criteria Marks LOs
Weighting
API  API implemented and presented with appropriate 40
Implementation documentation [implementing only the minimal
60% requirement results half of the marks offered 40/2].
 Design clearly illustrated within the website 20
documentation and clearly evident in architecture.
 Developer resources for API conform to industry good 10 LO2
practice.
 Source code runs with test data. 05
 Data is inserted, edited and retrieved from the MySQL or 15
any other database.
 API conforms to RESTful principles 10
Evaluation Report  Style of report is clear, professional and has a logically 20
30% developed thread of argument throughout.
 Appropriate academic and industry literature is used to 20
support discussion. LO1
 Client application, tools & technique used for evaluation 30 LO3
clearly described and illustrated.
 Proper APIs documentation 30
LinkedIn  Each and every member should follow the course
Certificate "Introduction to Web APIs by: Andrew Probert" in LinkedIn 100 LO1
10% Learning Center. LO2
 https://www.linkedin.com/learning/introduction-to-web- LO3
apis/filter-response-with-parameters?u=26140778
 The marking is based on the following criteria:
o Certificate: 100%
o No certificate, but completed the course: 80%
o No certificate, incomplete, but tried the
course: 25%
o None: 0%
 You must attach evidence such as a certificate or screen
shot of the course progress.

Academic offences:

(the following is a fragment of Section AST10.2 from

https://www.plymouth.ac.uk/uploads/production/document/path/8/8388/Section_D_Assessment.pdf )

Academic offences occur when activity is undertaken which could confer an unfair
advantage to any candidate(s) in assessment. The University recognises the following
(including any attempt to carry out the actions described) as academic offences, regardless
of intent:
a) Copying or paraphrasing of other people’s work or ideas into a submitted
assessment without full acknowledgement (plagiarism).
b) Unauthorised collaboration of students (or others) in a piece of work (collusion).
c) Making false declarations in an attempt to obtain either modified assessment
provisions or special consideration (e.g. of extenuating circumstances).

Coursework 2020/2021 4
d) Persuading another member of the University or partner institution (student, staff, or
other) to participate in any way in actions which would be in breach of these
regulations.
e) Misrepresenting research outcomes and results.
f) Being party to any arrangement which would constitute a breach of these regulations.
g) The inclusion in a piece of assessed work (other than an examination or test) of
material which is identical or substantially similar to material which has already been
submitted for any other assessment within the University.
h) Any other activity which could confer an unfair advantage to any candidate(s).

For full details on the academic offences framework and procedures, consult Section AST10
from
https://www.plymouth.ac.uk/uploads/production/document/path/8/8388/Section_D_Assessm
ent.pdf

Submission Type
The report should be a PDF (preferred) or Word document. A zip file containing project work
and the report should be uploaded to the Plymouth Digital Learning Environment (DLE).

Coursework 2020/2021 5