Platform API

<back to all web services

GetObjectDynamicContent

Get dynamic content for an object.

Requires Authentication
The following routes are available for this service:
GET/api/dynamiccontent/{ObjectId}
GET/api/dynamiccontent/{ObjectId}/mastertasklinks
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class ObjectDynamicContentModel
            '''<Summary>
            '''The dynamic content Id (PKID)
            '''</Summary>
            <ApiMember(Description:="The dynamic content Id (PKID)", ParameterType:="query")>
            Public Overridable Property ObjectDynamicContentId As Guid

            '''<Summary>
            '''The object Id this dynamic content record is for.
            '''</Summary>
            <ApiMember(Description:="The object Id this dynamic content record is for.", ParameterType:="query")>
            Public Overridable Property ObjectId As Guid

            '''<Summary>
            '''The dynamic content definition id that indicates what this dynamic content contains
            '''</Summary>
            <ApiMember(Description:="The dynamic content definition id that indicates what this dynamic content contains", ParameterType:="query")>
            Public Overridable Property DynamicContentDefinitionId As Guid

            '''<Summary>
            '''Name of the dynamic content definition
            '''</Summary>
            <ApiMember(Description:="Name of the dynamic content definition", ParameterType:="query")>
            Public Overridable Property DefinitionName As String

            '''<Summary>
            '''The format Id the dynamic content is saved as
            '''</Summary>
            <ApiMember(Description:="The format Id the dynamic content is saved as", ParameterType:="query")>
            Public Overridable Property ContentFormatId As Guid

            '''<Summary>
            '''Name of the content format
            '''</Summary>
            <ApiMember(Description:="Name of the content format", ParameterType:="query")>
            Public Overridable Property ContentFormat As String

            '''<Summary>
            '''The content string regardless of the format.
            '''</Summary>
            <ApiMember(Description:="The content string regardless of the format.", ParameterType:="query")>
            Public Overridable Property Content As String

            '''<Summary>
            '''XML content if the format is XML
            '''</Summary>
            <ApiMember(Description:="XML content if the format is XML", ParameterType:="query")>
            Public Overridable Property XmlContent As String

            '''<Summary>
            '''The contact id of the licensee who owns this record
            '''</Summary>
            <ApiMember(Description:="The contact id of the licensee who owns this record", ParameterType:="query")>
            Public Overridable Property OwnerContactId As Guid

            '''<Summary>
            '''Record Status of the dynamic content
            '''</Summary>
            <ApiMember(Description:="Record Status of the dynamic content", ParameterType:="query")>
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        <ApiResponse(Description:="Dynamic Content Value")>
        Public Partial Class GetDynamicContentResponse
            '''<Summary>
            '''Dynamic Content Value.
            '''</Summary>
            <ApiMember(Description:="Dynamic Content Value.")>
            Public Overridable Property DynamicContent As ObjectDynamicContentModel

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        '''<Summary>
        '''Get dynamic content for an object.
        '''</Summary>
        <Api(Description:="Get dynamic content for an object.")>
        Public Partial Class GetObjectDynamicContent
            '''<Summary>
            '''The object id to retrieve dynamic content for.
            '''</Summary>
            <ApiMember(Description:="The object id to retrieve dynamic content for.", ParameterType:="path")>
            Public Overridable Property ObjectId As Guid

            '''<Summary>
            '''The dynamic content definition id for the type of dynamic content to retrieve.
            '''</Summary>
            <ApiMember(Description:="The dynamic content definition id for the type of dynamic content to retrieve.", ParameterType:="path")>
            Public Overridable Property DynamicContentDefinitionId As Guid
        End Class
    End Namespace
End Namespace

VB.NET GetObjectDynamicContent DTOs

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

HTTP + JSON

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