Platform Subscription API

<back to all web services

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

Requires Authentication
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Inserts or Updates a contact group and its contact connections.
    */
    @Api(Description="Inserts or Updates a contact group and its contact connections.")
    public static class SaveContactGroup extends ValidationErrorList implements ISubscription
    {
        /**
        * Guid representing the external systems datasource information.
        */
        @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * The unique key that represents the contact group on the external system.
        */
        @ApiMember(DataType="string", Description="The unique key that represents the contact group on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
        public String AlternateKey = null;

        /**
        * Guid of the contact group object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
        */
        @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 UUID ObjectId = null;

        /**
        * 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.
        */
        @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 Boolean IgnoreHash = null;

        /**
        * Object containing all details of the contact group to be inserted or updated.
        */
        @ApiMember(DataType="SubscriptionContactGroupModel", Description="Object containing all details of the contact group to be inserted or updated.", IsRequired=true, Name="ContactGroup", ParameterType="query")
        public SubscriptionContactGroupModel ContactGroup = null;

        public Boolean IgnoreValidation = null;
        public UUID LicenseeId = null;
        public UUID SessionId = null;
        
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public SaveContactGroup setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public SaveContactGroup setAlternateKey(String value) { this.AlternateKey = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public SaveContactGroup setObjectId(UUID value) { this.ObjectId = value; return this; }
        public Boolean isIgnoreHash() { return IgnoreHash; }
        public SaveContactGroup setIgnoreHash(Boolean value) { this.IgnoreHash = value; return this; }
        public SubscriptionContactGroupModel getContactGroup() { return ContactGroup; }
        public SaveContactGroup setContactGroup(SubscriptionContactGroupModel value) { this.ContactGroup = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public SaveContactGroup setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
        public UUID getLicenseeId() { return LicenseeId; }
        public SaveContactGroup setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
        public UUID getSessionId() { return SessionId; }
        public SaveContactGroup setSessionId(UUID value) { this.SessionId = value; return this; }
    }

    public static class ValidationErrorList
    {
        public ArrayList<RuleValidationResult> ValidationErrors = null;
        
        public ArrayList<RuleValidationResult> getValidationErrors() { return ValidationErrors; }
        public ValidationErrorList setValidationErrors(ArrayList<RuleValidationResult> value) { this.ValidationErrors = value; return this; }
    }

    public static class RuleValidationResult
    {
        public String RuleCode = null;
        public String Message = null;
        public String Key = null;
        public String Tag = null;
        public String ErrorCode = null;
        
        public String getRuleCode() { return RuleCode; }
        public RuleValidationResult setRuleCode(String value) { this.RuleCode = value; return this; }
        public String getMessage() { return Message; }
        public RuleValidationResult setMessage(String value) { this.Message = value; return this; }
        public String getKey() { return Key; }
        public RuleValidationResult setKey(String value) { this.Key = value; return this; }
        public String getTag() { return Tag; }
        public RuleValidationResult setTag(String value) { this.Tag = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public RuleValidationResult setErrorCode(String value) { this.ErrorCode = value; return this; }
    }

    public static class SubscriptionContactGroupModel
    {
        /**
        * A name for the contact group.
        */
        @ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")
        public String ContactGroupName = null;

        /**
        * Guid of the Role List Item object within Eros that defines the role of the group.
        */
        @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 UUID GroupRoleId = null;

        /**
        * The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented
        */
        @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 String RoleAlternateKey = null;

        /**
        * A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
        */
        @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 ArrayList<SubscriptionContactGroupConnectionModel> ContactConnections = null;

        /**
        * Set this to be true if the contact group is to be deleted
        */
        @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
        public Boolean MarkAsDeleted = null;

        /**
        * Set this to be true if the contact group is to be archived
        */
        @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be archived", Name="MarkAsArchived", ParameterType="query")
        public Boolean MarkAsArchived = null;

        /**
        * Set this to be true if the contact group is to be restored
        */
        @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be restored", Name="MarkAsRestored", ParameterType="query")
        public Boolean MarkAsRestored = null;
        
        public String getContactGroupName() { return ContactGroupName; }
        public SubscriptionContactGroupModel setContactGroupName(String value) { this.ContactGroupName = value; return this; }
        public UUID getGroupRoleId() { return GroupRoleId; }
        public SubscriptionContactGroupModel setGroupRoleId(UUID value) { this.GroupRoleId = value; return this; }
        public String getRoleAlternateKey() { return RoleAlternateKey; }
        public SubscriptionContactGroupModel setRoleAlternateKey(String value) { this.RoleAlternateKey = value; return this; }
        public ArrayList<SubscriptionContactGroupConnectionModel> getContactConnections() { return ContactConnections; }
        public SubscriptionContactGroupModel setContactConnections(ArrayList<SubscriptionContactGroupConnectionModel> value) { this.ContactConnections = value; return this; }
        public Boolean isMarkAsDeleted() { return MarkAsDeleted; }
        public SubscriptionContactGroupModel setMarkAsDeleted(Boolean value) { this.MarkAsDeleted = value; return this; }
        public Boolean isMarkAsArchived() { return MarkAsArchived; }
        public SubscriptionContactGroupModel setMarkAsArchived(Boolean value) { this.MarkAsArchived = value; return this; }
        public Boolean isMarkAsRestored() { return MarkAsRestored; }
        public SubscriptionContactGroupModel setMarkAsRestored(Boolean value) { this.MarkAsRestored = value; return this; }
    }

    public static class SubscriptionContactGroupConnectionModel extends SubscriptionLinkContact
    {
        /**
        * The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.
        */
        @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 Integer Index = null;

        /**
        * Set this to be true if the contact connection to the group is to be deleted
        */
        @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 Boolean MarkAsDeleted = null;
        
        public Integer getIndex() { return Index; }
        public SubscriptionContactGroupConnectionModel setIndex(Integer value) { this.Index = value; return this; }
        public Boolean isMarkAsDeleted() { return MarkAsDeleted; }
        public SubscriptionContactGroupConnectionModel setMarkAsDeleted(Boolean value) { this.MarkAsDeleted = value; return this; }
    }

    public static class SubscriptionLinkContact
    {
        /**
        * Guid of the contact object within Eros.
        */
        @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
        public UUID ContactId = null;

        /**
        * The unique key that represents the contact on the external system.
        */
        @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")
        public String ContactAlternateKey = null;

        /**
        * Guid of the Role List Item object within Eros.
        */
        @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
        public UUID RoleId = null;

        /**
        * The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
        */
        @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 String RoleAlternateKey = null;
        
        public UUID getContactId() { return ContactId; }
        public SubscriptionLinkContact setContactId(UUID value) { this.ContactId = value; return this; }
        public String getContactAlternateKey() { return ContactAlternateKey; }
        public SubscriptionLinkContact setContactAlternateKey(String value) { this.ContactAlternateKey = value; return this; }
        public UUID getRoleId() { return RoleId; }
        public SubscriptionLinkContact setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleAlternateKey() { return RoleAlternateKey; }
        public SubscriptionLinkContact setRoleAlternateKey(String value) { this.RoleAlternateKey = value; return this; }
    }

}

Java SaveContactGroup DTOs

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

HTTP + CSV

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

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

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