Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Overview

Every user need to Accept the terms and conditions in order to access the portal:

  • Case 1: Existing user, will be flagged with terms & conditions flag will be set to false.
  • Case 2: Whenever a new user registers his terms&conditions flag will be set to false.
  • Case 3: When the terms & conditions are changed - all the affected user's terms&conditions flag will be set to false.

After login, we will detect - if user needs to accept the terms of condition - in either of above cases, we will present him with screen to accept the same.

Applicability/configuration of terms and conditions will be based on chosen approach.


Approach 1:

We can have Terms & Conditions definition per installation.

In this case a simple table will be created:

Column NamePurpose
tacIdPrimary key of the table, auto-generated
tacStatus

boolean

true means in force,

false - means past

tacContenthtml content
tacUpdatedDatedatetime - when terms and condition was last updated
tacUpdatedByuser- who updated it for last time


When user updates the terms and conditions

  • a new row will be inserted with content as well as date/user/status
  • old row status will be marked to false.
  • flag in user table for terms & conditions will be marked to false.


Approach 2:

We can create terms & conditions per channel basis.

In this case - we just need one more column - which stores the channel for which terms and conditions is applicable.

When user updates the terms and condition

  • a new row will be inserted with content as well as date/user/status/channel
  • old row status will be marked to false for the given channel
  • flag in user table for terms & conditions will be marked to false based on channel value.


API

POST /v1/update/terms

{
  "request": {
    "termsAndConditions": "<html> content</html>",
    "channel": "channel-id"
  }
}

Response

200 OK - Terms updated successfully

400 Bad Request - Request validation - empty Terms And Conditions

403 Forbidden - if user is not org admin


POST /v1/accept/terms

Empty Request body

Response

200 OK - Success

401 Unauthorized - Unauthorized access.

If called without user-token


Approach 3:

We can create terms & conditions manually and inserts the version information in system settings.

When user updates the terms and condition

  1. A new row will be inserted in the TAC table 
  2. We have to update the latest version of tac in system setting table


DB changes 

  • We need to create TAC table which will contain column →  id, version, content, created on, created by, updated on, updated by
  • We need system setting  which contains the latest version id of TAC
  • We need to add ( tacStatus, tacAcceptedDate, tacVersionId) columns in user table and we can drop (tcstatus,    tcupdateddate) as we are not using them 




We will create 2 api's

  1. Accept TAC  
    POST /v1/tac/accepts/
    {
  "request": {
        "tacVersion":"v1",
    "userId": "userId",
        "status": true
  }
}


     2. Get TAC

        GET /v1/tac/read 

Response

200 OK - Terms updated successfully

400 Bad Request - Request validation - invalid userId or invalid tacVersion



  • No labels