sergiudeveloper / ip-project-api Goto Github PK

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

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

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

Rows Table
Add Column Role ID to inst_members

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

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

Script containing security settings for production.

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

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

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

Based on the operations that are going to be performed on the API endpoints, add DB indexes.

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

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

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

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.

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

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]

Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Institution_Add_Member.jpg

Documentation : TBD

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

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

https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/Login_Service_Documentation.pdf

• Backwards Compat

Priority: II

Type: GET
Input:

1. username: string
2. hashed_password: string
3. posts_count: int

Output:

1. status: string
2. error: string
3. 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

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

Source : https://github.com/SergiuDeveloper/IP-Project-API/tree/Services/Services/EndPoints/DeleteNewsfeedPost

Priority : III
Type : POST
Input :

• Name of the Post
• Username (caller)

Output : Response : "status" : "...", "error" : "..."

Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Newsfeed/Newsfeed_Post_Removal_Service_Flowchart.jpg

Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/DeleteNewsfeedPost.pdf

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

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

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

Flow : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Flows/Service/Institution/Retrieve_Institution_Members_Service.jpg

Documentation : https://github.com/SergiuDeveloper/IP-Project-API/blob/Design/Documentation/Services/InstitutionRetrieveMembers.pdf

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
• Email
• 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