Platform Subscription API

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

**SaveContactGroup** Parameters:
Name	Parameter	Data Type	Required	Description
SuiteDataSourceInstanceId	query	Guid	Yes	Guid representing the external systems datasource information.
AlternateKey	query	string	Yes	The unique key that represents the contact group on the external system.
ObjectId	query	Guid	No	Guid of the contact group object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key.
IgnoreHash	query	bool	No	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.
ContactGroup	query	SubscriptionContactGroupModel	Yes	Object containing all details of the contact group to be inserted or updated.
IgnoreValidation	query	bool	No

**ValidationErrorList** Parameters:
Name	Parameter	Data Type	Required	Description
ValidationErrors	form	List<RuleValidationResult>	No

**RuleValidationResult** Parameters:
Name	Parameter	Data Type	Required
RuleCode	form	string	No
Message	form	string	No
Key	form	string	No
Tag	form	string	No
ErrorCode	form	string	No

**SubscriptionContactGroupModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactGroupName	query	string	Yes	A name for the contact group.
GroupRoleId	query	Guid	Yes	Guid of the Role List Item object within Eros that defines the role of the group.
RoleAlternateKey	query	string	No	The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented
ContactConnections	query	List<SubscriptionContactGroupConnectionModel>	No	A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
MarkAsDeleted	query	bool	No	Set this to be true if the contact group is to be deleted
MarkAsArchived	query	bool	No	Set this to be true if the contact group is to be archived
MarkAsRestored	query	bool	No	Set this to be true if the contact group is to be restored

**SubscriptionContactGroupConnectionModel** Parameters:
Name	Parameter	Data Type	Required	Description
Index	query	int	No	The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth.
MarkAsDeleted	query	bool	No	Set this to be true if the contact connection to the group is to be deleted

**SubscriptionLinkContact** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	query	Guid	No	Guid of the contact object within Eros.
ContactAlternateKey	query	string	Yes	The unique key that represents the contact on the external system.
RoleId	query	Guid	Yes	Guid of the Role List Item object within Eros.
RoleAlternateKey	query	string	No	The unique key that represents the role type on the external system. Note: Use of this is not currently implemented

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">
  <ValidationErrors 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>
  </ValidationErrors>
  <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>
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <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>