Jump to: navigation, search

RenderFieldCodes

Purpose

The purpose is to replace the field codes with the current values in a template text.

URL

  • POST /OMFieldCodes/RenderFieldCodes/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
Text String Text to parse true true
Interaction KVList false true
Contact KVList false true
Agent KVList false true
CustomProperties KVList false true


Interaction KVList

Key ValueType Value Description Mandatory Unique Default
Id String false true
Subject String false true
StartDate String Formatted with the pattern: "yyyy-MM-ddTHH:mm:ss.SSSZ" false true
TimeZone String false true
ToAddress String false true
FromAddress String false true
AttachedData KVList false false
OtherProperty KVList false false


Contact KVList

Key ValueType Value Description Mandatory Unique Default
Id String false true
FirstName String false true
LastName String false true
FullName String false true
Title String false true
PrimaryEmailAddress String false true
PrimaryPhoneNumber String false true
OtherProperty KVList false false


Agent KVList

Key ValueType Value Description Mandatory Unique Default
FirstName String false true
LastName String false true
FullName String false true
Signature String false true
OtherProperty KVList false false


CustomProperties KVList

Key ValueType Value Description Mandatory Unique Default
OtherProperty KVList false false


OtherProperty and AttachedData KVList

Key ValueType Value Description Mandatory Unique Default
Name String The name should be unique among all "Property" KVLists (within all Interaction Property KVLists for example, there should be one "DateCreated" key at maximum) true true
Value String false false


Sample

Text Text to render
Interaction Subject MySubject
DateCreated 04/14/08 17:07:05
AttachedData Name Adata_1
Value Value_1
AttachedData Name Adata_2
Value Value2
OtherProperty Name Udata_1
Value Value_1
OtherProperty Name UData_2
Value Value_2
Contact PrimaryEmailAddress john@doe.com
OtherProperty Name UData_1
Value Value_1

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Text String Result text false false
Success String true or false Is true if the text was rendered without errors false false

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.