Platform API

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

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


export class ListItemFilterModel
{
    public ListItemFilterId: string;
    public FilterName: string;
    public ListId: string;
    public ListItemId: string;
    public ListItemIsInFilter: boolean;

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

export class RoleDetailsModel
{
    /** @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 Connection Definition Id */
    // @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
    public RoleConnectionDefinitionId: string;

    /** @description Contact Types the Role applies to */
    // @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
    public ContactTypes: string[];

    /** @description Does the role require contacts to accept it? */
    // @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
    public RequireContactsToAccept: boolean;

    /** @description Filters linked to the custom role. */
    // @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
    public ListItemFilters: ListItemFilterModel[];

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

export class ObjectShareModel
{
    public ObjectShareId: string;
    public ObjectId: string;
    public ObjectName: string;
    public Name: string;
    public Description: string;
    public Reference: string;
    public ContactId: string;
    public ContactName: string;
    public ContactType: string;
    public ContactImageUrlPrimary: string;
    public ContactImageUrlPrimaryThmbnail: string;
    public ShareStatusId: string;
    public ShareStatusName: string;

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

/** @description Updates a Role record, and updates Sharing. */
// @Api(Description="Updates a Role record, and updates Sharing.")
export class UpdateRoleWithSharing
{
    /** @description Details of the Contact Role to be Updated. */
    // @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Updated.", IsRequired=true, Name="RoleDetails", ParameterType="query")
    public RoleDetails: RoleDetailsModel;

    /** @description  */
    // @ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")
    public Form: FormCollection;

    /** @description List of Object Share details. */
    // @ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")
    public ShareList: ObjectShareModel[];

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

TypeScript UpdateRoleWithSharing DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

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