| GET | /api/dynamiccontent/{ObjectId} | ||
|---|---|---|---|
| GET | /api/dynamiccontent/{ObjectId}/mastertasklinks |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | path | Guid | No | The object id to retrieve dynamic content for. |
| DynamicContentDefinitionId | path | Guid | No | The dynamic content definition id for the type of dynamic content to retrieve. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DynamicContent | form | ObjectDynamicContentModel | No | Dynamic Content Value. |
| ResponseStatus | form | ResponseStatus | No |
| 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/dynamiccontent/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}