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 Foundation
import ServiceStack

public class AssignRolesRequest : PostOperationUnTenanted<AssignRolesResponse>
{
    public var id:String?
    public var roles:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case roles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        roles = try container.decodeIfPresent([String].self, forKey: .roles) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if roles.count > 0 { try container.encode(roles, forKey: .roles) }
    }
}

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class AssignRolesResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var userAccount:UserAccount?

    required public init(){}
}

public class UserAccount : IIdentifiableResource, Codable
{
    public var name:UserAccountName?
    public var displayName:String?
    public var email:String?
    public var roles:[String] = []
    public var status:AccountStatus?
    public var defaultOrganisationId:String?
    public var id:String?

    required public init(){}
}

public class UserAccountName : Codable
{
    public var firstName:String?
    public var lastName:String?

    required public init(){}
}

public enum AccountStatus : String, Codable
{
    case Shadowed
    case Registered
}


Swift 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
	}
}