Platform API

<back to all web services

GetObjectDynamicContent

Get dynamic content for an object.

export class ObjectDynamicContentModel
{
    /** @description The dynamic content Id (PKID) */
    // @ApiMember(Description="The dynamic content Id (PKID)", ParameterType="query")
    public ObjectDynamicContentId: string;

    /** @description The object Id this dynamic content record is for. */
    // @ApiMember(Description="The object Id this dynamic content record is for.", ParameterType="query")
    public ObjectId: string;

    /** @description 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 DynamicContentDefinitionId: string;

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

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

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

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

    /** @description XML content if the format is XML */
    // @ApiMember(Description="XML content if the format is XML", ParameterType="query")
    public XmlContent: string;

    /** @description 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 OwnerContactId: string;

    /** @description Record Status of the dynamic content */
    // @ApiMember(Description="Record Status of the dynamic content", ParameterType="query")
    public RecordStatus: string;

    public constructor(init?: Partial<ObjectDynamicContentModel>) { (Object as any).assign(this, init); }
}

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

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetDynamicContentResponse>) { (Object as any).assign(this, init); }
}

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

    /** @description 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 DynamicContentDefinitionId: string;

    public constructor(init?: Partial<GetObjectDynamicContent>) { (Object as any).assign(this, init); }
}

TypeScript GetObjectDynamicContent DTOs

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

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