Member
Method & Permission
| API | GET | POST | PUT | PATCH | DELETE |
|---|---|---|---|---|---|
| Member List | Admin, Project Admin, Project Edit, Project View | Admin, Project Admin | - | - | - |
| Member Detail | Admin, Project Admin, Project Edit, Project View | - | - | Admin, Project Admin | Admin, Project Admin |
GET Project Member List
Endpoint: /projects/member/list/{level}/{sid}/{serializer}/
Parameter: level (path, string)
organization
Parameter: sid (path, string)
organization sid
Parameter: serializer (path, string)
Parameter: token (header, string)
Parameter: project__sid (query, string)
Response: 200
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 3,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx"
},
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 3,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
},
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 3,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
},
]
}
POST Project Member List
Endpoint: /projects/member/list/{level}/{sid}/{serializer}/
Parameter: level (path, string)
organization
Parameter: sid (path, string)
organization sid
Parameter: serializer (path, string)
Parameter: token (header, string)
Parameter: project__sid (query, string)
Parameter: member (body, array)
Parameter: team (body, array)
Parameter: permission (body, string)
Parameter: is_archived (body, string)
Response: 201
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
}
GET Project Member Detail
Endpoint: /projects/projectmember/detail/{sid}/
Parameter: sid (path, string)
Parameter: token (header, string)
Response: 200
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
}
PATCH Project Member Detail
Endpoint: /projects/projectmember/detail/{sid}/
Parameter: sid (path, string)
Parameter: token (header, string)
Parameter: team (body, object)
Parameter: member (body, object)
Parameter: permission (body, string)
Parameter: is_archived (body, boolean)
Response: 200
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
}
DELETE Project Member Detail
Endpoint: /projects/projectmember/detail/{sid}/
Parameter: sid (path, string)
Parameter: token (header, string)
Response: 204
{}