Platform API

GetContactRoleGroups

Get role groups for the given criteria

The following routes are available for this service:
All Verbs	/api/contactrolegroups/{LicenseeId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get role groups for the given criteria
*/
@Api(Description="Get role groups for the given criteria")
open class GetContactRoleGroups : PagedModel()
{
    /**
    * Get contact role groups for the specified licensee
    */
    @ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
    open var LicenseeId:UUID? = null

    /**
    * Role Group Name
    */
    @ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
    open var Name:String? = null

    /**
    * Active/Archived filter
    */
    @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
    open var RecordStatus:String? = null
}

open class PagedModel
{
    /**
    * Page Number to retrieve
    */
    @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    open var PageNumber:Int? = null

    /**
    * Number of records to retrieve
    */
    @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    open var PageSize:Int? = null

    /**
    * Index of field to sort results by
    */
    @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    open var SortIndex:Int? = null

    /**
    * Sort Order - Ascending or Descending
    */
    @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    open var SortOrder:SortOrder? = null
}

enum class SortOrder
{
    Ascending,
    Descending,
}

@ApiResponse(Description="List of role groups")
open class GetContactRoleGroupsResponse
{
    open var RoleGroups:ArrayList<RoleGroupModel>? = null
    open var TotalRoleGroups:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class RoleGroupModel
{
    /**
    * Role Group Id
    */
    @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    open var RoleGroupId:UUID? = null

    /**
    * Role Group Name
    */
    @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    open var Name:String? = null

    /**
    * Owner Contact Id
    */
    @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    open var OwnerContactId:UUID? = null

    /**
    * Number of Roles
    */
    @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
    open var NumberOfRoles:Int? = null

    /**
    * Roles belonging to the Role Group
    */
    @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
    open var Roles:ArrayList<RoleGroupRolesModel>? = null

    /**
    * 'A' (Active), 'I' (Inactive)
    */
    @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    open var RecordStatus:String? = null

    /**
    * True if Licensee-owned, allowing editing, deleting, archiving
    */
    @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
    open var AllowEdit:Boolean? = null
}

open class RoleGroupRolesModel
{
    /**
    * Role Id
    */
    @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    open var RoleId:UUID? = null

    /**
    * Role Name
    */
    @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    open var RoleName:String? = null

    /**
    * Role Group Id
    */
    @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    open var RoleGroupId:UUID? = null

    /**
    * Role Group Name
    */
    @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    open var RoleGroupName:String? = null

    /**
    * Role Group Role Id
    */
    @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    open var RoleGroupRoleId:UUID? = null

    /**
    * 'A' (Active), 'I' (Inactive)
    */
    @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    open var RecordStatus:String? = null

    /**
    * Owner Contact Id
    */
    @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    open var OwnerContactId:UUID? = null
}

Kotlin GetContactRoleGroups 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 /api/contactrolegroups/{LicenseeId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	RecordStatus: String,
	PageNumber: 0,
	PageSize: 0,
	SortIndex: 0,
	SortOrder: Ascending
}

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

{
	RoleGroups: 
	[
		{
			Name: String,
			NumberOfRoles: 0,
			Roles: 
			[
				{
					RoleName: String,
					RoleGroupName: String,
					RecordStatus: String
				}
			],
			RecordStatus: String,
			AllowEdit: False
		}
	],
	TotalRoleGroups: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}