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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class BranchContextRequest
    {
        
    }

    public static class BranchContextResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<Branch> Branches = new ArrayList<Branch>();
        public UUID SelectedBranchId = null;
        public UUID DefaultBranchId = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public BranchContextResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<Branch> getBranches() { return Branches; }
        public BranchContextResponse setBranches(ArrayList<Branch> value) { this.Branches = value; return this; }
        public UUID getSelectedBranchId() { return SelectedBranchId; }
        public BranchContextResponse setSelectedBranchId(UUID value) { this.SelectedBranchId = value; return this; }
        public UUID getDefaultBranchId() { return DefaultBranchId; }
        public BranchContextResponse setDefaultBranchId(UUID value) { this.DefaultBranchId = value; return this; }
    }

    public static class Branch
    {
        public UUID BranchId = null;
        public UUID TenantId = null;
        public String Name = null;
        public String Code = null;
        public String Address1 = null;
        public String Address2 = null;
        public String City = null;
        public String State = null;
        public String Zip = null;
        public String Phone = null;
        public BigDecimal Latitude = null;
        public BigDecimal Longitude = null;
        public String TimeZoneId = null;
        public Boolean IsDefault = null;
        public Boolean IsActive = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        public Date UpdatedAt = null;
        
        public UUID getBranchId() { return BranchId; }
        public Branch setBranchId(UUID value) { this.BranchId = value; return this; }
        public UUID getTenantId() { return TenantId; }
        public Branch setTenantId(UUID value) { this.TenantId = value; return this; }
        public String getName() { return Name; }
        public Branch setName(String value) { this.Name = value; return this; }
        public String getCode() { return Code; }
        public Branch setCode(String value) { this.Code = value; return this; }
        public String getAddress1() { return Address1; }
        public Branch setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public Branch setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public Branch setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public Branch setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public Branch setZip(String value) { this.Zip = value; return this; }
        public String getPhone() { return Phone; }
        public Branch setPhone(String value) { this.Phone = value; return this; }
        public BigDecimal getLatitude() { return Latitude; }
        public Branch setLatitude(BigDecimal value) { this.Latitude = value; return this; }
        public BigDecimal getLongitude() { return Longitude; }
        public Branch setLongitude(BigDecimal value) { this.Longitude = value; return this; }
        public String getTimeZoneId() { return TimeZoneId; }
        public Branch setTimeZoneId(String value) { this.TimeZoneId = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public Branch setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public Branch setIsActive(Boolean value) { this.IsActive = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public Branch setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public Branch setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getUpdatedAt() { return UpdatedAt; }
        public Branch setUpdatedAt(Date value) { this.UpdatedAt = value; return this; }
    }

}

Java 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>