Platform API

GetContactRoleGroupDetails

Get details of the specified contact role group

The following routes are available for this service:
All Verbs	/api/contactrolegroup/{ContactRoleGroupId}

import 'package:servicestack/servicestack.dart';

class RoleGroupRolesModel implements IConvertible
{
    /**
    * Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    String? RoleId;

    /**
    * Role Name
    */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    String? RoleName;

    /**
    * Role Group Id
    */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    String? RoleGroupId;

    /**
    * Role Group Name
    */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    String? RoleGroupName;

    /**
    * Role Group Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    String? RoleGroupRoleId;

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

    /**
    * Owner Contact Id
    */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    String? OwnerContactId;

    RoleGroupRolesModel({this.RoleId,this.RoleName,this.RoleGroupId,this.RoleGroupName,this.RoleGroupRoleId,this.RecordStatus,this.OwnerContactId});
    RoleGroupRolesModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RoleId = json['RoleId'];
        RoleName = json['RoleName'];
        RoleGroupId = json['RoleGroupId'];
        RoleGroupName = json['RoleGroupName'];
        RoleGroupRoleId = json['RoleGroupRoleId'];
        RecordStatus = json['RecordStatus'];
        OwnerContactId = json['OwnerContactId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RoleId': RoleId,
        'RoleName': RoleName,
        'RoleGroupId': RoleGroupId,
        'RoleGroupName': RoleGroupName,
        'RoleGroupRoleId': RoleGroupRoleId,
        'RecordStatus': RecordStatus,
        'OwnerContactId': OwnerContactId
    };

    getTypeName() => "RoleGroupRolesModel";
    TypeContext? context = _ctx;
}

class RoleGroupModel implements IConvertible
{
    /**
    * Role Group Id
    */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    String? RoleGroupId;

    /**
    * Role Group Name
    */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    String? Name;

    /**
    * Owner Contact Id
    */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    String? OwnerContactId;

    /**
    * Number of Roles
    */
    // @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
    int? NumberOfRoles;

    /**
    * Roles belonging to the Role Group
    */
    // @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
    List<RoleGroupRolesModel>? Roles;

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

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

    RoleGroupModel({this.RoleGroupId,this.Name,this.OwnerContactId,this.NumberOfRoles,this.Roles,this.RecordStatus,this.AllowEdit});
    RoleGroupModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RoleGroupId = json['RoleGroupId'];
        Name = json['Name'];
        OwnerContactId = json['OwnerContactId'];
        NumberOfRoles = json['NumberOfRoles'];
        Roles = JsonConverters.fromJson(json['Roles'],'List<RoleGroupRolesModel>',context!);
        RecordStatus = json['RecordStatus'];
        AllowEdit = json['AllowEdit'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RoleGroupId': RoleGroupId,
        'Name': Name,
        'OwnerContactId': OwnerContactId,
        'NumberOfRoles': NumberOfRoles,
        'Roles': JsonConverters.toJson(Roles,'List<RoleGroupRolesModel>',context!),
        'RecordStatus': RecordStatus,
        'AllowEdit': AllowEdit
    };

    getTypeName() => "RoleGroupModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="Details of the specified contact role group")
class GetContactRoleGroupDetailsResponse implements IConvertible
{
    RoleGroupModel? ContactRoleGroup;
    ResponseStatus? ResponseStatus;

    GetContactRoleGroupDetailsResponse({this.ContactRoleGroup,this.ResponseStatus});
    GetContactRoleGroupDetailsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactRoleGroup = JsonConverters.fromJson(json['ContactRoleGroup'],'RoleGroupModel',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactRoleGroup': JsonConverters.toJson(ContactRoleGroup,'RoleGroupModel',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetContactRoleGroupDetailsResponse";
    TypeContext? context = _ctx;
}

/**
* Get details of the specified contact role group
*/
// @Api(Description="Get details of the specified contact role group")
class GetContactRoleGroupDetails implements IConvertible
{
    /**
    * The Contact Role Group Guid. Records retrieved will belong to this role group.
    */
    // @ApiMember(DataType="Guid", Description="The Contact Role Group Guid. Records retrieved will belong to this role group.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
    String? ContactRoleGroupId;

    GetContactRoleGroupDetails({this.ContactRoleGroupId});
    GetContactRoleGroupDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactRoleGroupId = json['ContactRoleGroupId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactRoleGroupId': ContactRoleGroupId
    };

    getTypeName() => "GetContactRoleGroupDetails";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'RoleGroupRolesModel': TypeInfo(TypeOf.Class, create:() => RoleGroupRolesModel()),
    'RoleGroupModel': TypeInfo(TypeOf.Class, create:() => RoleGroupModel()),
    'List<RoleGroupRolesModel>': TypeInfo(TypeOf.Class, create:() => <RoleGroupRolesModel>[]),
    'GetContactRoleGroupDetailsResponse': TypeInfo(TypeOf.Class, create:() => GetContactRoleGroupDetailsResponse()),
    'GetContactRoleGroupDetails': TypeInfo(TypeOf.Class, create:() => GetContactRoleGroupDetails()),
});

Dart GetContactRoleGroupDetails 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/contactrolegroup/{ContactRoleGroupId} 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

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