Platform Subscription API

<back to all web services

SaveContactRole

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.ServiceModelSubscription;
using Eros.Saguna.Common.Library.ValidationEngine;

namespace Eros.Saguna.Common.Library.ValidationEngine
{
    public partial class RuleValidationResult
    {
        public virtual string RuleCode { get; set; }
        public virtual string Message { get; set; }
        public virtual string Key { get; set; }
        public virtual string Tag { get; set; }
        public virtual string ErrorCode { get; set; }
    }

    public partial class ValidationErrorList
    {
        public virtual List<RuleValidationResult> ValidationErrors { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    public partial class SaveContactRole
        : ValidationErrorList, ISubscription
    {
        ///<summary>
        ///Guid representing the external systems data source information.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the external systems data source information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")]
        public virtual Guid SuiteDataSourceInstanceId { get; set; }

        ///<summary>
        ///The unique key that represents the contact role on the external system.
        ///</summary>
        [ApiMember(DataType="string", Description="The unique key that represents the contact role on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")]
        public virtual string AlternateKey { get; set; }

        ///<summary>
        ///Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Object containing all details of the contact role to be inserted or updated.
        ///</summary>
        [ApiMember(DataType="SubscriptionContactRoleModel", Description="Object containing all details of the contact role to be inserted or updated.", IsRequired=true, Name="ContactRole", ParameterType="query")]
        public virtual SubscriptionContactRoleModel ContactRole { get; set; }

        public virtual bool IgnoreValidation { get; set; }
    }

    public partial class SubscriptionContactRoleModel
    {
        ///<summary>
        ///Name of the role.
        ///</summary>
        [ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")]
        public virtual string RoleName { get; set; }

        ///<summary>
        ///Short version of the role name.
        ///</summary>
        [ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")]
        public virtual string RoleShortName { get; set; }

        ///<summary>
        ///Description of the role purpose.
        ///</summary>
        [ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")]
        public virtual string RoleDescription { get; set; }

        ///<summary>
        ///If true, the role will be pending for a contact until they accept it.
        ///</summary>
        [ApiMember(DataType="bool", Description="If true, the role will be pending for a contact until they accept it.", Name="RequireContactsToAccept", ParameterType="query")]
        public virtual bool RequireContactsToAccept { get; set; }

        ///<summary>
        ///Contact Types that may have this role.
        ///</summary>
        [ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")]
        public virtual List<Guid> ContactTypes { get; set; }

        ///<summary>
        ///Role Filters this role should be added to.
        ///</summary>
        [ApiMember(DataType="List<Guid>", Description="Role Filters this role should be added to.", Name="ListItemFilters", ParameterType="query")]
        public virtual List<Guid> ListItemFilters { get; set; }
    }

}

C# SaveContactRole DTOs

POST /jsv/reply/SaveContactRole HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AlternateKey: String,
	ContactRole: 
	{
		RoleName: String,
		RoleShortName: String,
		RoleDescription: String,
		RequireContactsToAccept: False,
		ContactTypes: 
		[
			00000000-0000-0000-0000-000000000000
		],
		ListItemFilters: 
		[
			00000000-0000-0000-0000-000000000000
		]
	},
	IgnoreValidation: False,
	ValidationErrors: 
	[
		{
			RuleCode: String,
			Message: String,
			Key: String,
			Tag: String,
			ErrorCode: 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
	}
}