SearchAdapter Web Services

CompanySearch

The following routes are available for this service:
GET	/company	Search for companies

**Search** Parameters:
Name	Parameter	Data Type	Required
QueryString	body	string	No
ReturnAllContactPoints	body	bool	No
Rows	body	int?	No
Offset	body	int?	No
Filters	body	List<string>	No
Facets	body	List<string>	No
Fields	body	List<string>	No
SortBy	body	List<string>	No
Profile	body	string	No

**CompanySearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Hits	body	List<CompanyHit>	No

**SearchResponseBase** Parameters:
Name	Parameter	Data Type	Required
QueryTimeMilliSeconds	body	int	No
NumberOfHits	body	long	No
ResponseStatus	body	ResponseStatus	No
Version	body	string	No
Facets	body	List<Facet>	No
Profile	body	string	No

**CompanyHit** Parameters:
Name	Parameter	Data Type	Required
Score	body	double	No
Company	body	Company	No
Reserved	body	bool	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.

POST /xml/reply/CompanySearch HTTP/1.1 
Host: api-dev.1881.no 
Content-Type: application/xml
Content-Length: length

<CompanySearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/O1881.SearchAdapter.ServiceModel">
  <Facets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Facets>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Fields>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Filters>
  <Offset>0</Offset>
  <Profile>String</Profile>
  <QueryString>String</QueryString>
  <ReturnAllContactPoints>false</ReturnAllContactPoints>
  <Rows>0</Rows>
  <SortBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SortBy>
</CompanySearch>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanySearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/O1881.SearchAdapter.ServiceModel">
  <Facets>
    <Facet>
      <Type>String</Type>
      <Values>
        <FacetValue>
          <Count>0</Count>
          <FilterValue>String</FilterValue>
          <Value>String</Value>
        </FacetValue>
      </Values>
    </Facet>
  </Facets>
  <NumberOfHits>0</NumberOfHits>
  <Profile>String</Profile>
  <QueryTimeMilliSeconds>0</QueryTimeMilliSeconds>
  <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>
  <Version>String</Version>
  <Hits>
    <CompanyHit>
      <Company>
        <CompanyCode>String</CompanyCode>
        <ContactPoints>
          <ContactPoint>
            <Label>String</Label>
            <Name>String</Name>
            <Type>String</Type>
            <Value>String</Value>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </ContactPoint>
        </ContactPoints>
        <Groups>
          <Group>
            <Id>0</Id>
            <IsMainGroup>false</IsMainGroup>
            <TopNode>
              <Children>
                <GroupMember>
                  <Children>
                    <GroupMember>
                      <Children>
                        <GroupMember i:nil="true" />
                      </Children>
                      <ContactPoint>
                        <Label>String</Label>
                        <Name>String</Name>
                        <Type>String</Type>
                        <Value>String</Value>
                        <Values>
                          <KeyValue>
                            <Key>String</Key>
                            <Type>String</Type>
                            <Value>String</Value>
                          </KeyValue>
                        </Values>
                      </ContactPoint>
                    </GroupMember>
                  </Children>
                  <ContactPoint>
                    <Label>String</Label>
                    <Name>String</Name>
                    <Type>String</Type>
                    <Value>String</Value>
                    <Values>
                      <KeyValue>
                        <Key>String</Key>
                        <Type>String</Type>
                        <Value>String</Value>
                      </KeyValue>
                    </Values>
                  </ContactPoint>
                </GroupMember>
              </Children>
              <ContactPoint>
                <Label>String</Label>
                <Name>String</Name>
                <Type>String</Type>
                <Value>String</Value>
                <Values>
                  <KeyValue>
                    <Key>String</Key>
                    <Type>String</Type>
                    <Value>String</Value>
                  </KeyValue>
                </Values>
              </ContactPoint>
            </TopNode>
          </Group>
        </Groups>
        <Id>String</Id>
        <Industries>
          <Industry>
            <Code>String</Code>
            <Name>String</Name>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </Industry>
        </Industries>
        <KeyFigures>
          <KeyFigure>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
            <Year>0</Year>
          </KeyFigure>
        </KeyFigures>
        <LegalInformation>
          <CommonName>String</CommonName>
          <CompanyType>String</CompanyType>
          <FoundedDate>0001-01-01T00:00:00</FoundedDate>
          <LegalName>String</LegalName>
          <NaceIndustries>
            <Industry>
              <Code>String</Code>
              <Name>String</Name>
              <Values>
                <KeyValue>
                  <Key>String</Key>
                  <Type>String</Type>
                  <Value>String</Value>
                </KeyValue>
              </Values>
            </Industry>
          </NaceIndustries>
          <PostalAddress>
            <Number>String</Number>
            <PostOffice>String</PostOffice>
            <PostalArea>String</PostalArea>
            <PostalCode>String</PostalCode>
            <PostalCountry>String</PostalCountry>
            <Value>String</Value>
          </PostalAddress>
          <StreetAddress>
            <AddressText>String</AddressText>
            <CityArea>String</CityArea>
            <CitySector>String</CitySector>
            <Coordinate>
              <Latitude>0</Latitude>
              <Longitude>0</Longitude>
            </Coordinate>
            <Country>String</Country>
            <County>String</County>
            <HouseLetter>String</HouseLetter>
            <HouseNumber>String</HouseNumber>
            <Municipality>String</Municipality>
            <MunicipalityCode>String</MunicipalityCode>
            <PostalArea>String</PostalArea>
            <PostalCode>String</PostalCode>
            <Region>String</Region>
            <StreetName>String</StreetName>
            <TradeArea>String</TradeArea>
            <TradeAreaId>0</TradeAreaId>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </StreetAddress>
          <Values>
            <KeyValue>
              <Key>String</Key>
              <Type>String</Type>
              <Value>String</Value>
            </KeyValue>
          </Values>
          <VisitorAddress>
            <AddressText>String</AddressText>
            <CityArea>String</CityArea>
            <CitySector>String</CitySector>
            <Coordinate>
              <Latitude>0</Latitude>
              <Longitude>0</Longitude>
            </Coordinate>
            <Country>String</Country>
            <County>String</County>
            <HouseLetter>String</HouseLetter>
            <HouseNumber>String</HouseNumber>
            <Municipality>String</Municipality>
            <MunicipalityCode>String</MunicipalityCode>
            <PostalArea>String</PostalArea>
            <PostalCode>String</PostalCode>
            <Region>String</Region>
            <StreetName>String</StreetName>
            <TradeArea>String</TradeArea>
            <TradeAreaId>0</TradeAreaId>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </VisitorAddress>
        </LegalInformation>
        <Name>String</Name>
        <OpeningHours>
          <OpeningHour>
            <Days>
              <Day>
                <CloseHhmm>0</CloseHhmm>
                <DayOfWeek>String</DayOfWeek>
                <OpenHhmm>0</OpenHhmm>
              </Day>
            </Days>
            <Text>String</Text>
          </OpeningHour>
        </OpeningHours>
        <Person>
          <Birthdate>0001-01-01T00:00:00</Birthdate>
          <ContactPoints>
            <ContactPoint>
              <Label>String</Label>
              <Name>String</Name>
              <Type>String</Type>
              <Value>String</Value>
              <Values>
                <KeyValue>
                  <Key>String</Key>
                  <Type>String</Type>
                  <Value>String</Value>
                </KeyValue>
              </Values>
            </ContactPoint>
          </ContactPoints>
          <Firstname>String</Firstname>
          <Gender>String</Gender>
          <Groups>
            <Group>
              <Id>0</Id>
              <IsMainGroup>false</IsMainGroup>
              <TopNode>
                <Children>
                  <GroupMember>
                    <Children>
                      <GroupMember>
                        <Children>
                          <GroupMember i:nil="true" />
                        </Children>
                        <ContactPoint>
                          <Label>String</Label>
                          <Name>String</Name>
                          <Type>String</Type>
                          <Value>String</Value>
                          <Values>
                            <KeyValue>
                              <Key>String</Key>
                              <Type>String</Type>
                              <Value>String</Value>
                            </KeyValue>
                          </Values>
                        </ContactPoint>
                      </GroupMember>
                    </Children>
                    <ContactPoint>
                      <Label>String</Label>
                      <Name>String</Name>
                      <Type>String</Type>
                      <Value>String</Value>
                      <Values>
                        <KeyValue>
                          <Key>String</Key>
                          <Type>String</Type>
                          <Value>String</Value>
                        </KeyValue>
                      </Values>
                    </ContactPoint>
                  </GroupMember>
                </Children>
                <ContactPoint>
                  <Label>String</Label>
                  <Name>String</Name>
                  <Type>String</Type>
                  <Value>String</Value>
                  <Values>
                    <KeyValue>
                      <Key>String</Key>
                      <Type>String</Type>
                      <Value>String</Value>
                    </KeyValue>
                  </Values>
                </ContactPoint>
              </TopNode>
            </Group>
          </Groups>
          <Id>String</Id>
          <Lastname>String</Lastname>
          <Middlename>String</Middlename>
          <PostalAddress>
            <Number>String</Number>
            <PostOffice>String</PostOffice>
            <PostalArea>String</PostalArea>
            <PostalCode>String</PostalCode>
            <PostalCountry>String</PostalCountry>
            <Value>String</Value>
          </PostalAddress>
          <Relations>
            <Relation>
              <Direction>String</Direction>
              <Id>String</Id>
              <Name>String</Name>
              <Target>
                <HasLink>false</HasLink>
                <Id>String</Id>
                <Type>String</Type>
                <Values>
                  <KeyValue>
                    <Key>String</Key>
                    <Type>String</Type>
                    <Value>String</Value>
                  </KeyValue>
                </Values>
              </Target>
              <Type>String</Type>
              <Values>
                <KeyValue>
                  <Key>String</Key>
                  <Type>String</Type>
                  <Value>String</Value>
                </KeyValue>
              </Values>
            </Relation>
          </Relations>
          <StreetAddress>
            <AddressText>String</AddressText>
            <CityArea>String</CityArea>
            <CitySector>String</CitySector>
            <Coordinate>
              <Latitude>0</Latitude>
              <Longitude>0</Longitude>
            </Coordinate>
            <Country>String</Country>
            <County>String</County>
            <HouseLetter>String</HouseLetter>
            <HouseNumber>String</HouseNumber>
            <Municipality>String</Municipality>
            <MunicipalityCode>String</MunicipalityCode>
            <PostalArea>String</PostalArea>
            <PostalCode>String</PostalCode>
            <Region>String</Region>
            <StreetName>String</StreetName>
            <TradeArea>String</TradeArea>
            <TradeAreaId>0</TradeAreaId>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </StreetAddress>
          <Values>
            <KeyValue>
              <Key>String</Key>
              <Type>String</Type>
              <Value>String</Value>
            </KeyValue>
          </Values>
        </Person>
        <PostalAddress>
          <Number>String</Number>
          <PostOffice>String</PostOffice>
          <PostalArea>String</PostalArea>
          <PostalCode>String</PostalCode>
          <PostalCountry>String</PostalCountry>
          <Value>String</Value>
        </PostalAddress>
        <Relations>
          <Relation>
            <Direction>String</Direction>
            <Id>String</Id>
            <Name>String</Name>
            <Target>
              <HasLink>false</HasLink>
              <Id>String</Id>
              <Type>String</Type>
              <Values>
                <KeyValue>
                  <Key>String</Key>
                  <Type>String</Type>
                  <Value>String</Value>
                </KeyValue>
              </Values>
            </Target>
            <Type>String</Type>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </Relation>
        </Relations>
        <Shareholders>
          <Shareholder>
            <BirthDate>0001-01-01T00:00:00</BirthDate>
            <CompanyCode>String</CompanyCode>
            <Country>String</Country>
            <Id>String</Id>
            <Name>String</Name>
            <Ownership>0</Ownership>
            <RefValue>String</RefValue>
            <Type>String</Type>
            <UnitId>String</UnitId>
            <Values>
              <KeyValue>
                <Key>String</Key>
                <Type>String</Type>
                <Value>String</Value>
              </KeyValue>
            </Values>
          </Shareholder>
        </Shareholders>
        <StreetAddress>
          <AddressText>String</AddressText>
          <CityArea>String</CityArea>
          <CitySector>String</CitySector>
          <Coordinate>
            <Latitude>0</Latitude>
            <Longitude>0</Longitude>
          </Coordinate>
          <Country>String</Country>
          <County>String</County>
          <HouseLetter>String</HouseLetter>
          <HouseNumber>String</HouseNumber>
          <Municipality>String</Municipality>
          <MunicipalityCode>String</MunicipalityCode>
          <PostalArea>String</PostalArea>
          <PostalCode>String</PostalCode>
          <Region>String</Region>
          <StreetName>String</StreetName>
          <TradeArea>String</TradeArea>
          <TradeAreaId>0</TradeAreaId>
          <Values>
            <KeyValue>
              <Key>String</Key>
              <Type>String</Type>
              <Value>String</Value>
            </KeyValue>
          </Values>
        </StreetAddress>
        <Values>
          <KeyValue>
            <Key>String</Key>
            <Type>String</Type>
            <Value>String</Value>
          </KeyValue>
        </Values>
      </Company>
      <Reserved>false</Reserved>
      <Score>0</Score>
    </CompanyHit>
  </Hits>
</CompanySearchResponse>