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
StaffResponsesRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceholderContactIDqueryintNo
StaffResponsesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResponsesformList<StaffResponseDto>No
SentCountformintNo
OpenedCountformintNo
ClickedCountformintNo
AcceptedformintNo
QuestionformintNo
DeclinedformintNo
NoReplyformintNo
StaffResponseDto Parameters:
NameParameterData TypeRequiredDescription
StaffOutreachRecipientIDformintNo
ContactIDformintNo
NameformstringNo
KindformstringNo
RateformdecimalNo
RatingformdecimalNo
RatingCountformintNo
StatusformstringNo
NoteformstringNo
CounterRateformdecimalNo
CounterStartDateformstringNo

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.

GET /v1/staff/outreach/responses HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}