Megaventory API v2017a

<back to all web services

CompanyGet

The following routes are available for this service:
GET POST/Company/CompanyGetGets information on existing companiesUses your API Key and some Filters in an array format and returns the search results using given filters. Optionally, you can use ReturnTopNRecords to limit the number of the results to the specified number (omit, or add ReturnTopNRecords = -1 to get all the available results). The ReturnTopNRecords chooses the top records in a CompanyID descending order.

To override the Content-type in your clients 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.

POST /xml/reply/CompanyGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/xml
Content-Length: length

<CompanyGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Filters xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">
    <Filter>
      <AndOr>And</AndOr>
      <FieldName>String</FieldName>
      <Group>Undefined</Group>
      <SearchOperator>Undefined</SearchOperator>
      <SearchValue>String</SearchValue>
    </Filter>
  </Filters>
  <ReturnTopNRecords xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">0</ReturnTopNRecords>
  <APIKEY>String</APIKEY>
  <showDeleted>showOnlyUndeleted</showDeleted>
</CompanyGet>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvCompanies xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvCompany>
      <d2p1:CompanyId>0</d2p1:CompanyId>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:CompanyIsDefault>false</d2p1:CompanyIsDefault>
      <d2p1:CompanyAddress>
        <d2p1:AddressType>General</d2p1:AddressType>
        <d2p1:AddressLine1>String</d2p1:AddressLine1>
        <d2p1:AddressLine2>String</d2p1:AddressLine2>
        <d2p1:AddressLine3>String</d2p1:AddressLine3>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Phone>String</d2p1:Phone>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:TaxIdNumber>String</d2p1:TaxIdNumber>
        <d2p1:Organization>String</d2p1:Organization>
        <d2p1:City>String</d2p1:City>
        <d2p1:State>String</d2p1:State>
        <d2p1:Country>NONE</d2p1:Country>
        <d2p1:CountryName>String</d2p1:CountryName>
        <d2p1:Longitude>String</d2p1:Longitude>
        <d2p1:Latitude>String</d2p1:Latitude>
        <d2p1:ZipCode>String</d2p1:ZipCode>
      </d2p1:CompanyAddress>
      <d2p1:CompanyEmail>String</d2p1:CompanyEmail>
      <d2p1:CompanyPhone>String</d2p1:CompanyPhone>
      <d2p1:CompanyCurrency>String</d2p1:CompanyCurrency>
      <d2p1:CompanyTaxIdNumber>String</d2p1:CompanyTaxIdNumber>
      <d2p1:CompanyComments>String</d2p1:CompanyComments>
      <d2p1:CompanyTimeZoneOffsetInMinutes>0</d2p1:CompanyTimeZoneOffsetInMinutes>
      <d2p1:CompanyDaylightSavingFlag>false</d2p1:CompanyDaylightSavingFlag>
      <d2p1:CompanyDaylightStartDate>0001-01-01T00:00:00</d2p1:CompanyDaylightStartDate>
      <d2p1:CompanyDaylightEndDate>0001-01-01T00:00:00</d2p1:CompanyDaylightEndDate>
    </d2p1:mvCompany>
  </mvCompanies>
  <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:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</CompanyGetResponse>