Platform Subscription API

<back to all web services

SaveContactRole

Requires Authentication

export class RuleValidationResult
{
    public RuleCode: string;
    public Message: string;
    public Key: string;
    public Tag: string;
    public ErrorCode: string;

    public constructor(init?: Partial<RuleValidationResult>) { (Object as any).assign(this, init); }
}

export class ValidationErrorList
{
    public ValidationErrors: RuleValidationResult[];

    public constructor(init?: Partial<ValidationErrorList>) { (Object as any).assign(this, init); }
}

export class SubscriptionContactRoleModel
{
    /** @description Name of the role. */
    // @ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")
    public RoleName: string;

    /** @description Short version of the role name. */
    // @ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")
    public RoleShortName: string;

    /** @description Description of the role purpose. */
    // @ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")
    public RoleDescription: string;

    /** @description 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")
    public RequireContactsToAccept: boolean;

    /** @description Contact Types that may have this role. */
    // @ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")
    public ContactTypes: string[];

    /** @description 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")
    public ListItemFilters: string[];

    public constructor(init?: Partial<SubscriptionContactRoleModel>) { (Object as any).assign(this, init); }
}

export class SaveContactRole extends ValidationErrorList implements ISubscription
{
    /** @description 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")
    public SuiteDataSourceInstanceId: string;

    /** @description 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")
    public AlternateKey: 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. */
    // @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")
    public ObjectId: string;

    /** @description 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")
    public ContactRole: SubscriptionContactRoleModel;

    public IgnoreValidation: boolean;

    public constructor(init?: Partial<SaveContactRole>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SaveContactRole DTOs

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

HTTP + CSV

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

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

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