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}
"use strict";
export class ProviderView {
    /** @param {{Key?:string,Name?:string,Category?:string,Blurb?:string,Mono?:string,AuthMode?:string,Available?:boolean,Status?:string,Health?:string,StatusDetail?:string,AccountLabel?:string,Environment?:string,LastActivityAt?:string,ManageRoute?:string,Actions?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Name;
    /** @type {string} */
    Category;
    /** @type {string} */
    Blurb;
    /** @type {string} */
    Mono;
    /** @type {string} */
    AuthMode;
    /** @type {boolean} */
    Available;
    /** @type {string} */
    Status;
    /** @type {string} */
    Health;
    /** @type {string} */
    StatusDetail;
    /** @type {string} */
    AccountLabel;
    /** @type {string} */
    Environment;
    /** @type {?string} */
    LastActivityAt;
    /** @type {string} */
    ManageRoute;
    /** @type {string[]} */
    Actions = [];
}
export class IntegrationsActionResponse {
    /** @param {{Ok?:boolean,Message?:string,Url?:string,Provider?:ProviderView,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Ok;
    /** @type {string} */
    Message;
    /** @type {string} */
    Url;
    /** @type {ProviderView} */
    Provider;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class IntegrationsActionRequest {
    /** @param {{Provider?:string,Action?:string,ApiKey?:string,FromDate?:string,ToDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Provider;
    /** @type {string} */
    Action;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    FromDate;
    /** @type {string} */
    ToDate;
}

JavaScript 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>