Billiecart API

<back to all web services

AssignRolesRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/users/{Id}/roles/assign
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AssignRolesRequest : PostOperationUnTenanted<AssignRolesResponse>()
{
    var id:String? = null
    var roles:ArrayList<String> = ArrayList<String>()
}

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class AssignRolesResponse
{
    var responseStatus:ResponseStatus? = null
    var userAccount:UserAccount? = null
}

open class UserAccount : IIdentifiableResource
{
    var name:UserAccountName? = null
    var displayName:String? = null
    var email:String? = null
    var roles:ArrayList<String> = ArrayList<String>()
    var status:AccountStatus? = null
    var defaultOrganisationId:String? = null
    var id:String? = null
}

open class UserAccountName
{
    var firstName:String? = null
    var lastName:String? = null
}

enum class AccountStatus
{
    Shadowed,
    Registered,
}

Kotlin AssignRolesRequest 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 /users/{Id}/roles/assign HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	roles: 
	[
		String
	]
}
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
		}
	},
	userAccount: 
	{
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		email: String,
		roles: 
		[
			String
		],
		status: Shadowed,
		defaultOrganisationId: String,
		id: String
	}
}