Platform Subscription API

<back to all web services

SaveContactRole

Requires Authentication
"use strict";
export class RuleValidationResult {
    /** @param {{RuleCode?:string,Message?:string,Key?:string,Tag?:string,ErrorCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RuleCode;
    /** @type {string} */
    Message;
    /** @type {string} */
    Key;
    /** @type {string} */
    Tag;
    /** @type {string} */
    ErrorCode;
}
export class ValidationErrorList {
    /** @param {{ValidationErrors?:RuleValidationResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RuleValidationResult[]} */
    ValidationErrors;
}
export class SubscriptionContactRoleModel {
    /** @param {{RoleName?:string,RoleShortName?:string,RoleDescription?:string,RequireContactsToAccept?:boolean,ContactTypes?:string[],ListItemFilters?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Name of the role. */
    RoleName;
    /**
     * @type {string}
     * @description Short version of the role name. */
    RoleShortName;
    /**
     * @type {string}
     * @description Description of the role purpose. */
    RoleDescription;
    /**
     * @type {boolean}
     * @description If true, the role will be pending for a contact until they accept it. */
    RequireContactsToAccept;
    /**
     * @type {string[]}
     * @description Contact Types that may have this role. */
    ContactTypes;
    /**
     * @type {string[]}
     * @description Role Filters this role should be added to. */
    ListItemFilters;
}
export class SaveContactRole extends ValidationErrorList {
    /** @param {{SuiteDataSourceInstanceId?:string,AlternateKey?:string,ObjectId?:string,ContactRole?:SubscriptionContactRoleModel,IgnoreValidation?:boolean,ValidationErrors?:RuleValidationResult[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid representing the external systems data source information. */
    SuiteDataSourceInstanceId;
    /**
     * @type {string}
     * @description The unique key that represents the contact role on the external system. */
    AlternateKey;
    /**
     * @type {string}
     * @description Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key. */
    ObjectId;
    /**
     * @type {SubscriptionContactRoleModel}
     * @description Object containing all details of the contact role to be inserted or updated. */
    ContactRole;
    /** @type {boolean} */
    IgnoreValidation;
}

JavaScript 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
	}
}