Platform API

<back to all web services

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

Requires Authentication
The following routes are available for this service:
PUT/api/roles
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ListItemFilterModel() = 
        member val ListItemFilterId:Guid = new Guid() with get,set
        member val FilterName:String = null with get,set
        member val ListId:Guid = new Guid() with get,set
        member val ListItemId:Guid = new Guid() with get,set
        member val ListItemIsInFilter:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RoleDetailsModel() = 
        ///<summary>
        ///Role Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///Role Connection Definition Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")>]
        member val RoleConnectionDefinitionId:Guid = new Guid() with get,set

        ///<summary>
        ///Contact Types the Role applies to
        ///</summary>
        [<ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")>]
        member val ContactTypes:ResizeArray<Guid> = null with get,set

        ///<summary>
        ///Does the role require contacts to accept it?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")>]
        member val RequireContactsToAccept:Boolean = new Boolean() with get,set

        ///<summary>
        ///Filters linked to the custom role.
        ///</summary>
        [<ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")>]
        member val ListItemFilters:ResizeArray<ListItemFilterModel> = null with get,set

    [<AllowNullLiteral>]
    type ObjectShareModel() = 
        member val ObjectShareId:Guid = new Guid() with get,set
        member val ObjectId:Guid = new Guid() with get,set
        member val ObjectName:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Reference:String = null with get,set
        member val ContactId:Guid = new Guid() with get,set
        member val ContactName:String = null with get,set
        member val ContactType:String = null with get,set
        member val ContactImageUrlPrimary:String = null with get,set
        member val ContactImageUrlPrimaryThmbnail:String = null with get,set
        member val ShareStatusId:Guid = new Guid() with get,set
        member val ShareStatusName:String = null with get,set

    ///<summary>
    ///Updates a Role record, and updates Sharing.
    ///</summary>
    [<Api(Description="Updates a Role record, and updates Sharing.")>]
    [<AllowNullLiteral>]
    type UpdateRoleWithSharing() = 
        ///<summary>
        ///Details of the Contact Role to be Updated.
        ///</summary>
        [<ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Updated.", IsRequired=true, Name="RoleDetails", ParameterType="query")>]
        member val RoleDetails:RoleDetailsModel = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")>]
        member val Form:FormCollection = null with get,set

        ///<summary>
        ///List of Object Share details.
        ///</summary>
        [<ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")>]
        member val ShareList:ResizeArray<ObjectShareModel> = null with get,set

F# UpdateRoleWithSharing 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.

PUT /api/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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