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

/**
* Get details of the specified contact role group
*/
// @Api(Description="Get details of the specified contact role group")
public class GetContactRoleGroupDetails : Codable
{
    /**
    * 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")
    public var contactRoleGroupId:String

    required public init(){}
}

// @ApiResponse(Description="Details of the specified contact role group")
public class GetContactRoleGroupDetailsResponse : Codable
{
    public var contactRoleGroup:RoleGroupModel
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class RoleGroupModel : Codable
{
    /**
    * Role Group Id
    */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public var roleGroupId:String

    /**
    * Role Group Name
    */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    public var name:String

    /**
    * Owner Contact Id
    */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public var ownerContactId:String

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

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

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

    /**
    * 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 var allowEdit:Bool

    required public init(){}
}

public class RoleGroupRolesModel : Codable
{
    /**
    * Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    public var roleId:String

    /**
    * Role Name
    */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    public var roleName:String

    /**
    * Role Group Id
    */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public var roleGroupId:String

    /**
    * Role Group Name
    */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    public var roleGroupName:String

    /**
    * Role Group Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    public var roleGroupRoleId:String

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

    /**
    * Owner Contact Id
    */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public var ownerContactId:String

    required public init(){}
}

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