Atlas API

API

Anslutmotorns API kan användas för att exportera, importera och uppdatera adresser, samt att importera och uppdatera anmälningar.

Alla anrop till API:et sker via

AXA: Atlas XML API och rättigeheter måste läggas upp i API Credentials-modulen hos er för att använda den. Alla anrop ska innehålla information om vilken API-användare som anropar som då ska ha rätt IP-nummer i API Credentials-modulen.

Methods

search_address
application_data
insert_addresses
export_objectdata
bankid_log
export_addresses
object_info
export_applications
insert_address
empty_addresses
latest_applications
bankid_data
qgis_object
object_list
insert_application
search_application

API Endpoint: Anslutamotorn

API för att hantera adresser och anmälningar i Anslutamotorn

Endpoint URL https://www.example.com/admin/edit/connect/plain/api

Note that this API requires an authenticated user id and IP address

Method: search_address
The search is always a direct search, searching for "Storgatan 2" and mode "address" will only show matches where address is exactly "Storgatan 2". This search function will never return more than 100 matches

Request Parameters

1	api_user	int	1234	The ID for the API user in Atlas
2	search	string	Arholmagatan 12	The term to search for
3	field	string	address	What to search, possible values are "address", "building" and "streetname"

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=search_address&api_user=1234&search=Arholmagatan+12&field=address

success response

   <connect>
      <response>
         <matches>
            <post_1234>
               <id>1234</id>
               <oid>8918</oid>
               <origin>import</origin>
               <streetname>Annedalsgatan</streetname>
               <streetnumber>4</streetnumber>
               <streetletter>

               </streetletter>
               <address>Annedalsgatan 4</address>
               <building>Annedal 2</building>
               <premise>

               </premise>
               <zip>72460</zip>
               <city>Stockholm</city>
               <ownername>

               </ownername>
               <owneraddress>

               </owneraddress>
               <ownerzip>

               </ownerzip>
               <ownercity>

               </ownercity>
               <keywords>

               </keywords>
            </post_1234>
         </matches>
      </response>
      <status>success</status>
   </connect>

Method: application_data
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 id int 1234 What application to display data for

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=application_data&api_user=1234&id=1234

success response

   <connect>
      <response>
         <agreement>/villabilder//SNFDMO/2015/06/18/16/Inbjudan_BBB_2015_-_1502.pdf</agreement>
         <bankid>5</bankid>
      </response>
   </connect>

Method: insert_addresses
The data is an array of posts, max 100 posts in the array. All posts must follow the specification, but as with insert_address, can also contain an "id" field for updating existing posts. Consult the MdB import function for an example of using a similar API call.
This is a shorthand for using the insert_address up to 100 times, so all info for insert_address applies here as well.
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 data array Array An array of arrays of the addresses

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=insert_addresses&api_user=1234&data=Array
Method: export_objectdata
Exporterar data för objektet i samma format som "Exportera objektdata" i admin, alla adresser på objektet med status, pris, bankid-info och annat.
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 oid int 1234 What OID to display data for

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=export_objectdata&api_user=1234&oid=1234
Method: bankid_log
Returns the BankID information, but pages with 100 entries per request - use the "stop" and "total" fields to determine if you need to fetch more, using the "start" parameter.
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 start int 200 count to start from

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=bankid_log&api_user=1234&start=200

success response

   <connect>
      <response>
         <log>
            <bankid>
               <id>34</id>
               <socialsecurity>XXXXXXXXXXXX</socialsecurity>
               <name>NAMN NAMNSSON</name>
               <ip>123.123.123.123</ip>
               <signature>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGlu....</signature>
               <ocsp>MIIFVAoBAKCCBU0wggVJBgkrBgEFBQcwAQEEggU6M...</ocsp>
               <date>2015-08-11 17:00:27</date>
               <aid>12345</aid>
            </bankid>
            <bankid>
               <id>67</id>
               <socialsecurity>XXXXXXXXXXXX</socialsecurity>
               <name>NAMN NAMNSSON</name>
               <ip>123.123.123.123</ip>
               <signature>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGlu....</signature>
               <ocsp>MIIFVAoBAKCCBU0wggVJBgkrBgEFBQcwAQEEggU6M...</ocsp>
               <date>2015-08-11 17:00:27</date>
               <aid>12340</aid>
            </bankid>
         </log>
         <start>200</start>
         <stop>400</stop>
         <total>873</total>
      </response>
   </connect>

Method: export_addresses
This function only returns the URL for exporting the database as used in the admin section, but with an added parameter to include the local ID for every post, for using with insert_address and insert_addresses
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 mode string all What scope of addresses to export

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=export_addresses&api_user=1234&mode=all
Method: object_info
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 id int 1234 The object id (OID)

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=object_info&api_user=1234&id=1234

success response

   <connect>
      <response>
         <id>8919</id>
         <name>Barkarö Södra</name>
         <type>residential area</type>
         <options>
            <showpercentage>yes</showpercentage>
            <showdiagram>yes</showdiagram>
            <geocode_source>google</geocode_source>
            <restricted_addresses>auto</restricted_addresses>
            <threshold>50</threshold>
            <thresholdtype>percentage</thresholdtype>
            <thresholdorigin>order</thresholdorigin>
            <map>automap</map>
         </options>
         <grouping>

         </grouping>
         <map>https://www.google.com/maps/d/embed?mid=ze_HdggdXgUs.kSdnlWax1TpI</map>
         <formlink>

         </formlink>
         <origin>ADMIN</origin>
         <uid>auto</uid>
         <position>

         </position>
         <bankid>yes</bankid>
         <price>26500</price>
         <directorder>no</directorder>
      </response>
      <status>success</status>
   </connect>

Method: export_applications
This function only returns the URL for exporting the applications as used in the admin section, but with an added parameter to include the local ID for every post, for using with insert_application.
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=export_applications&api_user=1234
Method: insert_address
The array must follow the specification for the connection engine import function. However, you can add an "id" field to the data array to specify what post to update. The id of any given post is obtained via the search_address function. Without the id field, the address will always be added to the address database even if it is a duplicate.
When using the api to create addresses, the "origin" field will be set to "api" always,
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 data array Array An array of the address

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=insert_address&api_user=1234&data=Array
Method: empty_addresses
"mode" can be "all", "admin", "web", "import" or "api", which means:

all: Remove all addresses in the database
admin: Remove all addresses created by an administrator using the web interface
web: Remove all addresses created by visitors
import: Remove all addresses created by file import
api: Remove all addresses created by the API

Note, however, that if you remove all addresses and then import new ones via the API, all those will be marked as "api" addresses and will no longer be identified as an address created by a visitor, for example
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 mode string admin What posts to delete, valid values are "all", "admin", "web", "import", "api"

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=empty_addresses&api_user=1234&mode=admin
Method: latest_applications
An array of the latest applications from a specified date. More data about each application may be present in application_data()
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 date string 2019-10-112 From what date you want to fetch new applications from

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=latest_applications&api_user=1234&date=2019-10-112

success response

   <latest_applications>
      <response>
         <application>
            <id>468578</id>
            <name>Test Testsson</name>
            <oid>20894</oid>
            <streetname>Nugatan</streetname>
            <zip>11123</zip>
            <status>interest</status>
            <date>2019-06-17</date>
            <building>Karl</building>
            <origin>web</origin>
         </application>
         <application>
            <id>468457</id>
            <name>Emil</name>
            <oid>20854</oid>
            <streetname>Testgatan</streetname>
            <zip>72340</zip>
            <status>interest</status>
            <date>2019-06-17</date>
            <building>Test 1:20</building>
            <origin>web</origin>
         </application>
         <application>
            <id>469648</id>
            <name>Jeppe</name>
            <oid>18806</oid>
            <streetname>testgatan</streetname>
            <streetnumber>1</streetnumber>
            <zip>12345</zip>
            <email>test@test.com</email>
            <status>order</status>
            <date>2019-06-28</date>
            <building>testet:1</building>
            <origin>web</origin>
         </application>
      </response>
      <status>success</status>
   </latest_applications>

Method: bankid_data
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 id int 1234 Which bankid transaction to show info for

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=bankid_data&api_user=1234&id=1234

success response

   <connect>
      <response>
         <socialsecurity>XXXXXXXXXXXX</socialsecurity>
         <name>NAMN NAMNSSON</name>
         <ip>123.123.123.123</ip>
         <signature>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGlu....</signature>
         <ocsp>MIIFVAoBAKCCBU0wggVJBgkrBgEFBQcwAQEEggU6M...</ocsp>
         <date>2015-08-11 17:00:27</date>
      </response>
   </connect>

Method: qgis_object
Returnerar GeoJSON-formatterad data om ett objekt och dess geocode-data, för att läsa in i QGIS direkt

"status" kan vara "all", "interest", "order" eller "connected"
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 oid int 1234 What OID to display data for

3 status string all Only return posts with this status

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=qgis_object&api_user=1234&oid=1234&status=all
Method: object_list
Request Parameters

1 api_user int XXXX API User ID with privileges

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=object_list&api_user=XXXX

success response

   <connect>
      <response>
         <object>
            <id>8918</id>
            <name>Västerås City</name>
            <type>residential area</type>
         </object>
         <object>
            <id>8919</id>
            <name>Barkarö Södra</name>
            <type>residential area</type>
         </object>
      </response>
      <status>success</status>
   </connect>

Method: insert_application
The array must follow the specification for the connection engine import function. The array will be matched to existing posts and update if a duplicate exists.
Request Parameters

1 api_user int 1234 The ID for the API user in Atlas

2 data array Array An array of the application

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=insert_application&api_user=1234&data=Array
Method: search_application

Request Parameters

1	api_user	int	1234	The ID for the API user in Atlas
2	search	string	Johan Bylund	The term to search for
3	field	string	name	What to search, possible values are "address", "building", "streetname", and "name"

Endpoint example:
GET: https://www.example.com/admin/edit/connect/plain/api?method=search_application&api_user=1234&search=Johan+Bylund&field=name

success response

   <connect>
      <response>
         <matches>
            <post_101841>
               <id>101841</id>
               <name>Johan Bylund</name>
               <oid>8921</oid>
               <streetname>Storgatan</streetname>
               <streetnumber>31</streetnumber>
               <streetletter>B</streetletter>
               <premise>1023</premise>
               <phone>08-12 34 56</phone>
               <cell>070-123 45 67</cell>
               <email>johan@stadsnatet.se</email>
               <status>interest</status>
               <date>2014-09-03</date>
               <building>Storis 15:169</building>
               <comment>Jag vill ha!</comment>
               <origin>admin</origin>
               <substatus>waiting</substatus>
            </post_101841>
         </matches>
      </response>
      <status>success</status>
   </connect>

1	api_user	int		1234	The ID for the API user in Atlas
2	date	string		2019-10-112	From what date you want to fetch new applications from

Atlas API

API

Method: search_address

Method: application_data

Method: insert_addresses

Method: export_objectdata

Method: bankid_log

Method: export_addresses

Method: object_info

Method: export_applications

Method: insert_address

Method: empty_addresses

Method: latest_applications

Method: bankid_data

Method: qgis_object

Method: object_list

Method: insert_application

Method: search_application