Platform API

<back to all web services

GetRolesForContact

Get roles for the specified contact

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

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

    [<AllowNullLiteral>]
    type RoleModel() = 
        ///<summary>
        ///Role Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///Is the role a licensee role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")>]
        member val IsLicenseeRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is manage contacts role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")>]
        member val IsManageContacts:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a Platform role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")>]
        member val IsPlatformRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a services role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")>]
        member val IsServiceRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a customer role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")>]
        member val IsCustomerRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a functional role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")>]
        member val IsFunctionalRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role an auto-accept role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")>]
        member val IsRequestAutoAccepted:Boolean = new Boolean() with get,set

        ///<summary>
        ///Suite that the role belongs to
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")>]
        member val SuiteId:Guid = new Guid() with get,set

        ///<summary>
        ///Suite that the role belongs to
        ///</summary>
        [<ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")>]
        member val SuiteName:String = null with get,set

        ///<summary>
        ///'A' (Active) or 'I' (Inactive)
        ///</summary>
        [<ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

        ///<summary>
        ///Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")>]
        member val ObjectConnectionId:Guid = new Guid() with get,set

    [<ApiResponse(Description="List of roles")>]
    [<AllowNullLiteral>]
    type GetRolesResponse() = 
        member val Roles:ResizeArray<RoleModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get roles for the specified contact
    ///</summary>
    [<Api(Description="Get roles for the specified contact")>]
    [<AllowNullLiteral>]
    type GetRolesForContact() = 
        ///<summary>
        ///Get roles (custom and standard roles) for the specified contact
        ///</summary>
        [<ApiMember(Description="Get roles (custom and standard roles) for the specified contact", IsRequired=true, Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}
        ///</summary>
        [<ApiMember(Description="List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}", IsRequired=true, Name="RoleListItemFilterId")>]
        member val RoleListItemFilterId:Guid = new Guid() with get,set

F# GetRolesForContact DTOs

POST /api/roles/{ContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Roles: 
	[
		{
			RoleName: String,
			IsLicenseeRole: False,
			IsManageContacts: False,
			IsPlatformRole: False,
			IsServiceRole: False,
			IsCustomerRole: False,
			IsFunctionalRole: False,
			IsRequestAutoAccepted: False,
			SuiteName: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}