POST api/v7/Roles
Add a new role
Tables Impacted
webpages_Roles
Request Information
URI Parameters
None.
Body Parameters
The Code and Name of a new role
Role| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| roleCode * |
Unique code for user role |
string |
Conditional |
Conditionally required: If adding/updating a role from Role API, this is required. String length: between 1 and 64, inclusive |
| roleName * |
Name of the role |
string |
Conditional |
Conditionally required: If adding/updating a role from Role API, this is required. String length: between 1 and 255, inclusive |
| customerAuditDate |
Last modified audit information |
date |
No |
None. |
Request Formats
application/json, text/json
Sample:
{
"roleCode": "100",
"roleName": "admin",
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
Sample:
<Role xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <roleCode>100</roleCode> <roleName>admin</roleName> <customerAuditDate>2018-01-01T00:00:00</customerAuditDate> </Role>
Response Information
Resource Description
Returns a HTTPResponse Message stating the success/failure of API Action
HttpResponseMessage| Name | Description | Type |
|---|---|---|
| Version | Version | |
| Content | HttpContent | |
| StatusCode | HttpStatusCode | |
| ReasonPhrase | string | |
| Headers | Collection of Object | |
| RequestMessage | HttpRequestMessage | |
| IsSuccessStatusCode | boolean |