Platform API

SaveDynamicContent

Add or update dynamic content.

The following routes are available for this service:
PUT	/api/dynamiccontent/{ObjectDynamicContentId}
POST	/api/dynamiccontent/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Add or update dynamic content.
*/
@Api(Description="Add or update dynamic content.")
open class SaveDynamicContent
{
    /**
    * Dynamic Content details.
    */
    @ApiMember(Description="Dynamic Content details.")
    open var DynamicContent:ObjectDynamicContentModel? = null

    /**
    * Id of the Dynamic Content record.
    */
    @ApiMember(Description="Id of the Dynamic Content record.", ParameterType="path")
    open var ObjectDynamicContentId:UUID? = null
}

open class ObjectDynamicContentModel
{
    /**
    * The dynamic content Id (PKID)
    */
    @ApiMember(Description="The dynamic content Id (PKID)", ParameterType="query")
    open var ObjectDynamicContentId:UUID? = null

    /**
    * The object Id this dynamic content record is for.
    */
    @ApiMember(Description="The object Id this dynamic content record is for.", ParameterType="query")
    open var ObjectId:UUID? = null

    /**
    * The dynamic content definition id that indicates what this dynamic content contains
    */
    @ApiMember(Description="The dynamic content definition id that indicates what this dynamic content contains", ParameterType="query")
    open var DynamicContentDefinitionId:UUID? = null

    /**
    * Name of the dynamic content definition
    */
    @ApiMember(Description="Name of the dynamic content definition", ParameterType="query")
    open var DefinitionName:String? = null

    /**
    * The format Id the dynamic content is saved as
    */
    @ApiMember(Description="The format Id the dynamic content is saved as", ParameterType="query")
    open var ContentFormatId:UUID? = null

    /**
    * Name of the content format
    */
    @ApiMember(Description="Name of the content format", ParameterType="query")
    open var ContentFormat:String? = null

    /**
    * The content string regardless of the format.
    */
    @ApiMember(Description="The content string regardless of the format.", ParameterType="query")
    open var Content:String? = null

    /**
    * XML content if the format is XML
    */
    @ApiMember(Description="XML content if the format is XML", ParameterType="query")
    open var XmlContent:String? = null

    /**
    * The contact id of the licensee who owns this record
    */
    @ApiMember(Description="The contact id of the licensee who owns this record", ParameterType="query")
    open var OwnerContactId:UUID? = null

    /**
    * Record Status of the dynamic content
    */
    @ApiMember(Description="Record Status of the dynamic content", ParameterType="query")
    open var RecordStatus:String? = null
}

@ApiResponse(Description="Dynamic Content Value")
open class GetDynamicContentResponse
{
    /**
    * Dynamic Content Value.
    */
    @ApiMember(Description="Dynamic Content Value.")
    open var DynamicContent:ObjectDynamicContentModel? = null

    open var ResponseStatus:ResponseStatus? = null
}

Kotlin SaveDynamicContent DTOs

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

HTTP + JSV

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

POST /api/dynamiccontent/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DynamicContent: 
	{
		DefinitionName: String,
		ContentFormat: String,
		Content: String,
		XmlContent: String,
		RecordStatus: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DynamicContent: 
	{
		DefinitionName: String,
		ContentFormat: String,
		Content: String,
		XmlContent: String,
		RecordStatus: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}