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
BranchRequest Parameters:
NameParameterData TypeRequiredDescription
BranchIdbodyGuidNo
NamebodystringNo
CodebodystringNo
Address1bodystringNo
Address2bodystringNo
CitybodystringNo
StatebodystringNo
ZipbodystringNo
PhonebodystringNo
Latitudebodydecimal?No
Longitudebodydecimal?No
TimeZoneIdbodystringNo
BranchResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BranchesformList<Branch>No
Branch Parameters:
NameParameterData TypeRequiredDescription
BranchIdformGuidNo
TenantIdformGuidNo
NameformstringNo
CodeformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
PhoneformstringNo
Latitudeformdecimal?No
Longitudeformdecimal?No
TimeZoneIdformstringNo
IsDefaultformboolNo
IsActiveformboolNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No

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