Platform Subscription API

<back to all web services

SaveContactRole

Requires Authentication
namespace Eros.Saguna.Common.Library.ValidationEngine

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 SubscriptionContactRoleModel() = 
        ///<summary>
        ///Name of the role.
        ///</summary>
        [<ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///Short version of the role name.
        ///</summary>
        [<ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")>]
        member val RoleShortName:String = null with get,set

        ///<summary>
        ///Description of the role purpose.
        ///</summary>
        [<ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")>]
        member val RoleDescription:String = null with get,set

        ///<summary>
        ///If true, the role will be pending for a contact until they accept it.
        ///</summary>
        [<ApiMember(DataType="bool", Description="If true, the role will be pending for a contact until they accept it.", Name="RequireContactsToAccept", ParameterType="query")>]
        member val RequireContactsToAccept:Boolean = new Boolean() with get,set

        ///<summary>
        ///Contact Types that may have this role.
        ///</summary>
        [<ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")>]
        member val ContactTypes:ResizeArray<Guid> = null with get,set

        ///<summary>
        ///Role Filters this role should be added to.
        ///</summary>
        [<ApiMember(DataType="List<Guid>", Description="Role Filters this role should be added to.", Name="ListItemFilters", ParameterType="query")>]
        member val ListItemFilters:ResizeArray<Guid> = null with get,set

    [<AllowNullLiteral>]
    type SaveContactRole() = 
        inherit ValidationErrorList()
        ///<summary>
        ///Guid representing the external systems data source information.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid representing the external systems data source information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the contact role on the external system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the contact role on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")>]
        member val AlternateKey:String = null with get,set

        ///<summary>
        ///Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///Object containing all details of the contact role to be inserted or updated.
        ///</summary>
        [<ApiMember(DataType="SubscriptionContactRoleModel", Description="Object containing all details of the contact role to be inserted or updated.", IsRequired=true, Name="ContactRole", ParameterType="query")>]
        member val ContactRole:SubscriptionContactRoleModel = null with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set

F# SaveContactRole DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"AlternateKey":"String","ContactRole":{"RoleName":"String","RoleShortName":"String","RoleDescription":"String","RequireContactsToAccept":false,"ContactTypes":["00000000-0000-0000-0000-000000000000"],"ListItemFilters":["00000000-0000-0000-0000-000000000000"]},"IgnoreValidation":false,"ValidationErrors":[{"RuleCode":"String","Message":"String","Key":"String","Tag":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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