Trendsic Platform Service

<back to all web services

IntegrationsActionRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/integrations/{Provider}/{Action}
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 ProviderView:
    key: Optional[str] = None
    name: Optional[str] = None
    category: Optional[str] = None
    blurb: Optional[str] = None
    mono: Optional[str] = None
    auth_mode: Optional[str] = None
    available: bool = False
    status: Optional[str] = None
    health: Optional[str] = None
    status_detail: Optional[str] = None
    account_label: Optional[str] = None
    environment: Optional[str] = None
    last_activity_at: Optional[datetime.datetime] = None
    manage_route: Optional[str] = None
    actions: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationsActionResponse:
    ok: bool = False
    message: Optional[str] = None
    url: Optional[str] = None
    provider: Optional[ProviderView] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationsActionRequest:
    provider: Optional[str] = None
    action: Optional[str] = None
    api_key: Optional[str] = None
    from_date: Optional[str] = None
    to_date: Optional[str] = None

Python IntegrationsActionRequest 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 /v1/integrations/{Provider}/{Action} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IntegrationsActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Action>String</Action>
  <ApiKey>String</ApiKey>
  <FromDate>String</FromDate>
  <Provider>String</Provider>
  <ToDate>String</ToDate>
</IntegrationsActionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IntegrationsActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Message>String</Message>
  <Ok>false</Ok>
  <Provider>
    <AccountLabel>String</AccountLabel>
    <Actions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Actions>
    <AuthMode>String</AuthMode>
    <Available>false</Available>
    <Blurb>String</Blurb>
    <Category>String</Category>
    <Environment>String</Environment>
    <Health>String</Health>
    <Key>String</Key>
    <LastActivityAt>0001-01-01T00:00:00</LastActivityAt>
    <ManageRoute>String</ManageRoute>
    <Mono>String</Mono>
    <Name>String</Name>
    <Status>String</Status>
    <StatusDetail>String</StatusDetail>
  </Provider>
  <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>
  <Url>String</Url>
</IntegrationsActionResponse>