Platform Subscription API

<back to all web services

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

Requires Authentication
namespace Eros.Saguna.Common.WebAPI.ServiceModel

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

    [<AllowNullLiteral>]
    type RuleValidationResult() = 
        member val RuleCode:String = null with get,set
        member val Message:String = null with get,set
        member val Key:String = null with get,set
        member val Tag:String = null with get,set
        member val ErrorCode:String = null with get,set

    [<AllowNullLiteral>]
    type ValidationErrorList() = 
        member val ValidationErrors:ResizeArray<RuleValidationResult> = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionLinkContact() = 
        ///<summary>
        ///Guid of the contact object within Eros.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the contact on the external system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")>]
        member val ContactAlternateKey:String = null with get,set

        ///<summary>
        ///Guid of the Role List Item object within Eros.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the role type on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")>]
        member val RoleAlternateKey:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionContactGroupConnectionModel() = 
        inherit SubscriptionLinkContact()
        ///<summary>
        ///The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.
        ///</summary>
        [<ApiMember(DataType="int", Description="The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.", Name="Index", ParameterType="query")>]
        member val Index:Int32 = new Int32() with get,set

        ///<summary>
        ///Set this to be true if the contact connection to the group is to be deleted
        ///</summary>
        [<ApiMember(DataType="bool", Description="Set this to be true if the contact connection to the group is to be deleted", Name="MarkAsDeleted", ParameterType="query")>]
        member val MarkAsDeleted:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SubscriptionContactGroupModel() = 
        ///<summary>
        ///A name for the contact group.
        ///</summary>
        [<ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")>]
        member val ContactGroupName:String = null with get,set

        ///<summary>
        ///Guid of the Role List Item object within Eros that defines the role of the group.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros that defines the role of the group.", IsRequired=true, Name="GroupRoleId", ParameterType="query")>]
        member val GroupRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")>]
        member val RoleAlternateKey:String = null with get,set

        ///<summary>
        ///A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
        ///</summary>
        [<ApiMember(DataType="List<SubscriptionContactGroupConnectionModel>", Description="A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.", Name="ContactConnections", ParameterType="query")>]
        member val ContactConnections:ResizeArray<SubscriptionContactGroupConnectionModel> = null with get,set

        ///<summary>
        ///Set this to be true if the contact group is to be deleted
        ///</summary>
        [<ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be deleted", Name="MarkAsDeleted", ParameterType="query")>]
        member val MarkAsDeleted:Boolean = new Boolean() with get,set

        ///<summary>
        ///Set this to be true if the contact group is to be archived
        ///</summary>
        [<ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be archived", Name="MarkAsArchived", ParameterType="query")>]
        member val MarkAsArchived:Boolean = new Boolean() with get,set

        ///<summary>
        ///Set this to be true if the contact group is to be restored
        ///</summary>
        [<ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be restored", Name="MarkAsRestored", ParameterType="query")>]
        member val MarkAsRestored:Boolean = new Boolean() with get,set

    ///<summary>
    ///Inserts or Updates a contact group and its contact connections.
    ///</summary>
    [<Api(Description="Inserts or Updates a contact group and its contact connections.")>]
    [<AllowNullLiteral>]
    type SaveContactGroup() = 
        inherit ValidationErrorList()
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the contact group on the external system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the contact group on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")>]
        member val AlternateKey:String = null with get,set

        ///<summary>
        ///Guid of the contact group object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the contact group object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.", Name="ObjectId", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save.
        ///</summary>
        [<ApiMember(DataType="bool", Description="If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save.", Name="IgnoreHash")>]
        member val IgnoreHash:Boolean = new Boolean() with get,set

        ///<summary>
        ///Object containing all details of the contact group to be inserted or updated.
        ///</summary>
        [<ApiMember(DataType="SubscriptionContactGroupModel", Description="Object containing all details of the contact group to be inserted or updated.", IsRequired=true, Name="ContactGroup", ParameterType="query")>]
        member val ContactGroup:SubscriptionContactGroupModel = null with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set
        member val LicenseeId:Guid = new Guid() with get,set
        member val SessionId:Guid = new Guid() with get,set

F# SaveContactGroup DTOs

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

HTTP + JSV

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

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

{
	AlternateKey: String,
	IgnoreHash: False,
	ContactGroup: 
	{
		ContactGroupName: String,
		RoleAlternateKey: String,
		ContactConnections: 
		[
			{
				Index: 0,
				MarkAsDeleted: False,
				ContactAlternateKey: String,
				RoleAlternateKey: String
			}
		],
		MarkAsDeleted: False,
		MarkAsArchived: False,
		MarkAsRestored: False
	},
	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
	}
}