regis

<back to all web services

UserRoleUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/UserRoles/{uuid}/Update
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class UserRoleUpdateRequest
            Public Sub New()
                role_ids = New List(Of Integer)
            End Sub

            Public Overridable Property uuid As String
            Public Overridable Property authorizing_uuid As String
            Public Overridable Property admin_auth_secret As String
            Public Overridable Property is_staff As Boolean
            Public Overridable Property role_ids As List(Of Integer)
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class UserRoleResponse
            Public Sub New()
                roles = New List(Of String)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property regent_login As String
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property email As String
            Public Overridable Property is_staff As Boolean
            Public Overridable Property roles As List(Of String)
        End Class
    End Namespace
End Namespace

VB.NET UserRoleUpdateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /UserRoles/{uuid}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	authorizing_uuid: String,
	admin_auth_secret: String,
	is_staff: False,
	role_ids: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	regent_id: 0,
	uuid: String,
	regent_login: String,
	first_name: String,
	last_name: String,
	email: String,
	is_staff: False,
	roles: 
	[
		String
	]
}