Platform Subscription API

<back to all web services

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RuleValidationResult:
    rule_code: Optional[str] = None
    message: Optional[str] = None
    key: Optional[str] = None
    tag: Optional[str] = None
    error_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidationErrorList:
    validation_errors: Optional[List[RuleValidationResult]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionLinkContact:
    # @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
    contact_id: Optional[str] = None
    """
    Guid of the contact object within Eros.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")
    contact_alternate_key: Optional[str] = None
    """
    The unique key that represents the contact on the external system.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
    role_id: Optional[str] = None
    """
    Guid of the Role List Item object within Eros.
    """


    # @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")
    role_alternate_key: Optional[str] = None
    """
    The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionContactGroupConnectionModel(SubscriptionLinkContact):
    # @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")
    index: int = 0
    """
    The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.
    """


    # @ApiMember(DataType="bool", Description="Set this to be true if the contact connection to the group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
    mark_as_deleted: bool = False
    """
    Set this to be true if the contact connection to the group is to be deleted
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionContactGroupModel:
    # @ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")
    contact_group_name: Optional[str] = None
    """
    A name for the contact 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")
    group_role_id: Optional[str] = None
    """
    Guid of the Role List Item object within Eros that defines the role of the group.
    """


    # @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")
    role_alternate_key: Optional[str] = None
    """
    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="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")
    contact_connections: Optional[List[SubscriptionContactGroupConnectionModel]] = None
    """
    A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
    """


    # @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
    mark_as_deleted: bool = False
    """
    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 archived", Name="MarkAsArchived", ParameterType="query")
    mark_as_archived: bool = False
    """
    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 restored", Name="MarkAsRestored", ParameterType="query")
    mark_as_restored: bool = False
    """
    Set this to be true if the contact group is to be restored
    """


# @Api(Description="Inserts or Updates a contact group and its contact connections.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveContactGroup(ValidationErrorList, ISubscription):
    """
    Inserts or Updates a contact group and its contact connections.
    """

    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems datasource information.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the contact group on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the contact group on the external system.
    """


    # @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")
    object_id: Optional[str] = None
    """
    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="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")
    ignore_hash: bool = False
    """
    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="SubscriptionContactGroupModel", Description="Object containing all details of the contact group to be inserted or updated.", IsRequired=true, Name="ContactGroup", ParameterType="query")
    contact_group: Optional[SubscriptionContactGroupModel] = None
    """
    Object containing all details of the contact group to be inserted or updated.
    """


    ignore_validation: bool = False
    licensee_id: Optional[str] = None
    session_id: Optional[str] = None

Python SaveContactGroup DTOs

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

HTTP + XML

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

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

<SaveContactGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <_x003C_ValidationErrors_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library.ValidationEngine">
    <RuleValidationResult>
      <_x003C_ErrorCode_x003E_k__BackingField>String</_x003C_ErrorCode_x003E_k__BackingField>
      <_x003C_Key_x003E_k__BackingField>String</_x003C_Key_x003E_k__BackingField>
      <_x003C_Message_x003E_k__BackingField>String</_x003C_Message_x003E_k__BackingField>
      <_x003C_RuleCode_x003E_k__BackingField>String</_x003C_RuleCode_x003E_k__BackingField>
      <_x003C_Tag_x003E_k__BackingField>String</_x003C_Tag_x003E_k__BackingField>
    </RuleValidationResult>
  </_x003C_ValidationErrors_x003E_k__BackingField>
  <AlternateKey>String</AlternateKey>
  <ContactGroup>
    <_x003C_ContactConnections_x003E_k__BackingField>
      <SubscriptionContactGroupConnectionModel>
        <_x003C_ContactAlternateKey_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">String</_x003C_ContactAlternateKey_x003E_k__BackingField>
        <_x003C_ContactId_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">00000000-0000-0000-0000-000000000000</_x003C_ContactId_x003E_k__BackingField>
        <_x003C_RoleAlternateKey_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">String</_x003C_RoleAlternateKey_x003E_k__BackingField>
        <_x003C_RoleId_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">00000000-0000-0000-0000-000000000000</_x003C_RoleId_x003E_k__BackingField>
        <_x003C_Index_x003E_k__BackingField>0</_x003C_Index_x003E_k__BackingField>
        <_x003C_MarkAsDeleted_x003E_k__BackingField>false</_x003C_MarkAsDeleted_x003E_k__BackingField>
      </SubscriptionContactGroupConnectionModel>
    </_x003C_ContactConnections_x003E_k__BackingField>
    <_x003C_ContactGroupName_x003E_k__BackingField>String</_x003C_ContactGroupName_x003E_k__BackingField>
    <_x003C_GroupRoleId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_GroupRoleId_x003E_k__BackingField>
    <_x003C_MarkAsArchived_x003E_k__BackingField>false</_x003C_MarkAsArchived_x003E_k__BackingField>
    <_x003C_MarkAsDeleted_x003E_k__BackingField>false</_x003C_MarkAsDeleted_x003E_k__BackingField>
    <_x003C_MarkAsRestored_x003E_k__BackingField>false</_x003C_MarkAsRestored_x003E_k__BackingField>
    <_x003C_RoleAlternateKey_x003E_k__BackingField>String</_x003C_RoleAlternateKey_x003E_k__BackingField>
  </ContactGroup>
  <IgnoreHash>false</IgnoreHash>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <SessionId>00000000-0000-0000-0000-000000000000</SessionId>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</SaveContactGroup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>