Trendsic Platform Service

<back to all web services

TerminologyAdminRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/terminology/admin
import 'package:servicestack/servicestack.dart';

class IndustryPack implements IConvertible
{
    String? PackId;
    String? Code;
    String? Name;
    bool? IsActive;

    IndustryPack({this.PackId,this.Code,this.Name,this.IsActive});
    IndustryPack.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PackId = json['PackId'];
        Code = json['Code'];
        Name = json['Name'];
        IsActive = json['IsActive'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PackId': PackId,
        'Code': Code,
        'Name': Name,
        'IsActive': IsActive
    };

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

class TermOverride implements IConvertible
{
    String? TermKey;
    String? Label;
    String? CreatedBy;
    DateTime? CreatedAt;
    DateTime? UpdatedAt;

    TermOverride({this.TermKey,this.Label,this.CreatedBy,this.CreatedAt,this.UpdatedAt});
    TermOverride.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TermKey = json['TermKey'];
        Label = json['Label'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TermKey': TermKey,
        'Label': Label,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!)
    };

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

class TerminologyAdminResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<IndustryPack>? Packs = [];
    String? SelectedPackId;
    Map<String,String?>? Terms = {};
    List<TermOverride>? Overrides = [];

    TerminologyAdminResponse({this.ResponseStatus,this.Packs,this.SelectedPackId,this.Terms,this.Overrides});
    TerminologyAdminResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Packs = JsonConverters.fromJson(json['Packs'],'List<IndustryPack>',context!);
        SelectedPackId = json['SelectedPackId'];
        Terms = JsonConverters.toStringMap(json['Terms']);
        Overrides = JsonConverters.fromJson(json['Overrides'],'List<TermOverride>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Packs': JsonConverters.toJson(Packs,'List<IndustryPack>',context!),
        'SelectedPackId': SelectedPackId,
        'Terms': Terms,
        'Overrides': JsonConverters.toJson(Overrides,'List<TermOverride>',context!)
    };

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

class TerminologyAdminRequest implements IConvertible
{
    TerminologyAdminRequest();
    TerminologyAdminRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "TerminologyAdminRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'IndustryPack': TypeInfo(TypeOf.Class, create:() => IndustryPack()),
    'TermOverride': TypeInfo(TypeOf.Class, create:() => TermOverride()),
    'TerminologyAdminResponse': TypeInfo(TypeOf.Class, create:() => TerminologyAdminResponse()),
    'List<IndustryPack>': TypeInfo(TypeOf.Class, create:() => <IndustryPack>[]),
    'List<TermOverride>': TypeInfo(TypeOf.Class, create:() => <TermOverride>[]),
    'TerminologyAdminRequest': TypeInfo(TypeOf.Class, create:() => TerminologyAdminRequest()),
});

Dart TerminologyAdminRequest 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/terminology/admin HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TerminologyAdminResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Overrides>
    <TermOverride>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Label>String</Label>
      <TermKey>String</TermKey>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </TermOverride>
  </Overrides>
  <Packs>
    <IndustryPack>
      <Code>String</Code>
      <IsActive>false</IsActive>
      <Name>String</Name>
      <PackId>00000000-0000-0000-0000-000000000000</PackId>
    </IndustryPack>
  </Packs>
  <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>
  <SelectedPackId>00000000-0000-0000-0000-000000000000</SelectedPackId>
  <Terms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Terms>
</TerminologyAdminResponse>