namespace Eros.Saguna.Common.WebAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RuleValidationResult() =
member val RuleCode:String = null with get,set
member val Message:String = null with get,set
member val Key:String = null with get,set
member val Tag:String = null with get,set
member val ErrorCode:String = null with get,set
[<AllowNullLiteral>]
type ValidationErrorList() =
member val ValidationErrors:ResizeArray<RuleValidationResult> = null with get,set
[<AllowNullLiteral>]
type SubscriptionLinkContact() =
///<summary>
///Guid of the contact object within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")>]
member val ContactId:Guid = new Guid() with get,set
///<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.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")>]
member val ContactAlternateKey:String = null with get,set
///<summary>
///Guid of the Role List Item object within Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")>]
member val RoleId:Guid = new Guid() with get,set
///<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="query")>]
member val RoleAlternateKey:String = null with get,set
[<AllowNullLiteral>]
type SubscriptionContactGroupConnectionModel() =
inherit 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="query")>]
member val Index:Int32 = new Int32() with get,set
///<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="query")>]
member val MarkAsDeleted:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type SubscriptionContactGroupModel() =
///<summary>
///A name for the contact group.
///</summary>
[<ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")>]
member val ContactGroupName:String = null with get,set
///<summary>
///Guid of the Role List Item object within Eros that defines the role of the group.
///</summary>
[<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")>]
member val GroupRoleId:Guid = new Guid() with get,set
///<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="query")>]
member val RoleAlternateKey:String = null with get,set
///<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="query")>]
member val ContactConnections:ResizeArray<SubscriptionContactGroupConnectionModel> = null with get,set
///<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="query")>]
member val MarkAsDeleted:Boolean = new Boolean() with get,set
///<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="query")>]
member val MarkAsArchived:Boolean = new Boolean() with get,set
///<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="query")>]
member val MarkAsRestored:Boolean = new Boolean() with get,set
///<summary>
///Inserts or Updates a contact group and its contact connections.
///</summary>
[<Api(Description="Inserts or Updates a contact group and its contact connections.")>]
[<AllowNullLiteral>]
type SaveContactGroup() =
inherit ValidationErrorList()
///<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="query")>]
member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set
///<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="query")>]
member val AlternateKey:String = null with get,set
///<summary>
///Guid of the contact group object within Eros. 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 Eros. If ObjectId is known, the external system may pass this insted of the alternate key.", Name="ObjectId", ParameterType="query")>]
member val ObjectId:Guid = new Guid() with get,set
///<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")>]
member val IgnoreHash:Boolean = new Boolean() with get,set
///<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="query")>]
member val ContactGroup:SubscriptionContactGroupModel = null with get,set
member val IgnoreValidation:Boolean = new Boolean() with get,set
member val LicenseeId:Guid = new Guid() with get,set
member val SessionId:Guid = new Guid() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>