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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoleGroupRolesModel:
    # @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    role_id: Optional[str] = None
    """
    Role Id
    """


    # @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    role_name: Optional[str] = None
    """
    Role Name
    """


    # @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    role_group_id: Optional[str] = None
    """
    Role Group Id
    """


    # @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    role_group_name: Optional[str] = None
    """
    Role Group Name
    """


    # @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    role_group_role_id: Optional[str] = None
    """
    Role Group Role Id
    """


    # @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    'A' (Active), 'I' (Inactive)
    """


    # @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    owner_contact_id: Optional[str] = None
    """
    Owner Contact Id
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoleGroupModel:
    # @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    role_group_id: Optional[str] = None
    """
    Role Group Id
    """


    # @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    name: Optional[str] = None
    """
    Role Group Name
    """


    # @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    owner_contact_id: Optional[str] = None
    """
    Owner Contact Id
    """


    # @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
    number_of_roles: int = 0
    """
    Number of Roles
    """


    # @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
    roles: Optional[List[RoleGroupRolesModel]] = None
    """
    Roles belonging to the Role Group
    """


    # @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    'A' (Active), 'I' (Inactive)
    """


    # @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
    allow_edit: bool = False
    """
    True if Licensee-owned, allowing editing, deleting, archiving
    """


# @ApiResponse(Description="Details of the specified contact role group")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactRoleGroupDetailsResponse:
    contact_role_group: Optional[RoleGroupModel] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get details of the specified contact role group")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactRoleGroupDetails:
    """
    Get details of the specified contact 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")
    contact_role_group_id: Optional[str] = None
    """
    The Contact Role Group Guid. Records retrieved will belong to this role group.
    """

Python GetContactRoleGroupDetails DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ContactRoleGroup":{"RoleGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","NumberOfRoles":0,"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleGroupId":"00000000-0000-0000-0000-000000000000","RoleGroupName":"String","RoleGroupRoleId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000"}],"RecordStatus":"String","AllowEdit":false},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}