Trendsic Platform Service

<back to all web services

BranchContextRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/branch/context
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Branch() = 
        member val BranchId:Guid = new Guid() with get,set
        member val TenantId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Code:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Phone:String = null with get,set
        member val Latitude:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Longitude:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TimeZoneId:String = null with get,set
        member val IsDefault:Boolean = new Boolean() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type BranchContextResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Branches:ResizeArray<Branch> = new ResizeArray<Branch>() with get,set
        member val SelectedBranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val DefaultBranchId:Nullable<Guid> = new Nullable<Guid>() with get,set

    [<AllowNullLiteral>]
    type BranchContextRequest() = 
        class end

F# BranchContextRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Branches":[{"BranchId":"00000000000000000000000000000000","TenantId":"00000000000000000000000000000000","Name":"String","Code":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Latitude":0,"Longitude":0,"TimeZoneId":"String","IsDefault":false,"IsActive":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"SelectedBranchId":"00000000000000000000000000000000","DefaultBranchId":"00000000000000000000000000000000"}