Trendsic Platform Service

<back to all web services

StaffResponsesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/staff/outreach/responses
"use strict";
export class StaffResponseDto {
    /** @param {{StaffOutreachRecipientID?:number,ContactID?:number,Name?:string,Kind?:string,Rate?:number,Rating?:number,RatingCount?:number,Status?:string,Note?:string,CounterRate?:number,CounterStartDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StaffOutreachRecipientID;
    /** @type {number} */
    ContactID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {number} */
    Rate;
    /** @type {number} */
    Rating;
    /** @type {number} */
    RatingCount;
    /** @type {string} */
    Status;
    /** @type {string} */
    Note;
    /** @type {number} */
    CounterRate;
    /** @type {string} */
    CounterStartDate;
}
export class StaffResponsesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Responses?:StaffResponseDto[],SentCount?:number,OpenedCount?:number,ClickedCount?:number,Accepted?:number,Question?:number,Declined?:number,NoReply?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {StaffResponseDto[]} */
    Responses = [];
    /** @type {number} */
    SentCount;
    /** @type {number} */
    OpenedCount;
    /** @type {number} */
    ClickedCount;
    /** @type {number} */
    Accepted;
    /** @type {number} */
    Question;
    /** @type {number} */
    Declined;
    /** @type {number} */
    NoReply;
}
export class StaffResponsesRequest {
    /** @param {{PlaceholderContactID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PlaceholderContactID;
}

JavaScript StaffResponsesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/staff/outreach/responses HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Responses":[{"StaffOutreachRecipientID":0,"ContactID":0,"Name":"String","Kind":"String","Rate":0,"Rating":0,"RatingCount":0,"Status":"String","Note":"String","CounterRate":0,"CounterStartDate":"String"}],"SentCount":0,"OpenedCount":0,"ClickedCount":0,"Accepted":0,"Question":0,"Declined":0,"NoReply":0}