ApexERPHost

<back to all web services

GetLocations

Requires Authentication
The following routes are available for this service:
GET/Accounting/Locations/
GetLocations Parameters:
NameParameterData TypeRequiredDescription
LocationIdqueryint?No
BrIdqueryint?No
MgrIdqueryint?No
BranchIdqueryint?No
BrChildLocqueryboolNo
GetLocationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<Location>No
Location Parameters:
NameParameterData TypeRequiredDescription
locationidformintNo
mgridformint?No
nameformstringNo
nameeformstringNo
hcodeformstringNo
bridformintNo
hrclvlformintNo
hccrtformstringNo
mgridpformintNo
BranchformBranchNo
branch_idformint?No
Branch Parameters:
NameParameterData TypeRequiredDescription
BranchIDformintNo
NameformstringNo
DescriptionformstringNo
SpendformboolNo
CompanyBranchIdformint?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.

GET /Accounting/Locations/ 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: 
	[
		{
			locationid: 0,
			mgrid: 0,
			name: String,
			namee: String,
			hcode: String,
			brid: 0,
			hrclvl: 0,
			hccrt: String,
			mgridp: 0,
			Branch: 
			{
				BranchID: 0,
				Name: String,
				Description: String,
				Spend: False,
				CompanyBranchId: 0
			},
			branch_id: 0
		}
	]
}