ApexERPHost

<back to all web services

GetDistributionVans

Requires Authentication
The following routes are available for this service:
GET/Distribution/Vans/{VanId}
GET/Distribution/Vans
GetDistributionVans Parameters:
NameParameterData TypeRequiredDescription
VanIdpathint?No
GetDistributionVansResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<DistributionVan>No
DistributionVan Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
CarIdformint?No
DriverIdformint?No
BranchIdformint?No
CarformCarNo
DriverformDriverNo
BranchformCompanyBranchNo
AllowRetailSaleformboolNo
RetailAccformstringNo
RetailAccInfoformAccountInfoNo
Car Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NumberformstringNo
DescriptionformstringNo
DriverIdformint?No
CarTypeformint?No
Driver Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
PerNumformstringNo
DrivingLicenseformstringNo
CompanyBranch Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformintNo
ParentIdformint?No
NameformstringNo
NameEnformstringNo
AddressIdformint?No
SpendformboolNo
AddressformAddressNo
CodeformstringNo
BranchNumformint?No
GroupIdformint?No
PhoneformstringNo
NoteformstringNo
CompanyformCompanyNo
CustomerParametersformCustomerParamsNo
BranchProdSpendListTypeformint?No
SupplierParamsformSupplierParamsNo
BankAccountsformList<CompanyBankAccount>No
BranchAccountsformList<CompanyBranchAccount>No
Address Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CityIdformstringNo
BlockIdformintNo
PostalCodeformstringNo
FullAddressformstringNo
LocationformGPSLocationNo
GPSLocation Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
Company Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
NameEnformstringNo
IsOwnformboolNo
IsPartnerformboolNo
IsCustomerformboolNo
IsSupplierformboolNo
AddressIdformintNo
PhoneformstringNo
FaxformstringNo
EmailformstringNo
WebformstringNo
NoteformstringNo
SpendformboolNo
AddressformAddressNo
VatTypeformintNo
CustomerParams Parameters:
NameParameterData TypeRequiredDescription
BranchIdformintNo
CustomerTypeformint?No
ProductTypeformint?No
CustomerCategoryformint?No
CreditDaysformint?No
CreditLimitformdouble?No
OverdueLimitformdouble?No
SupplierParams Parameters:
NameParameterData TypeRequiredDescription
BranchIdformintNo
ProdSupplyDaysformint?No
MinOrderAmmountformdecimal?No
OrderGenIntervalDaysformint?No
ImporterformboolNo
MinOrderQuantityformdecimal?No
AutoOrderformboolNo
CompanyBankAccount Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BranchIdformintNo
BankIdformstringNo
AccountformstringNo
NoteformstringNo
IsDefaultformboolNo
IntermediaryBankIdformstringNo
IntermediaryAccountformstringNo
CurrencyIdformstringNo
CompanyBranchAccount Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BranchIdformint?No
AccTypeformintNo
AccountformstringNo
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
AccformstringNo
NameformstringNo
SNformstringNo
WarehouseAddressformstringNo
AddressformstringNo
PhoneformstringNo
AccWithNameformstringNo
VatTypeformintNo
BranchIdformint?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 /Distribution/Vans/{VanId} 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: 
	[
		{
			Id: 0,
			Name: String,
			CarId: 0,
			DriverId: 0,
			BranchId: 0,
			Car: 
			{
				ID: 0,
				Number: String,
				Description: String,
				DriverId: 0,
				CarType: 0
			},
			Driver: 
			{
				ID: 0,
				Name: String,
				PerNum: String,
				DrivingLicense: String
			},
			Branch: 
			{
				Id: 0,
				CompanyId: 0,
				ParentId: 0,
				Name: String,
				NameEn: String,
				AddressId: 0,
				Spend: False,
				Address: 
				{
					Id: 0,
					CityId: String,
					BlockId: 0,
					PostalCode: String,
					FullAddress: String,
					Location: 
					{
						Latitude: 0,
						Longitude: 0
					}
				},
				Code: String,
				BranchNum: 0,
				GroupId: 0,
				Phone: String,
				Note: String,
				Company: 
				{
					Id: 0,
					Code: String,
					Name: String,
					NameEn: String,
					IsOwn: False,
					IsPartner: False,
					IsCustomer: False,
					IsSupplier: False,
					AddressId: 0,
					Phone: String,
					Fax: String,
					Email: String,
					Web: String,
					Note: String,
					Spend: False,
					Address: 
					{
						Id: 0,
						CityId: String,
						BlockId: 0,
						PostalCode: String,
						FullAddress: String,
						Location: 
						{
							Latitude: 0,
							Longitude: 0
						}
					},
					VatType: 0
				},
				CustomerParameters: 
				{
					BranchId: 0,
					CustomerType: 0,
					ProductType: 0,
					CustomerCategory: 0,
					CreditDays: 0,
					CreditLimit: 0,
					OverdueLimit: 0
				},
				BranchProdSpendListType: 0,
				SupplierParams: 
				{
					BranchId: 0,
					ProdSupplyDays: 0,
					MinOrderAmmount: 0,
					OrderGenIntervalDays: 0,
					Importer: False,
					MinOrderQuantity: 0,
					AutoOrder: False
				},
				BankAccounts: 
				[
					{
						Id: 0,
						BranchId: 0,
						BankId: String,
						Account: String,
						Note: String,
						IsDefault: False,
						IntermediaryBankId: String,
						IntermediaryAccount: String,
						CurrencyId: String
					}
				],
				BranchAccounts: 
				[
					{
						Id: 0,
						BranchId: 0,
						AccType: 0,
						Account: String
					}
				]
			},
			AllowRetailSale: False,
			RetailAcc: String,
			RetailAccInfo: 
			{
				Acc: String,
				Name: String,
				SN: String,
				WarehouseAddress: String,
				Address: String,
				Phone: String,
				AccWithName: String - String,
				VatType: 0,
				BranchId: 0
			}
		}
	]
}