Trendsic Platform Service

<back to all web services

RecordsSearchRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/search
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class RecordDto
    {
        public virtual int RecordId { get; set; }
        public virtual string RecordKey { get; set; }
        public virtual string Name { get; set; }
        public virtual int? SeriesId { get; set; }
        public virtual string SeriesKey { get; set; }
        public virtual string Classification { get; set; }
        public virtual string Format { get; set; }
        public virtual string Phase { get; set; }
        public virtual string TriggerDate { get; set; }
        public virtual bool Staged { get; set; }
        public virtual int? HoldId { get; set; }
        public virtual string HoldKey { get; set; }
        public virtual string OwnerName { get; set; }
        public virtual string Branch { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string LocJson { get; set; }
        public virtual string MetaJson { get; set; }
        public virtual string FilesJson { get; set; }
        public virtual string VersionsJson { get; set; }
        public virtual string RelatedJson { get; set; }
        public virtual string DisposedJson { get; set; }
        public virtual string CreatedLabel { get; set; }
        public virtual string UpdatedLabel { get; set; }
        public virtual string Lifecycle { get; set; }
        public virtual string RetKind { get; set; }
        public virtual string EligibleDate { get; set; }
        public virtual int MonthsLeft { get; set; }
    }

    public partial class RecordsSearchRequest
    {
        public virtual string Q { get; set; }
        public virtual int Page { get; set; }
        public virtual int PageSize { get; set; }
    }

    public partial class RecordsSearchResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<RecordDto> Records { get; set; } = [];
    }

}

C# RecordsSearchRequest 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.

GET /v1/records/search 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
		}
	},
	Records: 
	[
		{
			RecordId: 0,
			RecordKey: String,
			Name: String,
			SeriesId: 0,
			SeriesKey: String,
			Classification: String,
			Format: String,
			Phase: String,
			TriggerDate: String,
			Staged: False,
			HoldId: 0,
			HoldKey: String,
			OwnerName: String,
			Branch: String,
			Barcode: String,
			LocJson: String,
			MetaJson: String,
			FilesJson: String,
			VersionsJson: String,
			RelatedJson: String,
			DisposedJson: String,
			CreatedLabel: String,
			UpdatedLabel: String,
			Lifecycle: String,
			RetKind: String,
			EligibleDate: String,
			MonthsLeft: 0
		}
	]
}