Platform API

<back to all web services

GetObjectDynamicContent

Get dynamic content for an object.

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

public class dtos
{

    /**
    * Get dynamic content for an object.
    */
    @Api(Description="Get dynamic content for an object.")
    public static class GetObjectDynamicContent
    {
        /**
        * The object id to retrieve dynamic content for.
        */
        @ApiMember(Description="The object id to retrieve dynamic content for.", ParameterType="path")
        public UUID ObjectId = null;

        /**
        * The dynamic content definition id for the type of dynamic content to retrieve.
        */
        @ApiMember(Description="The dynamic content definition id for the type of dynamic content to retrieve.", ParameterType="path")
        public UUID DynamicContentDefinitionId = null;
        
        public UUID getObjectId() { return ObjectId; }
        public GetObjectDynamicContent setObjectId(UUID value) { this.ObjectId = value; return this; }
        public UUID getDynamicContentDefinitionId() { return DynamicContentDefinitionId; }
        public GetObjectDynamicContent setDynamicContentDefinitionId(UUID value) { this.DynamicContentDefinitionId = value; return this; }
    }

    @ApiResponse(Description="Dynamic Content Value")
    public static class GetDynamicContentResponse
    {
        /**
        * Dynamic Content Value.
        */
        @ApiMember(Description="Dynamic Content Value.")
        public ObjectDynamicContentModel DynamicContent = null;

        public ResponseStatus ResponseStatus = null;
        
        public ObjectDynamicContentModel getDynamicContent() { return DynamicContent; }
        public GetDynamicContentResponse setDynamicContent(ObjectDynamicContentModel value) { this.DynamicContent = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetDynamicContentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ObjectDynamicContentModel
    {
        /**
        * The dynamic content Id (PKID)
        */
        @ApiMember(Description="The dynamic content Id (PKID)", ParameterType="query")
        public UUID ObjectDynamicContentId = null;

        /**
        * The object Id this dynamic content record is for.
        */
        @ApiMember(Description="The object Id this dynamic content record is for.", ParameterType="query")
        public UUID ObjectId = 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")
        public UUID DynamicContentDefinitionId = null;

        /**
        * Name of the dynamic content definition
        */
        @ApiMember(Description="Name of the dynamic content definition", ParameterType="query")
        public String DefinitionName = null;

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

        /**
        * Name of the content format
        */
        @ApiMember(Description="Name of the content format", ParameterType="query")
        public String ContentFormat = null;

        /**
        * The content string regardless of the format.
        */
        @ApiMember(Description="The content string regardless of the format.", ParameterType="query")
        public String Content = null;

        /**
        * XML content if the format is XML
        */
        @ApiMember(Description="XML content if the format is XML", ParameterType="query")
        public String XmlContent = 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")
        public UUID OwnerContactId = null;

        /**
        * Record Status of the dynamic content
        */
        @ApiMember(Description="Record Status of the dynamic content", ParameterType="query")
        public String RecordStatus = null;
        
        public UUID getObjectDynamicContentId() { return ObjectDynamicContentId; }
        public ObjectDynamicContentModel setObjectDynamicContentId(UUID value) { this.ObjectDynamicContentId = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public ObjectDynamicContentModel setObjectId(UUID value) { this.ObjectId = value; return this; }
        public UUID getDynamicContentDefinitionId() { return DynamicContentDefinitionId; }
        public ObjectDynamicContentModel setDynamicContentDefinitionId(UUID value) { this.DynamicContentDefinitionId = value; return this; }
        public String getDefinitionName() { return DefinitionName; }
        public ObjectDynamicContentModel setDefinitionName(String value) { this.DefinitionName = value; return this; }
        public UUID getContentFormatId() { return ContentFormatId; }
        public ObjectDynamicContentModel setContentFormatId(UUID value) { this.ContentFormatId = value; return this; }
        public String getContentFormat() { return ContentFormat; }
        public ObjectDynamicContentModel setContentFormat(String value) { this.ContentFormat = value; return this; }
        public String getContent() { return Content; }
        public ObjectDynamicContentModel setContent(String value) { this.Content = value; return this; }
        public String getXmlContent() { return XmlContent; }
        public ObjectDynamicContentModel setXmlContent(String value) { this.XmlContent = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public ObjectDynamicContentModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ObjectDynamicContentModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java GetObjectDynamicContent DTOs

GET /api/dynamiccontent/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv

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

{"DynamicContent":{"ObjectDynamicContentId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","DynamicContentDefinitionId":"00000000-0000-0000-0000-000000000000","DefinitionName":"String","ContentFormatId":"00000000-0000-0000-0000-000000000000","ContentFormat":"String","Content":"String","XmlContent":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}