api

Atlas API

API Endpoint: Search
API för att fråga marknadsdatabasen om en adress är ansluten. Om ni använder Anslutamotorn får ni även information om kommande anslutningar och status på det.
Endpoint URL http://www.example.com/admin/edit/citynetadressess/plain/connected
This API does not require granted privileges, and is open to any user API key This API does not require granted privileges, and is open to any user API key
  • Method: search

  • Söker i Anslutamotorn och sedan Marknadsdatabasen efter adressen. Finns adressen i marknadsdatabasen så skriver det över eventuellt resultat från anslutamotorn. Varje MATCH can vara av SOURCE "mdb" eller "connect" beroende på om uppgifterna kommer från Marknadsdatabasen eller Anslutamotorn.
  • Parameters
    1 api_user int green 1234 The ID for the API user in Atlas
    2 api_key string green abcd1234 The API key for the the API user in Atlas
    3 search string green Arholmagatan 12 The address to be searched
    Endpoint example:
    https://www.example.com/admin/edit/citynetadressess/plain/connected?method=search&api_user=1234&api_key=abcd1234&search=Arholmagatan+12
  • success response


       <search>
          <response>
             <matches>
                <match>
                   <status>connected</status>
                   <source>mdb</source>
                   <building>Västeråshus 25</building>
                   <premise>123-456</premise>
                   <capacity>100000</capacity>
                   <keywords>tv</keywords>
                   <media>3</media>
                   <nettype>3</nettype>
                   <socket>BAFT0105B1182-12</socket>
                   <cpe>1</cpe>
                   <cpetype>ABC123</cpetype>
                   <type>3</type>
                   <tv>3</tv>
                   <area>Bäckby</area>
                   <address>Smältverksgatan 138</address>
                   <city>Västerås</city>
                   <zip>72474</zip>
                </match>
                <match>
                   <status>interest</status>
                   <source>connect</source>
                   <building>Västeråshus 25</building>
                   <type>residential</type>
                   <area>Bäckby</area>
                   <address>Smältverksgatan 138</address>
                   <city>Västerås</city>
                   <zip>72474</zip>
                </match>
             </matches>
          </response>
          <status>success</status>
       </search>