Organization Widget

Method & Permission

API	GET	POST	PUT	PATCH	DELETE
Organization Widget List	Admin, Member	Admin	-	-	-
Organization Widget Detail	Admin, Member	-	-	Admin *	Admin

*Can only change is_archivedfield.

GET Organization Widget List

Endpoint: /organizations/organizationwidget/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": 9,
    "count": 81,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "ehkn0a40x1glqvAFKP",
            "name": "Plain Text"
        },
        ...
    ]
}

# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 9,
    "count": 81,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "is_archived": false,
            "change_permission": true
        },
        ...
    ]
}

# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 9,
    "count": 81,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xx",
            "is_archived": false,
            "updated_by": "xxx",
            "date_updated": "2020-02-10T03:02:28.525127Z",
            "date_created": "2020-02-10T03:02:28.523525Z",
            "change_permission": true
        },
        ...
    ]
}

POST Organization Widget List

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

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Parameter: widget (body, object)

Response: 201

{
    "sid": "xx",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:28.525127Z",
    "date_created": "2020-02-10T03:02:28.523525Z",
    "change_permission": true
}

Response: 406

- Error: Invaid widget sid!
- Error: the widget is not available for your organization!

GET Organization Widget Detail

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

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 200

{
    "sid": "xx",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:28.525127Z",
    "date_created": "2020-02-10T03:02:28.523525Z",
    "change_permission": true
}

DELETE Organization Widget Detail

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

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 204

{}