Platform Subscription API

<back to all web services

SaveContactRole

"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

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

<SaveContactRole 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>
  <ContactRole>
    <ContactTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </ContactTypes>
    <ListItemFilters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </ListItemFilters>
    <RequireContactsToAccept>false</RequireContactsToAccept>
    <RoleDescription>String</RoleDescription>
    <RoleName>String</RoleName>
    <RoleShortName>String</RoleShortName>
  </ContactRole>
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</SaveContactRole>

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>