| PUT | /api/dynamiccontent/{ObjectDynamicContentId} | ||
|---|---|---|---|
| POST | /api/dynamiccontent/ |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DynamicContent | body | ObjectDynamicContentModel | No | Dynamic Content details. |
| ObjectDynamicContentId | path | Guid | No | Id of the Dynamic Content record. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectDynamicContentId | query | Guid | No | The dynamic content Id (PKID) |
| ObjectId | query | Guid | No | The object Id this dynamic content record is for. |
| DynamicContentDefinitionId | query | Guid | No | The dynamic content definition id that indicates what this dynamic content contains |
| DefinitionName | query | string | No | Name of the dynamic content definition |
| ContentFormatId | query | Guid | No | The format Id the dynamic content is saved as |
| ContentFormat | query | string | No | Name of the content format |
| Content | query | string | No | The content string regardless of the format. |
| XmlContent | query | string | No | XML content if the format is XML |
| OwnerContactId | query | Guid | No | The contact id of the licensee who owns this record |
| RecordStatus | query | string | No | Record Status of the dynamic content |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DynamicContent | form | ObjectDynamicContentModel | No | Dynamic Content Value. |
| ResponseStatus | form | ResponseStatus | No |
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
}
}
}