Trendsic Platform Service

<back to all web services

RecordGetRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/entry/{RecordKey}
import Foundation
import ServiceStack

public class RecordGetRequest : Codable
{
    public var recordKey:String

    required public init(){}
}

public class RecordGetResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var record:RecordDto

    required public init(){}
}

public class RecordDto : Codable
{
    public var recordId:Int
    public var recordKey:String
    public var name:String
    public var seriesId:Int?
    public var seriesKey:String
    public var classification:String
    public var format:String
    public var phase:String
    public var triggerDate:String
    public var staged:Bool
    public var holdId:Int?
    public var holdKey:String
    public var ownerName:String
    public var branch:String
    public var barcode:String
    public var locJson:String
    public var metaJson:String
    public var filesJson:String
    public var versionsJson:String
    public var relatedJson:String
    public var disposedJson:String
    public var createdLabel:String
    public var updatedLabel:String
    public var lifecycle:String
    public var retKind:String
    public var eligibleDate:String
    public var monthsLeft:Int

    required public init(){}
}


Swift RecordGetRequest 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/entry/{RecordKey} 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
		}
	},
	Record: 
	{
		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
	}
}