Platform Subscription API

<back to all web services

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

Requires Authentication
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;
using Eros.Saguna.Common.WebAPI.ServiceModel;

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.Saguna.Common.WebAPI.ServiceModel
{
    public partial class 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")]
        public virtual Guid ContactId { 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")]
        public virtual string ContactAlternateKey { 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")]
        public virtual Guid RoleId { 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")]
        public virtual string RoleAlternateKey { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    ///<summary>
    ///Inserts or Updates a contact group and its contact connections.
    ///</summary>
    [Api(Description="Inserts or Updates a contact group and its contact connections.")]
    public partial class SaveContactGroup
        : ValidationErrorList, ISubscription
    {
        ///<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")]
        public virtual Guid SuiteDataSourceInstanceId { 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")]
        public virtual string AlternateKey { 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")]
        public virtual Guid ObjectId { 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")]
        public virtual bool IgnoreHash { 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")]
        public virtual SubscriptionContactGroupModel ContactGroup { get; set; }

        public virtual bool IgnoreValidation { get; set; }
        public virtual Guid LicenseeId { get; set; }
        public virtual Guid SessionId { get; set; }
    }

    public partial class SubscriptionContactGroupConnectionModel
        : 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")]
        public virtual int Index { 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")]
        public virtual bool MarkAsDeleted { get; set; }
    }

    public partial class 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")]
        public virtual string ContactGroupName { 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")]
        public virtual Guid GroupRoleId { 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")]
        public virtual string RoleAlternateKey { 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")]
        public virtual List<SubscriptionContactGroupConnectionModel> ContactConnections { 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")]
        public virtual bool MarkAsDeleted { 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")]
        public virtual bool MarkAsArchived { 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")]
        public virtual bool MarkAsRestored { get; set; }
    }

}

C# SaveContactGroup 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.

POST /json/reply/SaveContactGroup HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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