Platform API

<back to all web services

SaveDynamicContent

Add or update dynamic content.

Requires Authentication
The following routes are available for this service:
PUT/api/dynamiccontent/{ObjectDynamicContentId}
POST/api/dynamiccontent/
SaveDynamicContent Parameters:
NameParameterData TypeRequiredDescription
DynamicContentbodyObjectDynamicContentModelNoDynamic Content details.
ObjectDynamicContentIdpathGuidNoId of the Dynamic Content record.
ObjectDynamicContentModel Parameters:
NameParameterData TypeRequiredDescription
ObjectDynamicContentIdqueryGuidNoThe dynamic content Id (PKID)
ObjectIdqueryGuidNoThe object Id this dynamic content record is for.
DynamicContentDefinitionIdqueryGuidNoThe dynamic content definition id that indicates what this dynamic content contains
DefinitionNamequerystringNoName of the dynamic content definition
ContentFormatIdqueryGuidNoThe format Id the dynamic content is saved as
ContentFormatquerystringNoName of the content format
ContentquerystringNoThe content string regardless of the format.
XmlContentquerystringNoXML content if the format is XML
OwnerContactIdqueryGuidNoThe contact id of the licensee who owns this record
RecordStatusquerystringNoRecord Status of the dynamic content
GetDynamicContentResponse Parameters:
NameParameterData TypeRequiredDescription
DynamicContentformObjectDynamicContentModelNoDynamic Content Value.
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
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"},"ObjectDynamicContentId":"00000000-0000-0000-0000-000000000000"}
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"}}}