POST (Header:DELETE) api.ashx/v2/roles/{roleid}.{json|xml}
DELETE a role.
Scopes
Security(Roles and Permissions) › Modify Roles security.roles.modify
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Include | string | Options for include are: user. Ex: include=user. | Optional | |||
RoleId | int | Role Id | Required | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.del({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/{roleid}.json', data: { 'roleid': '6' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>
POST (Header:DELETE) api.ashx/v2/roles/{roleid}/user/{userid}.{json|xml}
DELETE Remove a user from a role.
Scopes
Users › Modify Role Users users.roles.modify
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Include | string | Options for include are: user. Ex: include=user. | Optional | |||
RoleId | int | Role Id | Required | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.del({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/{roleid}/user/{userid}.json', data: { 'roleid': '6', 'userid': '6' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>