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 'package:servicestack/servicestack.dart';

class RecordDto implements IConvertible
{
    int? RecordId;
    String? RecordKey;
    String? Name;
    int? SeriesId;
    String? SeriesKey;
    String? Classification;
    String? Format;
    String? Phase;
    String? TriggerDate;
    bool? Staged;
    int? HoldId;
    String? 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;
    int? MonthsLeft;

    RecordDto({this.RecordId,this.RecordKey,this.Name,this.SeriesId,this.SeriesKey,this.Classification,this.Format,this.Phase,this.TriggerDate,this.Staged,this.HoldId,this.HoldKey,this.OwnerName,this.Branch,this.Barcode,this.LocJson,this.MetaJson,this.FilesJson,this.VersionsJson,this.RelatedJson,this.DisposedJson,this.CreatedLabel,this.UpdatedLabel,this.Lifecycle,this.RetKind,this.EligibleDate,this.MonthsLeft});
    RecordDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RecordId = json['RecordId'];
        RecordKey = json['RecordKey'];
        Name = json['Name'];
        SeriesId = json['SeriesId'];
        SeriesKey = json['SeriesKey'];
        Classification = json['Classification'];
        Format = json['Format'];
        Phase = json['Phase'];
        TriggerDate = json['TriggerDate'];
        Staged = json['Staged'];
        HoldId = json['HoldId'];
        HoldKey = json['HoldKey'];
        OwnerName = json['OwnerName'];
        Branch = json['Branch'];
        Barcode = json['Barcode'];
        LocJson = json['LocJson'];
        MetaJson = json['MetaJson'];
        FilesJson = json['FilesJson'];
        VersionsJson = json['VersionsJson'];
        RelatedJson = json['RelatedJson'];
        DisposedJson = json['DisposedJson'];
        CreatedLabel = json['CreatedLabel'];
        UpdatedLabel = json['UpdatedLabel'];
        Lifecycle = json['Lifecycle'];
        RetKind = json['RetKind'];
        EligibleDate = json['EligibleDate'];
        MonthsLeft = json['MonthsLeft'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RecordId': RecordId,
        'RecordKey': RecordKey,
        'Name': Name,
        'SeriesId': SeriesId,
        'SeriesKey': SeriesKey,
        'Classification': Classification,
        'Format': Format,
        'Phase': Phase,
        'TriggerDate': TriggerDate,
        'Staged': Staged,
        'HoldId': HoldId,
        'HoldKey': HoldKey,
        'OwnerName': OwnerName,
        'Branch': Branch,
        'Barcode': Barcode,
        'LocJson': LocJson,
        'MetaJson': MetaJson,
        'FilesJson': FilesJson,
        'VersionsJson': VersionsJson,
        'RelatedJson': RelatedJson,
        'DisposedJson': DisposedJson,
        'CreatedLabel': CreatedLabel,
        'UpdatedLabel': UpdatedLabel,
        'Lifecycle': Lifecycle,
        'RetKind': RetKind,
        'EligibleDate': EligibleDate,
        'MonthsLeft': MonthsLeft
    };

    getTypeName() => "RecordDto";
    TypeContext? context = _ctx;
}

class RecordGetResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    RecordDto? Record;

    RecordGetResponse({this.ResponseStatus,this.Record});
    RecordGetResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Record = JsonConverters.fromJson(json['Record'],'RecordDto',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Record': JsonConverters.toJson(Record,'RecordDto',context!)
    };

    getTypeName() => "RecordGetResponse";
    TypeContext? context = _ctx;
}

class RecordGetRequest implements IConvertible
{
    String? RecordKey;

    RecordGetRequest({this.RecordKey});
    RecordGetRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RecordKey = json['RecordKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RecordKey': RecordKey
    };

    getTypeName() => "RecordGetRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'RecordDto': TypeInfo(TypeOf.Class, create:() => RecordDto()),
    'RecordGetResponse': TypeInfo(TypeOf.Class, create:() => RecordGetResponse()),
    'RecordGetRequest': TypeInfo(TypeOf.Class, create:() => RecordGetRequest()),
});

Dart RecordGetRequest 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.

GET /v1/records/entry/{RecordKey} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecordGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Record>
    <Barcode>String</Barcode>
    <Branch>String</Branch>
    <Classification>String</Classification>
    <CreatedLabel>String</CreatedLabel>
    <DisposedJson>String</DisposedJson>
    <EligibleDate>String</EligibleDate>
    <FilesJson>String</FilesJson>
    <Format>String</Format>
    <HoldId>0</HoldId>
    <HoldKey>String</HoldKey>
    <Lifecycle>String</Lifecycle>
    <LocJson>String</LocJson>
    <MetaJson>String</MetaJson>
    <MonthsLeft>0</MonthsLeft>
    <Name>String</Name>
    <OwnerName>String</OwnerName>
    <Phase>String</Phase>
    <RecordId>0</RecordId>
    <RecordKey>String</RecordKey>
    <RelatedJson>String</RelatedJson>
    <RetKind>String</RetKind>
    <SeriesId>0</SeriesId>
    <SeriesKey>String</SeriesKey>
    <Staged>false</Staged>
    <TriggerDate>String</TriggerDate>
    <UpdatedLabel>String</UpdatedLabel>
    <VersionsJson>String</VersionsJson>
  </Record>
  <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>
</RecordGetResponse>