Organization Widget

Last updated 7 months ago

API for Organization Widget object

get
Organization Widget List
{{ base_url }}
 /organizations/organizationwidget/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
Headers
token
required
string
​
200: OK
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "icon": "xxx",
            "name": "xxx",
            "notes": "xxx",
            "price": "Free",
            "show_in_menu": false,
            "order": 1,
            "change_permission": true
        },
        ...
    ]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable
post
Organization Widget List
{{ base_url }}
 /organizations/organizationwidget/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
detail
Headers
token
required
string
​
Form Data Parameters
widget__sid
required
string
​
show_in_menu
optional
string
​
201: Created
{
    "sid": "xxx",
    "icon": "xxx",
    "show_in_menu": false,
    "updated_by": 1,
    "date_updated": "2018-05-10T18:35:05.841179Z",
    "date_created": "2018-05-10T18:35:05.833059Z"
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable
delete
Organization Widget List
{{ base_url }}
 /organizations/organizationwidget/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
Headers
token
required
string
​
Query Parameters
widget__sid
optional
string
​
204: No Content
{}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable
Missing required parameter: widget__sid
get
Organization Widget Detail
{{ base_url }}
 /organizations/organizationwidget/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
200: OK
{
    "sid": "xxx",
    "icon": "xxx",
    "show_in_menu": false,
    "updated_by": 1,
    "date_updated": "2018-05-10T18:35:05.841179Z",
    "date_created": "2018-05-10T18:35:05.833059Z"
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
delete
Organization Widget Detail
{{ base_url }}
 /organizations/organizationwidget/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
204: No Content
{}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct

Team

Statement

Organization Widget

getOrganization Widget List

postOrganization Widget List

deleteOrganization Widget List

getOrganization Widget Detail

deleteOrganization Widget Detail

get
Organization Widget List

post
Organization Widget List

delete
Organization Widget List

get
Organization Widget Detail

delete
Organization Widget Detail