Platform API

<back to all web services

GetContactRoleGroups

Get role groups for the given criteria

export enum SortOrder
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class PagedModel
{
    /** @description Page Number to retrieve */
    // @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    public PageNumber: number;

    /** @description Number of records to retrieve */
    // @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    public PageSize: number;

    /** @description Index of field to sort results by */
    // @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    public SortIndex: number;

    /** @description Sort Order - Ascending or Descending */
    // @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    public SortOrder: SortOrder;

    public constructor(init?: Partial<PagedModel>) { (Object as any).assign(this, init); }
}

export class RoleGroupRolesModel
{
    /** @description Role Id */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    public RoleId: string;

    /** @description Role Name */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    public RoleName: string;

    /** @description Role Group Id */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public RoleGroupId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    public RoleGroupName: string;

    /** @description Role Group Role Id */
    // @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    public RoleGroupRoleId: string;

    /** @description 'A' (Active), 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Owner Contact Id */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public OwnerContactId: string;

    public constructor(init?: Partial<RoleGroupRolesModel>) { (Object as any).assign(this, init); }
}

export class RoleGroupModel
{
    /** @description Role Group Id */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public RoleGroupId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    public Name: string;

    /** @description Owner Contact Id */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public OwnerContactId: string;

    /** @description Number of Roles */
    // @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
    public NumberOfRoles: number;

    /** @description Roles belonging to the Role Group */
    // @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
    public Roles: RoleGroupRolesModel[];

    /** @description 'A' (Active), 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description True if Licensee-owned, allowing editing, deleting, archiving */
    // @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
    public AllowEdit: boolean;

    public constructor(init?: Partial<RoleGroupModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of role groups")
export class GetContactRoleGroupsResponse
{
    public RoleGroups: RoleGroupModel[];
    public TotalRoleGroups: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetContactRoleGroupsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get role groups for the given criteria */
// @Api(Description="Get role groups for the given criteria")
export class GetContactRoleGroups extends PagedModel
{
    /** @description 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")
    public LicenseeId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
    public Name: string;

    /** @description Active/Archived filter */
    // @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
    public RecordStatus: string;

    public constructor(init?: Partial<GetContactRoleGroups>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetContactRoleGroups DTOs

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