Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/automations
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormAutomationRule
    {
        public virtual int WorkflowId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Sentence { get; set; }
        public virtual string State { get; set; }
        public virtual string StateText { get; set; }
        public virtual string Numbers { get; set; }
        public virtual string Warn { get; set; }
        public virtual bool AnyApplication { get; set; }
        public virtual bool AlsoOthers { get; set; }
        public virtual string SharedText { get; set; }
        public virtual bool FromStarter { get; set; }
        public virtual string EngineLink { get; set; }
    }

    public partial class FormAutomationsRequest
    {
        public virtual Guid FormUID { get; set; }
    }

    public partial class FormAutomationsResponse
    {
        public virtual List<FormAutomationRule> Rules { get; set; } = [];
        public virtual List<FormAutomationStarter> Starters { get; set; } = [];
        public virtual List<FormMappingRow> Mapping { get; set; } = [];
        public virtual string MapSummary { get; set; }
        public virtual bool CanAdd { get; set; }
        public virtual string AddRefusal { get; set; }
        public virtual bool CanToggle { get; set; }
        public virtual bool CanRemove { get; set; }
        public virtual bool CanOpenEngine { get; set; }
        public virtual List<string> ReservedKeys { get; set; } = [];
        public virtual List<string> TestableFields { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class FormAutomationStarter
    {
        public virtual string Key { get; set; }
        public virtual string Name { get; set; }
        public virtual string Text { get; set; }
        public virtual bool Added { get; set; }
    }

    public partial class FormMappingRow
    {
        public virtual string Field { get; set; }
        public virtual string FieldKey { get; set; }
        public virtual string Target { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Note { get; set; }
    }

}

C# FormAutomationsRequest 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.

GET /v1/forms/{FormUID}/automations HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormAutomationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AddRefusal>String</AddRefusal>
  <CanAdd>false</CanAdd>
  <CanOpenEngine>false</CanOpenEngine>
  <CanRemove>false</CanRemove>
  <CanToggle>false</CanToggle>
  <MapSummary>String</MapSummary>
  <Mapping>
    <FormMappingRow>
      <Field>String</Field>
      <FieldKey>String</FieldKey>
      <Note>String</Note>
      <Target>String</Target>
      <Tone>String</Tone>
    </FormMappingRow>
  </Mapping>
  <ReservedKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReservedKeys>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Rules>
    <FormAutomationRule>
      <AlsoOthers>false</AlsoOthers>
      <AnyApplication>false</AnyApplication>
      <EngineLink>String</EngineLink>
      <FromStarter>false</FromStarter>
      <Name>String</Name>
      <Numbers>String</Numbers>
      <Sentence>String</Sentence>
      <SharedText>String</SharedText>
      <State>String</State>
      <StateText>String</StateText>
      <Warn>String</Warn>
      <WorkflowId>0</WorkflowId>
    </FormAutomationRule>
  </Rules>
  <Starters>
    <FormAutomationStarter>
      <Added>false</Added>
      <Key>String</Key>
      <Name>String</Name>
      <Text>String</Text>
    </FormAutomationStarter>
  </Starters>
  <TestableFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TestableFields>
</FormAutomationsResponse>