Branches
Get Branch
This endpoint retrieves data of a specific Branch based on JSON input. The API returns a single Branch available to the user in the Value List, according to the unique ID provided. If the specified Branch does not exist, the response will be a "bad request".
You will only receive the Branch after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier for the Branch to retrieve data |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| currencyId | Object, Null | ID of the Currency (see Currencies resource) associated to the Branch |
| dateCreated | String | Date and time when the Branch was created |
| dateDeleted | String | Date and time when the Branch was deleted |
| dateUpdated | String | Date and time when the Branch was last updated |
| default | Boolean | If true, the Branch is the one assigned by default, this is valid for any kind of implementations |
| deleted | Boolean | If true, the Branch has been deleted and archived |
| descriptionBR | String | Branch name in Brasilian Portuguese |
| descriptionDE | String | Branch name in German |
| descriptionDK | String | Branch name in Dutch |
| descriptionEN | String | Branch name in English |
| descriptionES | String | Branch name in Spanish |
| descriptionFR | String | Branch name in French |
| descriptionIT | String | Branch name in Italian |
| descriptionPT | String | Branch name in Portuguese |
| descriptionRU | String | Branch name in Russian |
| descriptionUS | String | Branch name in American English |
| extId | String | External unique identifier for the Branch |
| id | Integer | Unique identifier for the Branch in ForceManager |
| imperialSystem | Boolean | If true, the Branch adopt the imperial system measurement (i.e. miles instead of km) |
| mainEnvironment | Boolean | If true, the Branch is the main one, for long tail implementations |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Branch |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Branch |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Branch |
| timeZoneId | Object | The id and the friendly name of the Branch timezone |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/branches/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/branches/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Branch
Changes
No recorded changes to this operation across all 1 revision of this API.