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


open class BranchRequest
{
    open var BranchId:UUID? = null
    open var Name:String? = null
    open var Code:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Phone:String? = null
    open var Latitude:BigDecimal? = null
    open var Longitude:BigDecimal? = null
    open var TimeZoneId:String? = null
}

open class BranchResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Branches:ArrayList<Branch> = ArrayList<Branch>()
}

open class Branch
{
    open var BranchId:UUID? = null
    open var TenantId:UUID? = null
    open var Name:String? = null
    open var Code:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Phone:String? = null
    open var Latitude:BigDecimal? = null
    open var Longitude:BigDecimal? = null
    open var TimeZoneId:String? = null
    open var IsDefault:Boolean? = null
    open var IsActive:Boolean? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
}

Kotlin BranchRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
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-01,
			UpdatedAt: 0001-01-01
		}
	]
}