Platform Subscription API

<back to all web services

SaveContactRole

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SaveContactRole : ValidationErrorList(), ISubscription
{
    /**
    * Guid representing the external systems data source information.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the external systems data source information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    override var SuiteDataSourceInstanceId:UUID? = null

    /**
    * The unique key that represents the contact role on the external system.
    */
    @ApiMember(DataType="string", Description="The unique key that represents the contact role on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
    override var AlternateKey:String? = null

    /**
    * Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
    */
    @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")
    override var ObjectId:UUID? = null

    /**
    * Object containing all details of the contact role to be inserted or updated.
    */
    @ApiMember(DataType="SubscriptionContactRoleModel", Description="Object containing all details of the contact role to be inserted or updated.", IsRequired=true, Name="ContactRole", ParameterType="query")
    open var ContactRole:SubscriptionContactRoleModel? = null

    override var IgnoreValidation:Boolean? = 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 SubscriptionContactRoleModel
{
    /**
    * Name of the role.
    */
    @ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")
    open var RoleName:String? = null

    /**
    * Short version of the role name.
    */
    @ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")
    open var RoleShortName:String? = null

    /**
    * Description of the role purpose.
    */
    @ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")
    open var RoleDescription:String? = null

    /**
    * If true, the role will be pending for a contact until they accept it.
    */
    @ApiMember(DataType="bool", Description="If true, the role will be pending for a contact until they accept it.", Name="RequireContactsToAccept", ParameterType="query")
    open var RequireContactsToAccept:Boolean? = null

    /**
    * Contact Types that may have this role.
    */
    @ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")
    open var ContactTypes:ArrayList<UUID>? = null

    /**
    * Role Filters this role should be added to.
    */
    @ApiMember(DataType="List<Guid>", Description="Role Filters this role should be added to.", Name="ListItemFilters", ParameterType="query")
    open var ListItemFilters:ArrayList<UUID>? = null
}

Kotlin SaveContactRole DTOs

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

HTTP + JSV

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

POST /jsv/reply/SaveContactRole HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

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