GET api/CompanySelection?user={user}&password={password}&applicationName={applicationName}&selectionId={selectionId}&pageNr={pageNr}&recordsPerPage={recordsPerPage}
Met dit request kunnen bij een doelgroepselectie pagina’s met resultaten (bedrijven) worden opgehaald. De response is gelijk aan die van GetCompanyList. Op het moment dat er voor het eerst via CompanySelection een pagina uit die zoekopdracht wordt gevraagd, leggen we het complete zoekresultaat vast. Wijzigingen na dat moment, die ervoor kunnen zorgen dat bedrijven binnen of juist buiten de doelgroepselectie vallen, hebben dus geen effect meer op de inhoud van de doelgroepselectie.
Request Information
URI Parameters
Naam | Omschrijving | Type | Extra informatie |
---|---|---|---|
user |
E-mailadres van Mijn DATA-collectief account. |
string |
Vereist |
password |
Wachtwoord API koppeling. |
string |
Vereist |
applicationName |
Applicatienaam API koppeling. |
string |
Vereist |
selectionId |
Met dit request kunnen bij een doelgroepselectie pagina’s met resultaten worden opgehaald. |
integer |
Vereist |
pageNr |
Paginanummer. |
integer |
Vereist |
recordsPerPage |
Het aantal resultaten is per pagina is niet instelbaar, er worden altijd 8 resultaten teruggegeven. |
integer |
Standaardwaarde is 0 |
Body Parameters
None.
Response Information
Naam | Omschrijving | Type | Extra informatie |
---|---|---|---|
Companies |
Gevonden bedrijven |
Verzameling van CompanyLimitedResult |
Geen |
NumberOfPages |
Aantal pagina's |
integer |
Geen |
NumberOfCompanies |
Totale hoeveelheid bij de zoekopdracht gevonden bedrijven |
integer |
Geen |
SearchTime |
Tijdsduur zoekopdracht |
time interval |
Geen |
Response Formats
application/json, text/json
{ "Companies": [ { "ID": 1, "Name": "voorbeeld string 2", "Name2": "voorbeeld string 3", "Street": "voorbeeld string 4", "StreetNumber": "voorbeeld string 5", "Addition": "voorbeeld string 6", "City": "voorbeeld string 7", "Deleted": true }, { "ID": 1, "Name": "voorbeeld string 2", "Name2": "voorbeeld string 3", "Street": "voorbeeld string 4", "StreetNumber": "voorbeeld string 5", "Addition": "voorbeeld string 6", "City": "voorbeeld string 7", "Deleted": true } ], "NumberOfPages": 1, "NumberOfCompanies": 2, "SearchTime": "00:00:00.1234567" }
application/xml, text/xml
<CompanyListResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Companies> <CompanyLimitedResult> <ID>1</ID> <Name>voorbeeld string 2</Name> <Name2>voorbeeld string 3</Name2> <Street>voorbeeld string 4</Street> <StreetNumber>voorbeeld string 5</StreetNumber> <Addition>voorbeeld string 6</Addition> <City>voorbeeld string 7</City> <Deleted>true</Deleted> </CompanyLimitedResult> <CompanyLimitedResult> <ID>1</ID> <Name>voorbeeld string 2</Name> <Name2>voorbeeld string 3</Name2> <Street>voorbeeld string 4</Street> <StreetNumber>voorbeeld string 5</StreetNumber> <Addition>voorbeeld string 6</Addition> <City>voorbeeld string 7</City> <Deleted>true</Deleted> </CompanyLimitedResult> </Companies> <NumberOfPages>1</NumberOfPages> <NumberOfCompanies>2</NumberOfCompanies> <SearchTime /> </CompanyListResult>