Trendsic Platform Service

<back to all web services

BranchRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/branch
import Foundation
import ServiceStack

public class BranchRequest : Codable
{
    public var branchId:String
    public var name:String
    public var code:String
    public var address1:String
    public var address2:String
    public var city:String
    public var state:String
    public var zip:String
    public var phone:String
    public var latitude:Double?
    public var longitude:Double?
    public var timeZoneId:String

    required public init(){}
}

public class BranchResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var branches:[Branch] = []

    required public init(){}
}

public class Branch : Codable
{
    public var branchId:String
    public var tenantId:String
    public var name:String
    public var code:String
    public var address1:String
    public var address2:String
    public var city:String
    public var state:String
    public var zip:String
    public var phone:String
    public var latitude:Double?
    public var longitude:Double?
    public var timeZoneId:String
    public var isDefault:Bool
    public var isActive:Bool
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}

Swift BranchRequest 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.

POST /v1/branch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BranchId":"00000000000000000000000000000000","Name":"String","Code":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Latitude":0,"Longitude":0,"TimeZoneId":"String"}

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"}]}