ApexERPHost

<back to all web services

GetCompany

Requires Authentication
The following routes are available for this service:
GET/Crm/Company/{Id}
GET/Crm/Company
GetCompany Parameters:
NameParameterData TypeRequiredDescription
Idpathint?No
IsCustomerquerybool?No
IsSupplierquerybool?No
IsOwnquerybool?No
IsPartnerquerybool?No
RsCodequerystringNo
GetCompanyResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<Company>No
Company Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
NameEnformstringNo
IsOwnformboolNo
IsPartnerformboolNo
IsCustomerformboolNo
IsSupplierformboolNo
AddressIdformintNo
PhoneformstringNo
FaxformstringNo
EmailformstringNo
WebformstringNo
NoteformstringNo
SpendformboolNo
AddressformAddressNo
VatTypeformintNo
Address Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CityIdformstringNo
BlockIdformintNo
PostalCodeformstringNo
FullAddressformstringNo
LocationformGPSLocationNo
GPSLocation Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo

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

<GetCompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm">
  <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>
    <Company>
      <Id>0</Id>
      <Code>String</Code>
      <Name>String</Name>
      <NameEn>String</NameEn>
      <IsOwn>false</IsOwn>
      <IsPartner>false</IsPartner>
      <IsCustomer>false</IsCustomer>
      <IsSupplier>false</IsSupplier>
      <AddressId>0</AddressId>
      <Phone>String</Phone>
      <Fax>String</Fax>
      <Email>String</Email>
      <Web>String</Web>
      <Note>String</Note>
      <Spend>false</Spend>
      <Address>
        <Id>0</Id>
        <CityId>String</CityId>
        <BlockId>0</BlockId>
        <PostalCode>String</PostalCode>
        <FullAddress>String</FullAddress>
        <Location xmlns:d5p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
          <d5p1:Latitude>0</d5p1:Latitude>
          <d5p1:Longitude>0</d5p1:Longitude>
        </Location>
      </Address>
      <VatType>0</VatType>
    </Company>
  </Result>
</GetCompanyResponse>