| PUT | /api/dynamiccontent/{ObjectDynamicContentId} | ||
|---|---|---|---|
| POST | /api/dynamiccontent/ |
"use strict";
export class ObjectDynamicContentModel {
/** @param {{ObjectDynamicContentId?:string,ObjectId?:string,DynamicContentDefinitionId?:string,DefinitionName?:string,ContentFormatId?:string,ContentFormat?:string,Content?:string,XmlContent?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The dynamic content Id (PKID) */
ObjectDynamicContentId;
/**
* @type {string}
* @description The object Id this dynamic content record is for. */
ObjectId;
/**
* @type {string}
* @description The dynamic content definition id that indicates what this dynamic content contains */
DynamicContentDefinitionId;
/**
* @type {string}
* @description Name of the dynamic content definition */
DefinitionName;
/**
* @type {string}
* @description The format Id the dynamic content is saved as */
ContentFormatId;
/**
* @type {string}
* @description Name of the content format */
ContentFormat;
/**
* @type {string}
* @description The content string regardless of the format. */
Content;
/**
* @type {string}
* @description XML content if the format is XML */
XmlContent;
/**
* @type {string}
* @description The contact id of the licensee who owns this record */
OwnerContactId;
/**
* @type {string}
* @description Record Status of the dynamic content */
RecordStatus;
}
export class GetDynamicContentResponse {
/** @param {{DynamicContent?:ObjectDynamicContentModel,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ObjectDynamicContentModel}
* @description Dynamic Content Value. */
DynamicContent;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class SaveDynamicContent {
/** @param {{DynamicContent?:ObjectDynamicContentModel,ObjectDynamicContentId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ObjectDynamicContentModel}
* @description Dynamic Content details. */
DynamicContent;
/**
* @type {string}
* @description Id of the Dynamic Content record. */
ObjectDynamicContentId;
}
JavaScript SaveDynamicContent DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}