Team

Method & Permission

API	GET	POST	PUT	PATCH	DELETE
Team List	Admin	Admin	-	-	-
Team Detail	Admin	-	-	Admin	Admin

GET Team List

Endpoint: /organizations/team/list/{level}/{sid}/{serializer}/

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Response: 200

# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx"
        }
    ]
}

# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx",
            "description": "Admin group to manage the Labii account.",
            "is_archived": false,
            "change_permission": true
        }
    ]
}

# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx",
            "description": "Admin group to manage the Labii account.",
            "members": [
                {
                    "sid": "xxx",
                    "name": "xxx"
                },
            ],
            "is_archived": false,
            "change_permission": true
        }
    ]
}

POST Team List

Endpoint: /organizations/team/list/{level}/{sid}/{serializer}/

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Parameter: name (body, string)

Parameter: description (body, string)

Parameter: is_archived (body, string)

Parameter: members (body, array)

array of organization personnel sid

Response: 201

{
    "sid": "xxx",
    "name": "xxx",
    "description": "Admin group to manage the Labii account.",
    "members": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ],
    "is_archived": false,
    "change_permission": true
}

GET Team Detail

Endpoint: /organizations/team/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 200

{
    "sid": "xxx",
    "name": "xxx",
    "description": "Admin group to manage the Labii account.",
    "members": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ],
    "is_archived": false,
    "change_permission": true
}

PATCH Team Detail

Endpoint: /organizations/team/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Parameter: name (body, string)

Parameter: description (body, string)

Parameter: members (body, array)

Parameter: is_archived (body, boolean)

Response: 200

{
    "sid": "xxx",
    "name": "xxx",
    "description": "Admin group to manage the Labii account.",
    "members": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ],
    "is_archived": false,
    "change_permission": true
}

DELETE Team Detail

Endpoint: /organizations/team/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 204

{}