| GET,OPTIONS | /v1/branch/context |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Branches | form | List<Branch> | No | |
| SelectedBranchId | form | Guid? | No | |
| DefaultBranchId | form | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BranchId | form | Guid | No | |
| TenantId | form | Guid | No | |
| Name | form | string | No | |
| Code | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Phone | form | string | No | |
| Latitude | form | decimal? | No | |
| Longitude | form | decimal? | No | |
| TimeZoneId | form | string | No | |
| IsDefault | form | bool | No | |
| IsActive | form | bool | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime? | No | |
| UpdatedAt | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
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
}
],
SelectedBranchId: 00000000000000000000000000000000,
DefaultBranchId: 00000000000000000000000000000000
}