Platform API

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

The following routes are available for this service:
PUT	/api/roles

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 ListItemFilterModel:
    list_item_filter_id: Optional[str] = None
    filter_name: Optional[str] = None
    list_id: Optional[str] = None
    list_item_id: Optional[str] = None
    list_item_is_in_filter: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoleDetailsModel:
    # @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 Connection Definition Id", Name="RoleConnectionDefinitionId")
    role_connection_definition_id: Optional[str] = None
    """
    Role Connection Definition Id
    """


    # @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
    contact_types: Optional[List[str]] = None
    """
    Contact Types the Role applies to
    """


    # @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
    require_contacts_to_accept: bool = False
    """
    Does the role require contacts to accept it?
    """


    # @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
    list_item_filters: Optional[List[ListItemFilterModel]] = None
    """
    Filters linked to the custom role.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectShareModel:
    object_share_id: Optional[str] = None
    object_id: Optional[str] = None
    object_name: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    reference: Optional[str] = None
    contact_id: Optional[str] = None
    contact_name: Optional[str] = None
    contact_type: Optional[str] = None
    contact_image_url_primary: Optional[str] = None
    contact_image_url_primary_thmbnail: Optional[str] = None
    share_status_id: Optional[str] = None
    share_status_name: Optional[str] = None


# @Api(Description="Updates a Role record, and updates Sharing.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateRoleWithSharing:
    """
    Updates a Role record, and updates Sharing.
    """

    # @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Updated.", IsRequired=true, Name="RoleDetails", ParameterType="query")
    role_details: Optional[RoleDetailsModel] = None
    """
    Details of the Contact Role to be Updated.
    """


    # @ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")
    form: Optional[FormCollection] = None
    """
    
    """

    # @ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")
    share_list: Optional[List[ObjectShareModel]] = None
    """
    List of Object Share details.
    """

Python UpdateRoleWithSharing DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RoleDetails":{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleConnectionDefinitionId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"RequireContactsToAccept":false,"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]},"Form":[],"ShareList":[{"ObjectShareId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","Name":"String","Description":"String","Reference":"String","ContactId":"00000000-0000-0000-0000-000000000000","ContactName":"String","ContactType":"String","ContactImageUrlPrimary":"String","ContactImageUrlPrimaryThmbnail":"String","ShareStatusId":"00000000-0000-0000-0000-000000000000","ShareStatusName":"String"}]}

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

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}