greenhr's Issues
Entity: Group
About
The group is a collection of organisation members.
Use case
As an organisation admin, I want to:
- create group.
- list various groups in organisation.
- List all details about a group
Create Group
Method: POST
Endpoint: /organizations/:id/groups
Response: 201 + payload / 400 + message
Payload
name: "Engineering"
count: 23
GET Group
Method: GET
Endpoint: /organizations/:id/group/:id
Response: 200 + payload / 404 + message
Response
id: 9
name: Engineering
type: group
created_at: 2017-01-14T04:33:35Z
updated_at: 2017-11-18T04:33:35Z
GET Groups
Method: GET
Endpoint: /organizations/:id/groups
Response: 200 + payload / 404 + message
Response
groups:
- obj
- obj
- obj
Entity: Organisation
About
The Organization entity holds information about an organization.
Use case
As an owner, I want to:
- create an Organization
- get information about a specific Organization
- get a list of organizations
Create Organization
Method: POST
Endpoint: /organizations/
Response: 201 + payload / 400 + message
Payload
name: "My awesome organization"
admin: [user1, user2, ... ]
GET Organization
Method: GET
Endpoint: /organizations/:id
Response: 200 + payload / 404 + message
Response
id: 2
name: "My awesome organization"
type: organization
created_at: 2017-01-14T04:33:35Z
updated_at: 2017-11-18T04:33:35Z
GET Groups
Method: GET
Endpoint: /organizations
Response: 200 + payload / 404 + message
Response
organizations:
- organization obj
- organization obj
- organization obj
Entity: User
About
The User entity holds data corresponding to a person belonging to an Organization.
Use case
As an Organisation admin, I want to:
- create a User.
- get a specific user's information.
- get a list of all the Users in an Organization.
Create User
Method: POST
Endpoint: /organizations/:id/users
Response: 201 + payload / 400 + message
Payload
username: bassam
site_admin: false
name: "Bassam Ismail"
email: "[email protected]"
password: ******
GET User
Method: POST
Endpoint: /organizations/:id/users/:id
Response: 200 + payload / 404 + message
Response
username: bassam
id: 9
type: user
site_admin: false
name: "Bassam Ismail"
organization_name: "CRM TOOL"
organization: 2
avatar_url: "s3.bucket_id.amazon.com/skippednote.png"
email: [email protected]
created_at: 2017-01-14T04:33:35Z
updated_at: 2017-11-18T04:33:35Z
GET Users
Method: GET
Endpoint: /organizations/:id/users
Response: 200 + payload / 404 + message
Response
users:
- user1 obj
- user2 obj
- user3 obj
Setup CI for build and deployment
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.