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 .xml suffix or ?format=xml

HTTP + XML

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

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>