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/
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>
        '''Add or update dynamic content.
        '''</Summary>
        <Api(Description:="Add or update dynamic content.")>
        Public Partial Class SaveDynamicContent
            '''<Summary>
            '''Dynamic Content details.
            '''</Summary>
            <ApiMember(Description:="Dynamic Content details.")>
            Public Overridable Property DynamicContent As ObjectDynamicContentModel

            '''<Summary>
            '''Id of the Dynamic Content record.
            '''</Summary>
            <ApiMember(Description:="Id of the Dynamic Content record.", ParameterType:="path")>
            Public Overridable Property ObjectDynamicContentId As Guid
        End Class
    End Namespace
End Namespace

VB.NET SaveDynamicContent DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SaveDynamicContent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DynamicContent xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentFormat>String</d2p1:ContentFormat>
    <d2p1:ContentFormatId>00000000-0000-0000-0000-000000000000</d2p1:ContentFormatId>
    <d2p1:DefinitionName>String</d2p1:DefinitionName>
    <d2p1:DynamicContentDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:DynamicContentDefinitionId>
    <d2p1:ObjectDynamicContentId>00000000-0000-0000-0000-000000000000</d2p1:ObjectDynamicContentId>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:XmlContent>String</d2p1:XmlContent>
  </DynamicContent>
  <ObjectDynamicContentId>00000000-0000-0000-0000-000000000000</ObjectDynamicContentId>
</SaveDynamicContent>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDynamicContentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DynamicContent xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentFormat>String</d2p1:ContentFormat>
    <d2p1:ContentFormatId>00000000-0000-0000-0000-000000000000</d2p1:ContentFormatId>
    <d2p1:DefinitionName>String</d2p1:DefinitionName>
    <d2p1:DynamicContentDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:DynamicContentDefinitionId>
    <d2p1:ObjectDynamicContentId>00000000-0000-0000-0000-000000000000</d2p1:ObjectDynamicContentId>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:XmlContent>String</d2p1:XmlContent>
  </DynamicContent>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDynamicContentResponse>