Platform Subscription API

<back to all web services

SaveContactGroup

Inserts or Updates a contact group and its contact connections.

Requires Authentication
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
Imports Eros.Saguna.Common.Library.ValidationEngine
Imports Eros.Saguna.Common.WebAPI.ServiceModel

Namespace Global

    Namespace Eros.Saguna.Common.Library.ValidationEngine

        Public Partial Class RuleValidationResult
            '''<Summary>
            '''Validation/Error message details
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Validation/Error message details", Name:="Message", ParameterType:="body")>
            Public Overridable Property Message As String

            '''<Summary>
            '''Summary/label of validation/error
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Summary/label of validation/error", Name:="Key", ParameterType:="body")>
            Public Overridable Property Key As String

            '''<Summary>
            '''Key/code representing validation/error
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Key/code representing validation/error", Name:="ErrorCode", ParameterType:="body")>
            Public Overridable Property ErrorCode As String
        End Class

        Public Partial Class ValidationErrorList
            '''<Summary>
            '''List of any validation/errors occuring during a method call
            '''</Summary>
            <ApiMember(DataType:="List<RuleValidationResult>", Description:="List of any validation/errors occuring during a method call", Name:="ValidationErrors", ParameterType:="body")>
            Public Overridable Property ValidationErrors As List(Of RuleValidationResult)
        End Class
    End Namespace

    Namespace Eros.Saguna.Common.WebAPI.ServiceModel

        Public Partial Class SubscriptionLinkContact
            '''<Summary>
            '''Guid of the contact object within PSTPF.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the contact object within PSTPF.", Name:="ContactId", ParameterType:="body")>
            Public Overridable Property ContactId As Guid

            '''<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.", Name:="ContactAlternateKey", ParameterType:="body")>
            Public Overridable Property ContactAlternateKey As String

            '''<Summary>
            '''Guid of the Role List Item object within PSTPF.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the Role List Item object within PSTPF.", Name:="RoleId", ParameterType:="body")>
            Public Overridable Property RoleId As Guid

            '''<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:="body")>
            Public Overridable Property RoleAlternateKey As String
        End Class
    End Namespace

    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
            Inherits ValidationErrorList
            Implements 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:="body")>
            Public Overridable Property SuiteDataSourceInstanceId As Guid Implements ISubscription.SuiteDataSourceInstanceId

            '''<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:="body")>
            Public Overridable Property AlternateKey As String Implements ISubscription.AlternateKey

            '''<Summary>
            '''Guid of the contact group object within PSTPF.  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 PSTPF.  If ObjectId is known, the external system may pass this insted of the alternate key.", Name:="ObjectId", ParameterType:="body")>
            Public Overridable Property ObjectId As Guid Implements ISubscription.ObjectId

            '''<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", ParameterType:="body")>
            Public Overridable Property IgnoreHash As Boolean

            '''<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:="body")>
            Public Overridable Property ContactGroup As SubscriptionContactGroupModel

            Public Overridable Property LicenseeId As Guid
            Public Overridable Property SessionId As Guid
        End Class

        Public Partial Class SubscriptionContactGroupConnectionModel
            Inherits 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:="body")>
            Public Overridable Property Index As Integer

            '''<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:="body")>
            Public Overridable Property MarkAsDeleted As Boolean
        End Class

        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:="body")>
            Public Overridable Property ContactGroupName As String

            '''<Summary>
            '''Guid of the Role List Item object within PSTPF that defines the role of the group.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the Role List Item object within PSTPF that defines the role of the group.", IsRequired:=true, Name:="GroupRoleId", ParameterType:="body")>
            Public Overridable Property GroupRoleId As Guid

            '''<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:="body")>
            Public Overridable Property RoleAlternateKey As String

            '''<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:="body")>
            Public Overridable Property ContactConnections As List(Of SubscriptionContactGroupConnectionModel)

            '''<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:="body")>
            Public Overridable Property MarkAsDeleted As Boolean

            '''<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:="body")>
            Public Overridable Property MarkAsArchived As Boolean

            '''<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:="body")>
            Public Overridable Property MarkAsRestored As Boolean
        End Class
    End Namespace
End Namespace

VB.NET SaveContactGroup DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/SaveContactGroup HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
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},"ValidationErrors":[{"Message":"String","Key":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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