Trendsic Platform Service

<back to all web services

LocationsRequest

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

class Location implements IConvertible
{
    String? Id;
    String? ClientId;
    String? Name;
    String? Address1;
    String? Address2;
    String? City;
    String? State;
    String? Zip;
    String? Phone;
    String? Fax;
    String? TimeZone;
    bool? Active;
    DateTime? EntDate;
    DateTime? ModDate;

    Location({this.Id,this.ClientId,this.Name,this.Address1,this.Address2,this.City,this.State,this.Zip,this.Phone,this.Fax,this.TimeZone,this.Active,this.EntDate,this.ModDate});
    Location.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        ClientId = json['ClientId'];
        Name = json['Name'];
        Address1 = json['Address1'];
        Address2 = json['Address2'];
        City = json['City'];
        State = json['State'];
        Zip = json['Zip'];
        Phone = json['Phone'];
        Fax = json['Fax'];
        TimeZone = json['TimeZone'];
        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,
        'ClientId': ClientId,
        'Name': Name,
        'Address1': Address1,
        'Address2': Address2,
        'City': City,
        'State': State,
        'Zip': Zip,
        'Phone': Phone,
        'Fax': Fax,
        'TimeZone': TimeZone,
        'Active': Active,
        'EntDate': JsonConverters.toJson(EntDate,'DateTime',context!),
        'ModDate': JsonConverters.toJson(ModDate,'DateTime',context!)
    };

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

class LocationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<Location>? Locations = [];

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

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

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

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

class LocationsRequest implements IConvertible
{
    String? Id;
    List<Location>? Locations = [];

    LocationsRequest({this.Id,this.Locations});
    LocationsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Locations': JsonConverters.toJson(Locations,'List<Location>',context!)
    };

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

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

Dart LocationsRequest 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/Locations/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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