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
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserAccountName() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set

    type AccountStatus =
        | Shadowed = 0
        | Registered = 1

    [<AllowNullLiteral>]
    type UserAccount() = 
        member val Name:UserAccountName = null with get,set
        member val DisplayName:String = null with get,set
        member val Email:String = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Status:AccountStatus = new AccountStatus() with get,set
        member val DefaultOrganisationId:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type AssignRolesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val UserAccount:UserAccount = null with get,set

    [<AllowNullLiteral>]
    type AssignRolesRequest() = 
        inherit PostOperationUnTenanted<AssignRolesResponse>()
        member val Id:String = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# 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
	}
}