Organization Widget

API for Organization Widget object

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.

Organization Widget List

GET {{ base_url }} /organizations/organizationwidget/list/{level}/{sid}/{serializer}/

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string

Headers

Name	Type	Description
token	string

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
        },
        ...
    ]
}

Organization Widget List

POST {{ base_url }} /organizations/organizationwidget/list/{level}/{sid}/{serializer}/

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string

Headers

Name	Type	Description
token	string

Request Body

Name	Type	Description
widget	object

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
}

406

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

Organization Widget Detail

GET {{ base_url }} /organizations/organizationwidget/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

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
}

Organization Widget Detail

DELETE {{ base_url }} /organizations/organizationwidget/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

204

{}