Platform API

<back to all web services

SaveDynamicContent

Add or update dynamic content.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Subtle.Canvara.WebAPIModel.Models;

namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
    public partial class ObjectDynamicContentModel
    {
        ///<summary>
        ///The dynamic content Id (PKID)
        ///</summary>
        [ApiMember(Description="The dynamic content Id (PKID)", ParameterType="query")]
        public virtual Guid ObjectDynamicContentId { get; set; }

        ///<summary>
        ///The object Id this dynamic content record is for.
        ///</summary>
        [ApiMember(Description="The object Id this dynamic content record is for.", ParameterType="query")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///The dynamic content definition id that indicates what this dynamic content contains
        ///</summary>
        [ApiMember(Description="The dynamic content definition id that indicates what this dynamic content contains", ParameterType="query")]
        public virtual Guid DynamicContentDefinitionId { get; set; }

        ///<summary>
        ///Name of the dynamic content definition
        ///</summary>
        [ApiMember(Description="Name of the dynamic content definition", ParameterType="query")]
        public virtual string DefinitionName { get; set; }

        ///<summary>
        ///The format Id the dynamic content is saved as
        ///</summary>
        [ApiMember(Description="The format Id the dynamic content is saved as", ParameterType="query")]
        public virtual Guid ContentFormatId { get; set; }

        ///<summary>
        ///Name of the content format
        ///</summary>
        [ApiMember(Description="Name of the content format", ParameterType="query")]
        public virtual string ContentFormat { get; set; }

        ///<summary>
        ///The content string regardless of the format.
        ///</summary>
        [ApiMember(Description="The content string regardless of the format.", ParameterType="query")]
        public virtual string Content { get; set; }

        ///<summary>
        ///XML content if the format is XML
        ///</summary>
        [ApiMember(Description="XML content if the format is XML", ParameterType="query")]
        public virtual string XmlContent { get; set; }

        ///<summary>
        ///The contact id of the licensee who owns this record
        ///</summary>
        [ApiMember(Description="The contact id of the licensee who owns this record", ParameterType="query")]
        public virtual Guid OwnerContactId { get; set; }

        ///<summary>
        ///Record Status of the dynamic content
        ///</summary>
        [ApiMember(Description="Record Status of the dynamic content", ParameterType="query")]
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    [ApiResponse(Description="Dynamic Content Value")]
    public partial class GetDynamicContentResponse
    {
        ///<summary>
        ///Dynamic Content Value.
        ///</summary>
        [ApiMember(Description="Dynamic Content Value.")]
        public virtual ObjectDynamicContentModel DynamicContent { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    ///<summary>
    ///Add or update dynamic content.
    ///</summary>
    [Api(Description="Add or update dynamic content.")]
    public partial class SaveDynamicContent
    {
        ///<summary>
        ///Dynamic Content details.
        ///</summary>
        [ApiMember(Description="Dynamic Content details.")]
        public virtual ObjectDynamicContentModel DynamicContent { get; set; }

        ///<summary>
        ///Id of the Dynamic Content record.
        ///</summary>
        [ApiMember(Description="Id of the Dynamic Content record.", ParameterType="path")]
        public virtual Guid ObjectDynamicContentId { get; set; }
    }

}

C# SaveDynamicContent DTOs

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
		}
	}
}