Trendsic Platform Service

<back to all web services

ApsTestRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/aps/test
"use strict";
export class ApsConfigResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Connected?:boolean,ClientIdMasked?:string,HasSecret?:boolean,BucketKey?:string,ConnectedAt?:string,LastCheck?:string,TestOk?:boolean,TestMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Connected;
    /** @type {string} */
    ClientIdMasked;
    /** @type {boolean} */
    HasSecret;
    /** @type {string} */
    BucketKey;
    /** @type {string} */
    ConnectedAt;
    /** @type {string} */
    LastCheck;
    /** @type {?boolean} */
    TestOk;
    /** @type {string} */
    TestMessage;
}
export class ApsTestRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ApsTestRequest 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/aps/test HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ApsTestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal" />

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

<ApsConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BucketKey>String</BucketKey>
  <ClientIdMasked>String</ClientIdMasked>
  <Connected>false</Connected>
  <ConnectedAt>String</ConnectedAt>
  <HasSecret>false</HasSecret>
  <LastCheck>String</LastCheck>
  <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>
  <TestMessage>String</TestMessage>
  <TestOk>false</TestOk>
</ApsConfigResponse>