Trendsic Platform Service

<back to all web services

Clients

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Clients/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Clients
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class ClientObject implements IConvertible
{
    String? Id;
    String? Name;
    String? Address1;
    String? Address2;
    String? City;
    String? State;
    String? Zip;
    String? SubscriptionId;
    bool? Active;
    DateTime? EntDate;
    DateTime? ModDate;

    ClientObject({this.Id,this.Name,this.Address1,this.Address2,this.City,this.State,this.Zip,this.SubscriptionId,this.Active,this.EntDate,this.ModDate});
    ClientObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Address1 = json['Address1'];
        Address2 = json['Address2'];
        City = json['City'];
        State = json['State'];
        Zip = json['Zip'];
        SubscriptionId = json['SubscriptionId'];
        Active = json['Active'];
        EntDate = JsonConverters.fromJson(json['EntDate'],'DateTime',context!);
        ModDate = JsonConverters.fromJson(json['ModDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Address1': Address1,
        'Address2': Address2,
        'City': City,
        'State': State,
        'Zip': Zip,
        'SubscriptionId': SubscriptionId,
        'Active': Active,
        'EntDate': JsonConverters.toJson(EntDate,'DateTime',context!),
        'ModDate': JsonConverters.toJson(ModDate,'DateTime',context!)
    };

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

class ClientsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<ClientObject>? Clients = [];

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

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

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

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

class Clients extends ClientObject implements IConvertible
{
    String? ApiKey;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ApiKey': ApiKey
    });

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

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

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

POST /v1/Clients/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Clients xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Active>false</Active>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <City>String</City>
  <EntDate>0001-01-01T00:00:00</EntDate>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <ModDate>0001-01-01T00:00:00</ModDate>
  <Name>String</Name>
  <State>String</State>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <Zip>String</Zip>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</Clients>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Clients>
    <ClientObject>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <City>String</City>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <State>String</State>
      <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
      <Zip>String</Zip>
    </ClientObject>
  </Clients>
  <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>
</ClientsResponse>