Platform API

<back to all web services

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class ListItemFilterModel
    {
        public virtual Guid ListItemFilterId { get; set; }
        public virtual string FilterName { get; set; }
        public virtual Guid ListId { get; set; }
        public virtual Guid ListItemId { get; set; }
        public virtual bool ListItemIsInFilter { get; set; }
    }

    public partial class ObjectShareModel
    {
        public virtual Guid ObjectShareId { get; set; }
        public virtual Guid ObjectId { get; set; }
        public virtual string ObjectName { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string Reference { get; set; }
        public virtual Guid ContactId { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string ContactType { get; set; }
        public virtual string ContactImageUrlPrimary { get; set; }
        public virtual string ContactImageUrlPrimaryThmbnail { get; set; }
        public virtual Guid ShareStatusId { get; set; }
        public virtual string ShareStatusName { get; set; }
    }

    public partial class RoleDetailsModel
    {
        ///<summary>
        ///Role Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")]
        public virtual Guid RoleId { get; set; }

        ///<summary>
        ///Role Name
        ///</summary>
        [ApiMember(DataType="string", Description="Role Name", Name="RoleName")]
        public virtual string RoleName { get; set; }

        ///<summary>
        ///Role Connection Definition Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")]
        public virtual Guid RoleConnectionDefinitionId { get; set; }

        ///<summary>
        ///Contact Types the Role applies to
        ///</summary>
        [ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")]
        public virtual List<Guid> ContactTypes { 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")]
        public virtual bool RequireContactsToAccept { get; set; }

        ///<summary>
        ///Filters linked to the custom role.
        ///</summary>
        [ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")]
        public virtual List<ListItemFilterModel> ListItemFilters { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Updates a Role record, and updates Sharing.
    ///</summary>
    [Api(Description="Updates a Role record, and updates Sharing.")]
    public partial class 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")]
        public virtual RoleDetailsModel RoleDetails { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")]
        public virtual FormCollection Form { get; set; }

        ///<summary>
        ///List of Object Share details.
        ///</summary>
        [ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")]
        public virtual List<ObjectShareModel> ShareList { get; set; }
    }

}

C# UpdateRoleWithSharing DTOs

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

{
	RoleDetails: 
	{
		RoleName: String,
		ContactTypes: 
		[
			00000000-0000-0000-0000-000000000000
		],
		RequireContactsToAccept: False,
		ListItemFilters: 
		[
			{
				FilterName: String,
				ListItemIsInFilter: False
			}
		]
	},
	Form: [],
	ShareList: 
	[
		{
			ObjectName: String,
			Name: String,
			Description: String,
			Reference: String,
			ContactName: String,
			ContactType: String,
			ContactImageUrlPrimary: String,
			ContactImageUrlPrimaryThmbnail: String,
			ShareStatusName: String
		}
	]
}

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

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