ApexERPHost

<back to all web services

GetBranches

Requires Authentication
The following routes are available for this service:
GET/Common/Branches
GetBranches Parameters:
NameParameterData TypeRequiredDescription
BranchIDqueryint?No
GetBranchesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<Branch>No
Branch Parameters:
NameParameterData TypeRequiredDescription
BranchIDformintNo
NameformstringNo
DescriptionformstringNo
SpendformboolNo

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.

GET /Common/Branches HTTP/1.1 
Host: apex.nikoratrade.ge 
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
		}
	},
	Result: 
	[
		{
			BranchID: 0,
			Name: String,
			Description: String,
			Spend: False
		}
	]
}