Trendsic Platform Service

FormListRequest

The following routes are available for this service:
GET	/v1/forms

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 FormStats:
    total: int = 0
    need_decision: int = 0
    waiting: int = 0
    overdue: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormCard:
    form_u_i_d: Optional[str] = None
    name: Optional[str] = None
    slug: Optional[str] = None
    noun: Optional[str] = None
    number_prefix: Optional[str] = None
    description: Optional[str] = None
    tone: Optional[str] = None
    status: Optional[str] = None
    published_version_no: Optional[int] = None
    published_at: Optional[datetime.datetime] = None
    published_by: Optional[str] = None
    draft_dirty: bool = False
    draft_updated_at: Optional[datetime.datetime] = None
    draft_updated_by: Optional[str] = None
    pack_label: Optional[str] = None
    settings_json: Optional[str] = None
    stats: Optional[FormStats] = None
    offered: List[str] = field(default_factory=list)
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormListResponse:
    forms: List[FormCard] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormListRequest:
    pass

Python FormListRequest 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.

GET /v1/forms HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<FormListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Forms>
    <FormCard>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Description>String</Description>
      <DraftDirty>false</DraftDirty>
      <DraftUpdatedAt>0001-01-01T00:00:00</DraftUpdatedAt>
      <DraftUpdatedBy>String</DraftUpdatedBy>
      <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
      <Name>String</Name>
      <Noun>String</Noun>
      <NumberPrefix>String</NumberPrefix>
      <Offered xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Offered>
      <PackLabel>String</PackLabel>
      <PublishedAt>0001-01-01T00:00:00</PublishedAt>
      <PublishedBy>String</PublishedBy>
      <PublishedVersionNo>0</PublishedVersionNo>
      <SettingsJson>String</SettingsJson>
      <Slug>String</Slug>
      <Stats>
        <NeedDecision>0</NeedDecision>
        <Overdue>0</Overdue>
        <Total>0</Total>
        <Waiting>0</Waiting>
      </Stats>
      <Status>String</Status>
      <Tone>String</Tone>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </FormCard>
  </Forms>
  <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>
</FormListResponse>