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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ProviderView() = 
        member val Key:String = null with get,set
        member val Name:String = null with get,set
        member val Category:String = null with get,set
        member val Blurb:String = null with get,set
        member val Mono:String = null with get,set
        member val AuthMode:String = null with get,set
        member val Available:Boolean = new Boolean() with get,set
        member val Status:String = null with get,set
        member val Health:String = null with get,set
        member val StatusDetail:String = null with get,set
        member val AccountLabel:String = null with get,set
        member val Environment:String = null with get,set
        member val LastActivityAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ManageRoute:String = null with get,set
        member val Actions:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type IntegrationsActionResponse() = 
        member val Ok:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val Url:String = null with get,set
        member val Provider:ProviderView = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type IntegrationsActionRequest() = 
        member val Provider:String = null with get,set
        member val Action:String = null with get,set
        member val ApiKey:String = null with get,set
        member val FromDate:String = null with get,set
        member val ToDate:String = null with get,set

F# IntegrationsActionRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Provider: String,
	Action: String,
	ApiKey: String,
	FromDate: String,
	ToDate: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Ok: False,
	Message: String,
	Url: String,
	Provider: 
	{
		Key: String,
		Name: String,
		Category: String,
		Blurb: String,
		Mono: String,
		AuthMode: String,
		Available: False,
		Status: String,
		Health: String,
		StatusDetail: String,
		AccountLabel: String,
		Environment: String,
		LastActivityAt: 0001-01-01,
		ManageRoute: String,
		Actions: 
		[
			String
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}