| GET | /api/dynamiccontent/{ObjectId} | ||
|---|---|---|---|
| GET | /api/dynamiccontent/{ObjectId}/mastertasklinks |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectDynamicContentModel:
# @ApiMember(Description="The dynamic content Id (PKID)", ParameterType="query")
object_dynamic_content_id: Optional[str] = None
"""
The dynamic content Id (PKID)
"""
# @ApiMember(Description="The object Id this dynamic content record is for.", ParameterType="query")
object_id: Optional[str] = None
"""
The object Id this dynamic content record is for.
"""
# @ApiMember(Description="The dynamic content definition id that indicates what this dynamic content contains", ParameterType="query")
dynamic_content_definition_id: Optional[str] = None
"""
The dynamic content definition id that indicates what this dynamic content contains
"""
# @ApiMember(Description="Name of the dynamic content definition", ParameterType="query")
definition_name: Optional[str] = None
"""
Name of the dynamic content definition
"""
# @ApiMember(Description="The format Id the dynamic content is saved as", ParameterType="query")
content_format_id: Optional[str] = None
"""
The format Id the dynamic content is saved as
"""
# @ApiMember(Description="Name of the content format", ParameterType="query")
content_format: Optional[str] = None
"""
Name of the content format
"""
# @ApiMember(Description="The content string regardless of the format.", ParameterType="query")
content: Optional[str] = None
"""
The content string regardless of the format.
"""
# @ApiMember(Description="XML content if the format is XML", ParameterType="query")
xml_content: Optional[str] = None
"""
XML content if the format is XML
"""
# @ApiMember(Description="The contact id of the licensee who owns this record", ParameterType="query")
owner_contact_id: Optional[str] = None
"""
The contact id of the licensee who owns this record
"""
# @ApiMember(Description="Record Status of the dynamic content", ParameterType="query")
record_status: Optional[str] = None
"""
Record Status of the dynamic content
"""
# @ApiResponse(Description="Dynamic Content Value")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDynamicContentResponse:
# @ApiMember(Description="Dynamic Content Value.")
dynamic_content: Optional[ObjectDynamicContentModel] = None
"""
Dynamic Content Value.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get dynamic content for an object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectDynamicContent:
"""
Get dynamic content for an object.
"""
# @ApiMember(Description="The object id to retrieve dynamic content for.", ParameterType="path")
object_id: Optional[str] = None
"""
The object id to retrieve dynamic content for.
"""
# @ApiMember(Description="The dynamic content definition id for the type of dynamic content to retrieve.", ParameterType="path")
dynamic_content_definition_id: Optional[str] = None
"""
The dynamic content definition id for the type of dynamic content to retrieve.
"""
Python GetObjectDynamicContent DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
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>