ApexERPHost

<back to all web services

GetCompanyBranchForGroup

Requires Authentication
The following routes are available for this service:
GET/Warehousing/Group/{GroupId}/Company/{CompanyId}/Branches
GetCompanyBranchForGroup Parameters:
NameParameterData TypeRequiredDescription
GroupIdpathintNo
CompanyIdpathintNo
GetCompanyBranchForGroupResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<CompanyBranch>No
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

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 /Warehousing/Group/{GroupId}/Company/{CompanyId}/Branches HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCompanyBranchForGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Warehousing">
  <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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apex.Services.Crm">
    <d2p1:CompanyBranch>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:CompanyId>0</d2p1:CompanyId>
      <d2p1:ParentId>0</d2p1:ParentId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NameEn>String</d2p1:NameEn>
      <d2p1:AddressId>0</d2p1:AddressId>
      <d2p1:Spend>false</d2p1:Spend>
      <d2p1:Address>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:CityId>String</d2p1:CityId>
        <d2p1:BlockId>0</d2p1:BlockId>
        <d2p1:PostalCode>String</d2p1:PostalCode>
        <d2p1:FullAddress>String</d2p1:FullAddress>
        <d2p1:Location xmlns:d5p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
          <d5p1:Latitude>0</d5p1:Latitude>
          <d5p1:Longitude>0</d5p1:Longitude>
        </d2p1:Location>
      </d2p1:Address>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:BranchNum>0</d2p1:BranchNum>
      <d2p1:GroupId>0</d2p1:GroupId>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Company>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:NameEn>String</d2p1:NameEn>
        <d2p1:IsOwn>false</d2p1:IsOwn>
        <d2p1:IsPartner>false</d2p1:IsPartner>
        <d2p1:IsCustomer>false</d2p1:IsCustomer>
        <d2p1:IsSupplier>false</d2p1:IsSupplier>
        <d2p1:AddressId>0</d2p1:AddressId>
        <d2p1:Phone>String</d2p1:Phone>
        <d2p1:Fax>String</d2p1:Fax>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:Web>String</d2p1:Web>
        <d2p1:Note>String</d2p1:Note>
        <d2p1:Spend>false</d2p1:Spend>
        <d2p1:Address>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:CityId>String</d2p1:CityId>
          <d2p1:BlockId>0</d2p1:BlockId>
          <d2p1:PostalCode>String</d2p1:PostalCode>
          <d2p1:FullAddress>String</d2p1:FullAddress>
          <d2p1:Location xmlns:d6p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
            <d6p1:Latitude>0</d6p1:Latitude>
            <d6p1:Longitude>0</d6p1:Longitude>
          </d2p1:Location>
        </d2p1:Address>
        <d2p1:VatType>0</d2p1:VatType>
      </d2p1:Company>
      <d2p1:CustomerParameters>
        <d2p1:BranchId>0</d2p1:BranchId>
        <d2p1:CustomerType>0</d2p1:CustomerType>
        <d2p1:ProductType>0</d2p1:ProductType>
        <d2p1:CustomerCategory>0</d2p1:CustomerCategory>
        <d2p1:CreditDays>0</d2p1:CreditDays>
        <d2p1:CreditLimit>0</d2p1:CreditLimit>
        <d2p1:OverdueLimit>0</d2p1:OverdueLimit>
      </d2p1:CustomerParameters>
      <d2p1:BranchProdSpendListType>0</d2p1:BranchProdSpendListType>
      <d2p1:SupplierParams>
        <d2p1:BranchId>0</d2p1:BranchId>
        <d2p1:ProdSupplyDays>0</d2p1:ProdSupplyDays>
        <d2p1:MinOrderAmmount>0</d2p1:MinOrderAmmount>
        <d2p1:OrderGenIntervalDays>0</d2p1:OrderGenIntervalDays>
        <d2p1:Importer>false</d2p1:Importer>
        <d2p1:MinOrderQuantity>0</d2p1:MinOrderQuantity>
        <d2p1:AutoOrder>false</d2p1:AutoOrder>
      </d2p1:SupplierParams>
      <d2p1:BankAccounts>
        <d2p1:CompanyBankAccount>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:BranchId>0</d2p1:BranchId>
          <d2p1:BankId>String</d2p1:BankId>
          <d2p1:Account>String</d2p1:Account>
          <d2p1:Note>String</d2p1:Note>
          <d2p1:IsDefault>false</d2p1:IsDefault>
          <d2p1:IntermediaryBankId>String</d2p1:IntermediaryBankId>
          <d2p1:IntermediaryAccount>String</d2p1:IntermediaryAccount>
          <d2p1:CurrencyId>String</d2p1:CurrencyId>
        </d2p1:CompanyBankAccount>
      </d2p1:BankAccounts>
      <d2p1:BranchAccounts>
        <d2p1:CompanyBranchAccount>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:BranchId>0</d2p1:BranchId>
          <d2p1:AccType>0</d2p1:AccType>
          <d2p1:Account>String</d2p1:Account>
        </d2p1:CompanyBranchAccount>
      </d2p1:BranchAccounts>
    </d2p1:CompanyBranch>
  </Result>
</GetCompanyBranchForGroupResponse>