import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Inserts or Updates a contact group and its contact connections.
*/
@Api(Description="Inserts or Updates a contact group and its contact connections.")
open class SaveContactGroup : ValidationErrorList(), 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")
override var SuiteDataSourceInstanceId:UUID? = 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")
override var AlternateKey:String? = 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")
override var ObjectId:UUID? = 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")
open var IgnoreHash:Boolean? = 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")
open var ContactGroup:SubscriptionContactGroupModel? = null
override var IgnoreValidation:Boolean? = null
open var LicenseeId:UUID? = null
open var SessionId:UUID? = null
}
open class ValidationErrorList
{
open var ValidationErrors:ArrayList<RuleValidationResult>? = null
}
open class RuleValidationResult
{
open var RuleCode:String? = null
open var Message:String? = null
open var Key:String? = null
open var Tag:String? = null
open var ErrorCode:String? = null
}
open class SubscriptionContactGroupModel
{
/**
* A name for the contact group.
*/
@ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")
open var ContactGroupName:String? = 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")
open var GroupRoleId:UUID? = 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")
open var RoleAlternateKey:String? = 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")
open var ContactConnections:ArrayList<SubscriptionContactGroupConnectionModel>? = 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")
open var MarkAsDeleted:Boolean? = 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")
open var MarkAsArchived:Boolean? = 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")
open var MarkAsRestored:Boolean? = null
}
open class SubscriptionContactGroupConnectionModel : 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")
open var Index:Int? = 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")
open var MarkAsDeleted:Boolean? = null
}
open class SubscriptionLinkContact
{
/**
* Guid of the contact object within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
open var ContactId:UUID? = 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")
open var ContactAlternateKey:String? = 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")
open var RoleId:UUID? = 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")
open var RoleAlternateKey:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/SaveContactGroup HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}