ip-project-api's People
ip-project-api's Issues
[SERVICE] Institution Creation
Priority : I
Type : POST
Input :
- User Credentials
- Username
- Password
- Institution Name
- Institution Address (Object described below)
Address is a json object
Address : { Country : ... Region : ... City : ... Street : ... Number : ... Building : ... Floor : ... Apartment : ... (or Office, not yet determined) }
Output : "status" : "...", "error" : "..."
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Institution_Creation_Service.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/Create%20Institution.pdf
[SERVICE] Retrieve Institution Information
Priority : III
Type : GET
Input :
- Account Credentials
- Username
- Password
- Institution Name
Output : response : status = ... , error = ... , InstitutionInformation = ...
InstitutionInformation : { Name : ... Addresses : [addr1, addr2, .... , addrn] }
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Retrieve_Institution_Information.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/RetrieveInstitutionInformation.pdf
[CLASSES] Password Salting
[DEVOPS][DATABASE] Add Institution_Address Main_Address Column
[SERVICE] Newsfeed Post Modification Service - Sergiu
[SERVICE] Institution Edit Information
Priority : II
Type : POST
Input :
- Account Credentials
- Username
- Password
- Institution Name
- new Institution Info (new addresses, new name etc. )
Output : "status" : "...", "error" : "..."
[Admin only function]
Edit Institution Information
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Edit_Institution_Information.jpg
Documentation : TBD
[DEVOPS][DATABASE] Roles Table
Rows Table
Add Column Role ID to inst_members
[SERVICE] Account Email Activation
Source Location : https://github.com/SergiuDeveloper/IP-Project-API/tree/Services/Services/EndPoints/AccountActivation
Priority : I
Type : GET
Input : activationKey
Output : response (json) : "status" : "...", "error" : "..."
Flow : TBD
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/AccountActivation.pdf
[SERVICE] User Validation(Credentials + Institution Action Required Rights) Helper Class - Sergiu
[DOCUMENTATION] Create documentation for the whole API( phpdoc )
[SERVICE] Create Institution Role
Priority : I
Type : POST
Input :
- User Credentials
- Username
- Password
- Institution Name
- Role Name
Output : response : stauts :... , error: ....
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution_Role/Create_Role_Service.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/Create%20Institution%20Role.pdf
[DEVOPS][DATABASE] Application Admin Column
[DEVOPS] Production Scripts : SecuritySettings Script - Sergiu
Script containing security settings for production.
[SERVICE] Edit Institution Role
Priority : II
Type : POST
Input :
- User Credentials
- Username
- Password
- Institution Name
- Role Name
- Rights : list, Right = String? TBD
Output : response = status : ... , error : ...
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution_Role/Edit_Role_Service.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/Edit%20Institution%20Role.pdf
[QA] S2 Services Test Units
[DATABASE] Add Newsfeed tables in the DB initialization script - Sergiu
[DEVOPS] Azure Mailing Service Integration
[QA] Login Service Testing
Service Location :
https://fiscaldocumentseditest.azurewebsites.net/LoginEndPoint.php
Exemplu Functional :
https://fiscaldocumentseditest.azurewebsites.net/LoginEndPoint.php?username=usertest1&hashedPassword=plmcoaie
<<<<< IN VIITOR, ERORILE SI SUCCES-UL VOR EXISTA IN DOCUMENTATIE SI/SAU VOR FI ADAUGATE CA SI ISSUE DE DEVELOPER-UL SERVICIULUI >>>>>
Response :
- 'status' = 'success'/'failed'
- 'error' = '...eroare...' (mai jos se afla)
Erori :
- REQUEST_NOT_FOUND, HTTP Code : 400, Cause : Request-ul nu e GET
- BAD_USERNAME_PASS, HTTP Code : 400, Cause : Inputul serviciului (pe link) e invalid (nu are user sau pass)
- DATABASE_FAILED, HTTP Code : 200, Cause : A crapat baza de date, exceptie interna
- WRONG_PASSWORD, HTTP Code : 200, Cause : A gasit user-ul, parola e gresita
- USER_NOT_FOUND, HTTP Code : 200, Cause : Nu a gasit user-ul in baza de date
- USER_INACTIVE, HTTP Code : 200, Cause : User, Pass corect, User-ul nu e activat
Success :
- response = success, HTTP Code : 200, User, Pass corect, User activ
[SERVICE] Institution Edit Member Role
Priority : III
Type : POST
Input :
- Account Credentials
- Username
- Password
- Institution Name
- Member whose role is to be edited ( Username )
- New Role given ( Role Name )
Output : "status" : "...", "error" : "..."
[Admin only function]
Sets the rights of a selected member within the institution
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Edit_Member_Institution_Role.jpg
Documentation : TBD
[DATABASE] Debate and add DB indexes - All Team Members
Based on the operations that are going to be performed on the API endpoints, add DB indexes.
[SERVICE] Newsfeed Create Event Service
Priority : II
Type : POST
Input :
- name of notification
- link
- grouping tags
Output : response (json) : "status" : "...", "error" : "..."
Flow:
https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Newsfeed/NewsfeedListRetrievalService_Flowchart.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/NewsfeedCreatePostDocumentation.pdf
[SERVICE] Account Information Modification Service
Source Location: https://github.com/SergiuDeveloper/IP-Project-API/tree/Services/Services/EndPoints/ModifyAccountData
Priority : II
Type : POST
Input :
- username
- currentPassword
- newPassword
- newFirstName
- newLastName
Leave NULL for new fields if no modifications apply
Output : response : "status" : "...", "error" : "..."
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Account/Update_Account_Information_Service_Flowchart.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Modify_Account_Data_Service_Documentation.pdf
[SERVICE] Newsfeed Rights
[SERVICE] Retrieve Member's Institutions
Priority : II
Type : GET
Input :
- Credentials
- Username
- Password
Output : "status" : "...", "error" : "...", list
Institution: { InstitutionName : ... Role : ... }
Get List of Institutions a given member is a part of (with roles in each inst)
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Retrieve_User_Institutions_Service.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/RetrieveMembersInstituitons.pdf
[DEVOPS] Cloud Document Storage Research (prep for S3)
Priority : II
Gather, present and debate information related to:
-
Cloud service which will be used
-
How to store documents on cloud (RAW data)
-
Additional views available for documents and whether or not to keep them on cloud
-
Any other relevant information
-
Will be discussed after the completion of Priority I issues.
[SERVICE] Login Service
Source Code: https://github.com/SergiuDeveloper/IP-Project-API/tree/Services/Services/EndPoints/Login
Priority : I
Type : GET
Input : username / email, password ( hashed )
Output : response (json) : "status" : "...", "error" : "..."
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Account/Login_Service_Flowchart.jpg
Documentation:
https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Login_Service_Documentation.pdf
[SERVICE] Institution Add Member
Priority : I
Type : POST
Input :
- Account Credentials
- Username
- Password
- Institution ( to which member will be added)
- Username or Email (of the added member -> check will be done in PHP, look for @)
- Rights given to added member (serialized array / flags string(not friendly) / json )
Output : "status" : "...", "error" : "..."
Set a given user as an employee of a given institution
[REQUIRES CAN_ADD_MEMBERS RIGHT]
Documentation : TBD
[SERVICE] Retrieve All Institutions
Priority : III
Type : GET
Input :
- Account Credentials
- Username
- Password
- number of institutions to fetch
Output : status = ... , error = .... , list= ...
Institution : { Name = ... other data? }
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Retrieve_All_Institutions_Service.jpg
Documentation : TBD
[SERVICE] Retrieve Institution Roles
Priority : I
Type : POST
Input :
[Used in edit roles or assign roles -> Admin Role required]
- User Credentials
- Username
- Password
- Institution Name
Output : response : stauts :... , error: .... , roles = String[]
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution_Role/Retrieve_Institution_Roles_Service.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/RetrieveInstitutionRoles.pdf
[DOC] Login Service Documentation
[DOC] Email Activation Documentation
[DEVOPS] API Web Hosting Research - Sergiu
[CLASS] API PHP Database Manager Helper Class - Sergiu
[QA] Automation Testing Server
- Backwards Compat
[SERVICE] Newsfeed List Retrieval Service
Priority: II
Type: GET
Input:
- username: string
- hashed_password: string
- posts_count: int
Output:
- status: string
- error: string
- posts: List
Post = {
Title: string,
Content: string,
URL: string,
DateCreated : string
Tags: [
{Title : string},
{Title : string},
...
{Title : string}
]
};
Tags can be :
- News
- Updates
- Tweets
- Reminders
- Events
Flow: TBD
[SERVICE] Institution Deletion
Priority : II
Type : POST
Input :
- Account Credentials
- Username
- Password
- Institution Name
Output : "status" : "...", "error" : "..."
Removes a given institution and deletes links to employees
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Delete_Institution_Service.jpg
Documentation : TBD
[SERVICE] Newsfeed Post Removal Service
Priority : III
Type : POST
Input :
- Name of the Post
- Username (caller)
Output : Response : "status" : "...", "error" : "..."
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/DeleteNewsfeedPost.pdf
[DOCUMENTATION] [DATABASE] DB Diagrams - UML - Sergiu
[SERVICE] Delete Institution Role
Priority: II
Type : POST
Input:
- User Credentials
- Username
- Password
- Institution Name
- Role Name
Output : response = status : ... , error = ....
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution_Role/Delete_Role_Service.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Institution/Institution%20Remove%20Role.pdf
[CLASS] Common Logic Helper Classes/Code refactorization - Sergiu
[QA] Node.JS Unit Testing
[SERVICE] Institution Remove Member
Priority : II
Type : POST
Input :
- Credentials
- Username
- Password
- Institution Name
- Member to be removed ( Username )
Output : "status" : "...", "error" : "..."
[Admin only function]
Remove a member from the institution
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Remove_Member_From_Institution.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/InstitutionRemoveMember.pdf
[DATABASE] Add Newsfeed tables in the DB UML - Sergiu
[DEVOPS] Configure Azure MySQL Server and the API user - Sergiu
[QA] S3 Services Test Units
[LEARNING] [QA] Fiddler hosted API POST
[SERVICE] Institution Retrieve Members
Priority : I
Type : GET
Input :
- Account Credentials
- Username
- Password
- Institution Name
Output : "status" : "...", "error" : "...", json of list (below def of member)
member : { Username : ... Role : ... }
Returns all members from a given institution
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/InstitutionRetrieveMembers.pdf
[DATABASE] DB Initialization Script - Sergiu
[SERVICE] Account Creation Service
Source Code : https://github.com/SergiuDeveloper/IP-Project-API/tree/Services/Services/EndPoints/AccountCreation
Priority : I
Type : POST (Pe chart e GET)
Input :
- Username
- Hashed_Password
- First_Name
- Last_Name
Output : response (json) : "status" : "...", "error" : "..."
Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Account/Account_Creation_Service_Flowchart.jpg
Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/AccountCreationServiceDoc.pdf
[LEARNING] PHP + Web Services + MySQL PDO Connection + Prepared Statements
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.