Trendsic Platform Service

<back to all web services

BranchContextRequest

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

class Branch implements IConvertible
{
    String? BranchId;
    String? TenantId;
    String? Name;
    String? Code;
    String? Address1;
    String? Address2;
    String? City;
    String? State;
    String? Zip;
    String? Phone;
    double? Latitude;
    double? Longitude;
    String? TimeZoneId;
    bool? IsDefault;
    bool? IsActive;
    String? CreatedBy;
    DateTime? CreatedAt;
    DateTime? UpdatedAt;

    Branch({this.BranchId,this.TenantId,this.Name,this.Code,this.Address1,this.Address2,this.City,this.State,this.Zip,this.Phone,this.Latitude,this.Longitude,this.TimeZoneId,this.IsDefault,this.IsActive,this.CreatedBy,this.CreatedAt,this.UpdatedAt});
    Branch.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BranchId = json['BranchId'];
        TenantId = json['TenantId'];
        Name = json['Name'];
        Code = json['Code'];
        Address1 = json['Address1'];
        Address2 = json['Address2'];
        City = json['City'];
        State = json['State'];
        Zip = json['Zip'];
        Phone = json['Phone'];
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        TimeZoneId = json['TimeZoneId'];
        IsDefault = json['IsDefault'];
        IsActive = json['IsActive'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BranchId': BranchId,
        'TenantId': TenantId,
        'Name': Name,
        'Code': Code,
        'Address1': Address1,
        'Address2': Address2,
        'City': City,
        'State': State,
        'Zip': Zip,
        'Phone': Phone,
        'Latitude': Latitude,
        'Longitude': Longitude,
        'TimeZoneId': TimeZoneId,
        'IsDefault': IsDefault,
        'IsActive': IsActive,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!)
    };

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

class BranchContextResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<Branch>? Branches = [];
    String? SelectedBranchId;
    String? DefaultBranchId;

    BranchContextResponse({this.ResponseStatus,this.Branches,this.SelectedBranchId,this.DefaultBranchId});
    BranchContextResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Branches': JsonConverters.toJson(Branches,'List<Branch>',context!),
        'SelectedBranchId': SelectedBranchId,
        'DefaultBranchId': DefaultBranchId
    };

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

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

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

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

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

<BranchContextResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Branches>
    <Branch>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <City>String</City>
      <Code>String</Code>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <IsActive>false</IsActive>
      <IsDefault>false</IsDefault>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
      <Phone>String</Phone>
      <State>String</State>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
      <TimeZoneId>String</TimeZoneId>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Zip>String</Zip>
    </Branch>
  </Branches>
  <DefaultBranchId>00000000-0000-0000-0000-000000000000</DefaultBranchId>
  <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>
  <SelectedBranchId>00000000-0000-0000-0000-000000000000</SelectedBranchId>
</BranchContextResponse>