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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDistributionVansResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Distribution">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <DistributionVan>
      <Id>0</Id>
      <Name>String</Name>
      <CarId>0</CarId>
      <DriverId>0</DriverId>
      <BranchId>0</BranchId>
      <Car xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
        <d4p1:ID>0</d4p1:ID>
        <d4p1:Number>String</d4p1:Number>
        <d4p1:Description>String</d4p1:Description>
        <d4p1:DriverId>0</d4p1:DriverId>
        <d4p1:CarType>0</d4p1:CarType>
      </Car>
      <Driver xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
        <d4p1:ID>0</d4p1:ID>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:PerNum>String</d4p1:PerNum>
        <d4p1:DrivingLicense>String</d4p1:DrivingLicense>
      </Driver>
      <Branch xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apex.Services.Crm">
        <d4p1:Id>0</d4p1:Id>
        <d4p1:CompanyId>0</d4p1:CompanyId>
        <d4p1:ParentId>0</d4p1:ParentId>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:NameEn>String</d4p1:NameEn>
        <d4p1:AddressId>0</d4p1:AddressId>
        <d4p1:Spend>false</d4p1:Spend>
        <d4p1:Address>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:CityId>String</d4p1:CityId>
          <d4p1:BlockId>0</d4p1:BlockId>
          <d4p1:PostalCode>String</d4p1:PostalCode>
          <d4p1:FullAddress>String</d4p1:FullAddress>
          <d4p1:Location xmlns:d6p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
            <d6p1:Latitude>0</d6p1:Latitude>
            <d6p1:Longitude>0</d6p1:Longitude>
          </d4p1:Location>
        </d4p1:Address>
        <d4p1:Code>String</d4p1:Code>
        <d4p1:BranchNum>0</d4p1:BranchNum>
        <d4p1:GroupId>0</d4p1:GroupId>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:Note>String</d4p1:Note>
        <d4p1:Company>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Code>String</d4p1:Code>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:NameEn>String</d4p1:NameEn>
          <d4p1:IsOwn>false</d4p1:IsOwn>
          <d4p1:IsPartner>false</d4p1:IsPartner>
          <d4p1:IsCustomer>false</d4p1:IsCustomer>
          <d4p1:IsSupplier>false</d4p1:IsSupplier>
          <d4p1:AddressId>0</d4p1:AddressId>
          <d4p1:Phone>String</d4p1:Phone>
          <d4p1:Fax>String</d4p1:Fax>
          <d4p1:Email>String</d4p1:Email>
          <d4p1:Web>String</d4p1:Web>
          <d4p1:Note>String</d4p1:Note>
          <d4p1:Spend>false</d4p1:Spend>
          <d4p1:Address>
            <d4p1:Id>0</d4p1:Id>
            <d4p1:CityId>String</d4p1:CityId>
            <d4p1:BlockId>0</d4p1:BlockId>
            <d4p1:PostalCode>String</d4p1:PostalCode>
            <d4p1:FullAddress>String</d4p1:FullAddress>
            <d4p1:Location xmlns:d7p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
              <d7p1:Latitude>0</d7p1:Latitude>
              <d7p1:Longitude>0</d7p1:Longitude>
            </d4p1:Location>
          </d4p1:Address>
          <d4p1:VatType>0</d4p1:VatType>
        </d4p1:Company>
        <d4p1:CustomerParameters>
          <d4p1:BranchId>0</d4p1:BranchId>
          <d4p1:CustomerType>0</d4p1:CustomerType>
          <d4p1:ProductType>0</d4p1:ProductType>
          <d4p1:CustomerCategory>0</d4p1:CustomerCategory>
          <d4p1:CreditDays>0</d4p1:CreditDays>
          <d4p1:CreditLimit>0</d4p1:CreditLimit>
          <d4p1:OverdueLimit>0</d4p1:OverdueLimit>
        </d4p1:CustomerParameters>
        <d4p1:BranchProdSpendListType>0</d4p1:BranchProdSpendListType>
        <d4p1:SupplierParams>
          <d4p1:BranchId>0</d4p1:BranchId>
          <d4p1:ProdSupplyDays>0</d4p1:ProdSupplyDays>
          <d4p1:MinOrderAmmount>0</d4p1:MinOrderAmmount>
          <d4p1:OrderGenIntervalDays>0</d4p1:OrderGenIntervalDays>
          <d4p1:Importer>false</d4p1:Importer>
          <d4p1:MinOrderQuantity>0</d4p1:MinOrderQuantity>
          <d4p1:AutoOrder>false</d4p1:AutoOrder>
        </d4p1:SupplierParams>
        <d4p1:BankAccounts>
          <d4p1:CompanyBankAccount>
            <d4p1:Id>0</d4p1:Id>
            <d4p1:BranchId>0</d4p1:BranchId>
            <d4p1:BankId>String</d4p1:BankId>
            <d4p1:Account>String</d4p1:Account>
            <d4p1:Note>String</d4p1:Note>
            <d4p1:IsDefault>false</d4p1:IsDefault>
            <d4p1:IntermediaryBankId>String</d4p1:IntermediaryBankId>
            <d4p1:IntermediaryAccount>String</d4p1:IntermediaryAccount>
            <d4p1:CurrencyId>String</d4p1:CurrencyId>
          </d4p1:CompanyBankAccount>
        </d4p1:BankAccounts>
        <d4p1:BranchAccounts>
          <d4p1:CompanyBranchAccount>
            <d4p1:Id>0</d4p1:Id>
            <d4p1:BranchId>0</d4p1:BranchId>
            <d4p1:AccType>0</d4p1:AccType>
            <d4p1:Account>String</d4p1:Account>
          </d4p1:CompanyBranchAccount>
        </d4p1:BranchAccounts>
      </Branch>
      <AllowRetailSale>false</AllowRetailSale>
      <RetailAcc>String</RetailAcc>
      <RetailAccInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apex.Services.Accounting">
        <d4p1:Acc>String</d4p1:Acc>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:SN>String</d4p1:SN>
        <d4p1:WarehouseAddress>String</d4p1:WarehouseAddress>
        <d4p1:Address>String</d4p1:Address>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:AccWithName>String - String</d4p1:AccWithName>
        <d4p1:VatType>0</d4p1:VatType>
        <d4p1:BranchId>0</d4p1:BranchId>
      </RetailAccInfo>
    </DistributionVan>
  </Result>
</GetDistributionVansResponse>