api-documentatie-managr.io

View the Project on GitHub lead-innovation/api-documentatie-managr.io

Documentatie REST API managr.io

Adres

De REST API is te bereiken op adres https://api-dordrecht.managr.io via https. Alle data worden verzonden en ontvangen in “JSON” formaat.

https://api-dordrecht.managr.io

Authenticatie

Voor het gebruik van deze REST API is een API-sleutel vereist. Deze dient geplaatst te worden in de “header” van de aanvraag.

Voorbeeld:

Api-Key:    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJEb2N1bWVudGF0aWUifQ._fDE4PhSs7CxEm-2JCLdUo5G6CNwGf0UNIbVC5zpZN0

Taal

Het instellen van de taal wordt bepaald door onderstaande “header” instelling. Standaard staat het ingesteld op de Engelse taal (en).

Accept-Language:    nl

HTTP definities

Definitie Omschrijving
GET het ophalen van informatie.
POST het aanmaken van informatie.
PATCH het bijwerken van informatie met een bepaalde deel van de JSON data.
PUT het in het geheel bijwerken van de informatie.
DELETE wordt gebruikt voor het verwijderen van informatie.

Tijdzone

De standaard tijdzone is ingesteld op “Europe/Amsterdam”. Datum en tijd worden getoond volgens ISO 8601 standaard. Een tijdsaanduiding kan als volgt eruit zien.

2019-02-05T16:30:00+01:00

Evenementen

Alleen de actieve evenementen worden getoond. Standaard worden 10 evenementen per aanvraag getoond. Let op! Alleen actieve evenementen waar je API sleutel rechten op heeft, worden getoond in de response.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /events

Voorbeeld antwoord:

{
    "total": 1,
    "previous_page": null,
    "current_page": "https://api-dordrecht.managr.io/events/page/1",
    "next_page": null,
    "last_page": "https://api-dordrecht.managr.io/events/page/1",
    "pages": 1,
    "per_page": 10,
    "schedule": [
        {
            "id": "fa1b26f8-d0cb-4e3e-bb7f-af2ffa0a31da",
            "url": "https://www.themoviesdordrecht.nl",
            "type": "Movie",
            "title": "The Favourite",
            "subtitle": "Nederlands",
            "synopsis": "<p>Kostuumdrama over \"bitch-fight\" aan het hof van Queen Anne rond 1700</p>",
            "created_date": "2019-02-05T16:30:00+01:00",
            "start_date": "2019-02-05T16:30:00+01:00",
            "end_date": "2019-02-05T18:30:00+01:00", 
            "modified_date": "2019-02-01T00:00:00+01:00",
            "location": [
                {
                    "id": null,
                    "name": "The Movies Dordrecht",
                    "address": "Nieuwstraat 60-62",
                    "house_number": 60,
                    "house_number_suffix": null,
                    "zip_code": "3311 XR",
                    "location": "Dordrecht",
                    "country": "Nederland",
                    "facebook": null,
                    "twitter": null,
                    "instagram": null,
                    "longitude": null,
                    "latitude": null,
                    "is_donator": false,
                    "categories": [
                        {
                            "id": "05bbaa82-6184-4240-967d-148dc1442ab5",
                            "description": "Restaurants"
                        }
                    ],
                    "tags": [
                        {
                            "id": "e2269088-0c7f-448e-8877-0283b1287c88",
                            "description": "Eetcafé"
                        }
                    ],
                    "files": [
                        {
                            "type": "Text",
                            "name": "example.txt",
                            "url": null,
                            "title": "Example",
                            "introduction": "",
                            "file_url": "https://files-dordrecht.managr.io/public/document/NzUxNjk2NjNkMDY4MDU2ODZjMDI3MzEyM2RkMzMyODIxMDA5ZTVkMGExMmZlZjM0ZGI1YzBjZWE0M2YxM2JiYnx0eHR8dGV4dC9wbGFpbg=="
                        }
                    ],
                    "stills": [
                        {
                            "type": "Image",
                            "name": "image.jpg",
                            "url": null,
                            "title": "Test image",
                            "introduction": "",
                            "image_url": "https://files-dordrecht.managr.io/public/free-image/MaZ5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
                        }
                    ],
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/MzZ5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
                }
            ],
            "origin_url": "https://www.themoviesdordrecht.nl/films/the-favourite/",
            "ticket_buy_url": "https://webshop.themoviesdordrecht.nl/themoviesdordrecht/nl/flow_configs/tmd/steps/start/show/230029",
            "image_url": "https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==", 
            "stills": [
                {
                    "name": "Example-1.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2QwODZiZjVlMGUwM2EzMjI1NGM1OGUzNzk2YzNjMjUxNTkxZmRjOGM0ZjkwNDBkMDYzNzAyMzQyMTk1MGU0Znxwbmd8aW1hZ2UvanBlZw=="
                }, 
                {
                    "name": "Example-2.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2ViOTExNmUwNDY4Y2VkZmYxMTFmNGQ2OGY0Mzk1Y2ExNWEzZWIwNDBjN2YyYWJlZGQ1OTNkYmI5NTU0MzdjNHxwbmd8aW1hZ2UvanBlZw=="
                }                
            ],
            "categories": [
                {
                    "id": "05bbaa82-6184-4240-967d-148dc1442ab5",
                    "description": "Restaurants"
                }
            ],
            "tags": [
              {
                    "id": "e2269088-0c7f-448e-8877-0283b0087c88",
                    "description": "Eetcafé"
                }
            ],
            "files": [
                {
                    "type": "Text",
                    "name": "example.txt",
                    "url": null,
                    "title": "Example text",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/NzUaBjk2NjNkMDY4MDU2ODZjMDI3MzEyM2RkMzMyODIxMDA5ZTVkMGExMmZlZjM0ZGI1YzBjZWE0M2YxM2JiYnx0eHR8dGV4dC9wbGFpbg=="
                },
                {
                    "type": "PDF",
                    "name": "Examplepdf.pdf",
                    "url": null,
                    "title": "Example PDF",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/NABzZmM5ZjMwNzkwYmQwMjBjNDMxZTA4YTMzMjM1ODJkMzQ1NzEyNzhiOWY5YjFhODZiNmE2ZTMyNTNlNzA2ZXxwZGZ8YXBwbGljYXRpb24vcGRm"
                }
            ],
            "is_postponed": false,
            "is_donator": false,
            "is_highlighted": false,
            "seo_url": "the-favourite",
            "related_events": [
                {
                    "event_id": "8c87ea6e-4302-43b0-90e4-9d0dd2136869",
                    "seo_url": "the-favourite-2",
                    "origin_url": null,
                    "ticket_buy_url": "",
                    "is_postponed": false,
                    "is_highlighted": false,
                    "start_date": "2020-04-11T00:00:00+02:00",
                    "end_date": "2020-04-30T00:00:00+02:00",
                    "modified_date": "2020-04-06T15:33:38.116076+02:00"
                }
            ]
        }
    ]
}

In het antwoord is een afbeelding url te vinden. Dit is de locatie van de afbeelding in volledige grootte. Deze kan worden geschaald. Met de parameters “w” en “h” kan de afbeelding aangepast worden.

Zie voorbeelden hieronder.

Voorbeelden:

  1. Alleen de breedte van de afbeelding is aangepast. De hoogte van de afbeelding wordt automatisch aangepast.
https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==?w=100
  1. Alleen de hoogte van de afbeelding is aangepast. De breedte van de afbeelding wordt automatisch aangepast.
https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==?h=100
  1. Zowel breedte als hoogte van de afbeelding is aangepast. De afbeelding wordt dan zoveel mogelijk in de grootte aangepast. Delen van de afbeelding zullen mogelijk worden weggeknipt. Dit is afhankelijk van de opgegeven verhouding in breedte en hoogte.
https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==?w=100&h=100

Type bestanden in files kan het volgende zijn:

Bij stills zijn het altijd van de type Image. De sleutel image_url voor zowel locatie als categorie is de hoofd afbeelding.

Paginering

Elk aanvraag zal een maximum aantal evenementen teruggeven. Het gaan naar de volgende lijst met evenementen kan via de link in het antwoord of door via het aanpassen van de url.

Adres:

GET /events/page/2

Filteren van evenementen

Het is mogelijk te zoeken naar specifieke soorten evenementen. De “GET request” parameters die worden ondersteund zijn hieronder te vinden in de tabel.

Parameter Omschrijving
filter_id het filteren op basis van website. Zie hoofdstuk “Filter opties”.
type_id het filteren op basis type evenement. Zie hoofdstuk “Evenement types”.
keywords zoeken naar evenementen via sleutelwoorden. Er wordt gezocht in de titel, subtitel en samenvatting van het evenement.
start_date het filteren van evenementen vanaf een bepaalde datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-dd”
end_date het filteren van evenementen tot en met een bepaalde datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-dd”
per_page het tonen van een maximum aantal evenementen per antwoord. Het maximum toegestane aantal bedraagt 100 evenementen.
modified_since filter evenementen vanaf de laatst bewerkte datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-ddThh:mm:ss”
show_event_n_times het tonen van het eerstvolgende aantal unieke evenementen per combinatie van url en titel (bijv. https://www.kinepolis.nl en Joker)

Voorbeeld:

GET /events/page/1?type_id=1&start_date=2019-02-05&keywords=actie film

Verlopen Evenementen

Alleen de verlopen evenementen worden getoond. Standaard worden 10 evenementen per aanvraag getoond.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /events/expired

Voorbeeld antwoord:

{
    "total": 1,
    "previous_page": null,
    "current_page": "https://api-dordrecht.managr.io/events/expired/page/1",
    "next_page": null,
    "last_page": "https://api-dordrecht.managr.io/events/expired/page/1",
    "pages": 1,
    "per_page": 10,
    "schedule": [
        {
            "id": "fa1b26f8-d0cb-4e3e-bb7f-af2ffa0a31da",
            "url": "https://www.themoviesdordrecht.nl",
            "type": "Movie",
            "title": "The Favourite",
            "subtitle": "Nederlands",
            "synopsis": "<p>Kostuumdrama over \"bitch-fight\" aan het hof van Queen Anne rond 1700</p>",
            "start_date": "2019-02-05T16:30:00+01:00",
            "end_date": "2019-02-05T18:30:00+01:00", 
            "modified_date": "2019-02-01T00:00:00+01:00",
            "location": [
                {
                    "id": null,
                    "name": "The Movies Dordrecht",
                    "address": "Nieuwstraat 60-62",
                    "house_number": 60,
                    "house_number_suffix": null,
                    "zip_code": "3311 XR",
                    "location": "Dordrecht",
                    "country": "Nederland",
                    "facebook": null,
                    "twitter": null,
                    "instagram": null,
                    "longitude": null,
                    "latitude": null,
                    "is_donator": false,
                    "categories": [
                        {
                            "id": "05bbaa82-6184-4240-967d-148dc1442ab5",
                            "description": "Restaurants"
                        }
                    ],
                    "tags": [
                        {
                            "id": "e2269088-0c7f-448e-8877-0283b1287c88",
                            "description": "Eetcafé"
                        }
                    ],
                    "files": [
                        {
                            "type": "Text",
                            "name": "example.txt",
                            "url": null,
                            "title": "Example",
                            "introduction": "",
                            "file_url": "https://files-dordrecht.managr.io/public/document/NzUxNjk2NjNkMDY4MDU2ODZjMDI3MzEyM2RkMzMyODIxMDA5ZTVkMGExMmZlZjM0ZGI1YzBjZWE0M2YxM2JiYnx0eHR8dGV4dC9wbGFpbg=="
                        }
                    ],
                    "stills": [
                        {
                            "type": "Image",
                            "name": "image.jpg",
                            "url": null,
                            "title": "Test image",
                            "introduction": "",
                            "image_url": "https://files-dordrecht.managr.io/public/free-image/MaZ5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
                        }
                    ],
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/MzZ5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
                }
            ],
            "origin_url": "https://www.themoviesdordrecht.nl/films/the-favourite/",
            "ticket_buy_url": "https://webshop.themoviesdordrecht.nl/themoviesdordrecht/nl/flow_configs/tmd/steps/start/show/230029",
            "image_url": "https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==", 
            "stills": [
                {
                    "name": "Example-1.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2QwODZiZjVlMGUwM2EzMjI1NGM1OGUzNzk2YzNjMjUxNTkxZmRjOGM0ZjkwNDBkMDYzNzAyMzQyMTk1MGU0Znxwbmd8aW1hZ2UvanBlZw=="
                }, 
                {
                    "name": "Example-2.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2ViOTExNmUwNDY4Y2VkZmYxMTFmNGQ2OGY0Mzk1Y2ExNWEzZWIwNDBjN2YyYWJlZGQ1OTNkYmI5NTU0MzdjNHxwbmd8aW1hZ2UvanBlZw=="
                }                
            ],
            "categories": [
                {
                    "id": "05bbaa82-6184-4240-967d-148dc1442ab5",
                    "description": "Restaurants"
                }
            ],
            "tags": [
              {
                    "id": "e2269088-0c7f-448e-8877-0283b0087c88",
                    "description": "Eetcafé"
                }
            ],
            "files": [
                {
                    "type": "Text",
                    "name": "example.txt",
                    "url": null,
                    "title": "Example text",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/NzUaBjk2NjNkMDY4MDU2ODZjMDI3MzEyM2RkMzMyODIxMDA5ZTVkMGExMmZlZjM0ZGI1YzBjZWE0M2YxM2JiYnx0eHR8dGV4dC9wbGFpbg=="
                },
                {
                    "type": "PDF",
                    "name": "Examplepdf.pdf",
                    "url": null,
                    "title": "Example PDF",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/NABzZmM5ZjMwNzkwYmQwMjBjNDMxZTA4YTMzMjM1ODJkMzQ1NzEyNzhiOWY5YjFhODZiNmE2ZTMyNTNlNzA2ZXxwZGZ8YXBwbGljYXRpb24vcGRm"
                }
            ],
            "is_postponed": false,
            "is_donator": false,
            "is_highlighted": false,
            "seo_url": "the-favourite",
            "related_events": [
                {
                    "event_id": "8c87ea6e-4302-43b0-90e4-9d0dd2136869",
                    "seo_url": "the-favourite-3",
                    "origin_url": null,
                    "ticket_buy_url": "",
                    "is_postponed": false,
                    "is_highlighted": false,
                    "start_date": "2020-04-11T00:00:00+02:00",
                    "end_date": "2020-04-30T00:00:00+02:00",
                    "modified_date": "2020-04-06T15:33:38.116076+02:00"
                }
            ]         
        }
    ]
}

In het antwoord is een afbeelding url te vinden. Dit is de locatie van de afbeelding in volledige grootte. Deze kan worden geschaald met de parameters “w” en “h”.

Zie voorbeelden hieronder.

Voorbeelden:

  1. Alleen de breedte van de afbeelding is aangepast. De hoogte van de afbeelding wordt automatisch aangepast.
https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==?w=100
  1. Alleen de hoogte van de afbeelding is aangepast. De breedte van de afbeelding wordt automatisch aangepast.
https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==?h=100
  1. Zowel breedte als hoogte van de afbeelding is aangepast. De afbeelding wordt dan zoveel mogelijk in de grootte aangepast. Delen van de afbeelding zullen mogelijk worden weggeknipt. Dit is afhankelijk van de opgegeven verhouding in breedte en hoogte.
https://files-dordrecht.managr.io/public/free-image/OGU3YmNiZmY5NzNhNDc3OWYyYmUxOWM5ZGE3OGE5ZmZmZjcxMmZkNDM4MTFjZjEzNDg1ZTM0YzZlYjY1ZTQzNnxqcGd8aW1hZ2UvanBlZw==?w=100&h=100

Type bestanden in files kan het volgende zijn:

Bij stills zijn het altijd van de type Image. De sleutel image_url voor zowel locatie als categorie is de hoofd afbeelding.

Paginering

Elk aanvraag zal een maximum aantal evenementen teruggeven. Het gaan naar de volgende lijst met evenementen kan via de link in het antwoord of door via het aanpassen van de url.

Adres:

GET /events/expired/page/2

Filteren van evenementen

Het is mogelijk te zoeken naar specifieke soorten evenementen. De “GET request” parameters die worden ondersteund zijn hieronder te vinden in de tabel.

Parameter Omschrijving
filter_id het filteren op basis van website. Zie hoofdstuk “Filter opties”.
type_id het filteren op basis type evenement. Zie hoofdstuk “Evenement types”.
keywords zoeken naar evenementen via sleutelwoorden. Er wordt gezocht in de titel, subtitel en samenvatting van het evenement.
start_date het filteren van evenementen vanaf een bepaalde datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-dd”
end_date het filteren van evenementen tot en met een bepaalde datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-dd”
per_page het tonen van een maximum aantal evenementen per antwoord. Het maximum toegestane aantal bedraagt 1000 evenementen.
modified_since filter evenementen vanaf de laatst bewerkte datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-ddThh:mm:ss”
fields De veld(en) die in de resultaten weergegeven moet worden.

Voorbeeld:

GET /events/expired/page/1?type_id=1&start_date=2019-02-05&keywords=actie film

Voorbeeld antwoord met alleen fields:

GET /events/expired/page/1/?fields=id,title&per_page=2&start_date=2019-07-01
{
    "total": 10,
    "previous_page": null,
    "current_page": "https://api-dordrecht.managr.io/events/expired/page/1",
    "next_page": null,
    "last_page": "https://api-dordrecht.managr.io/events/expired/page/10",
    "pages": 5,
    "per_page": 2,
    "schedule": [
        {
            "id": "d6a8be3f-123b-2a3c-a41c-c034e541e79a",
            "title": "test movie"
        },
        {
            "id": "d6a8be3f-123b-2a3c-a41c-c321e123e00b",
            "title": "test movie 2"
        }
    ]
}

Filter opties

Voor het filteren van evenementen op basis van een website is een “filter_id” nodig. Deze kunnen worden opgehaald via onderstaand adres.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /events/filter-options

Voorbeeld antwoord:

{
    "options": [
        {
            "filter_id": "https://www.bibelot.net",
            "name": "Bibelot",
            "type_id": 2,
            "type_name": "Muziek"
        },
        {
            "filter_id": "https://www.dolhuis.com",
            "name": "Dolhuis",
            "type_id": 2,
            "type_name": "Muziek"
        }
    ]
}

Evenement types

Alle evenementen zijn gegroepeerd in type evenement. Deze kunnen opgehaald worden via het onderstaand adres.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /events/types

Voorbeeld antwoord:

{
    "types": [
        {
            "id": 1,
            "name": "Films"
        },
        {
            "id": 2,
            "name": "Muziek"
        },
        {
            "id": 3,
            "name": "Theater"
        },
        {
            "id": 4,
            "name": "Museum"
        },
        {
            "id": 5,
            "name": "Expositie"
        },
        {
            "id": 6,
            "name": "Varia"
        }
    ]
}

Evenement details

De details kunnen per evenement worden opgevraagd met het evenement ID.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /events/details/<uuid:id>

Voorbeeld antwoord:

https://api-dordrecht.managr.io/events/details/6924543f-ed05-4cb8-827b-2a344e94cac6
{
    "id": "6924543f-ed05-4cb8-827b-2a344e94cac6",
    "url": "https://www.debibliotheekaanzet.nl",
    "type": "Various",
    "title": "Taalpunt",
    "subtitle": "gratis",
    "synopsis": "<p>Wil je je Nederlands verbeteren, maar weet je niet waar je moet beginnen?</p>",
    "start_date": "2019-02-19T10:00:00+01:00",
    "end_date": "2019-02-19T11:30:00+01:00", 
    "modified_date": "2019-02-01T00:00:00+01:00",
    "location": [
      {
        "name": "Bibliotheek Dordrecht Stadspolders",
        "address": null,
        "house_number": null,
        "house_number_suffix": null,
        "zip_code": null,
        "location": null,
        "country": null,
        "facebook": null,
        "twitter": null,
        "instagram": null,
        "longitude": null,
        "latitude": null,
        "is_donator": false,
        "categories": [
            {
                "id": "a94ef5b2-5c56-4244-91d6-495e6454bcab",
                "description": "test 1"
            },
            {
                "id": "741a4ca6-97a1-4bfb-aa56-58824d50a25e",
                "description": "test child 1"
            }
        ],
        "file_code": "MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw==",
        "tags": [
            {
                "id": "73f913ca-620f-40f6-9d2d-71b4cf10272a",
                "description": "test_tag_1"
            }
        ],
        "files": [
            {
                "type": "Text",
                "name": "text_example.txt",
                "url": null,
                "file_code": "M2QxMGMwYmFhOTJlYWM3MTgxZDgxMjcyNDViZGMyMzYyNjE1ZDMxNWQ3ODM2ZWM5ZDk2MDdjNmYxODg2YTVkN3x0eHR8dGV4dC9wbGFpbg==",
                "title": "text example",
                "introduction": ""
            },
            {
                "type": "PDF",
                "name": "test.pdf",
                "url": null,
                "file_code": "YzFmNzA2MTg2Y2IzYzk1Y2E4MzZiODBkZmFjNDE3ZTQ3YmEwMzI4Yzc3YmJlYjg1MDA0YmFlMDU3NDJlOTBmOHxwZGZ8YXBwbGljYXRpb24vcGRm",
                "title": "test",
                "introduction": ""
            }
        ],
        "stills": [
            {
                "type": "Image",
                "name": "test_image.jpg",
                "url": null,
                "file_code": "MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw==",
                "title": "test image",
                "introduction": ""
            }
        ]
    }],
    "origin_url": "https://www.debibliotheekaanzet.nl/activiteiten/taalpunt",
    "ticket_buy_url": null,
    "image_url": "https://files-dordrecht.managr.io/public/free-image/ZTM0ODA3NWQyNWE3MmNiNWE1N2EyZmFlNjg4MzI3MWUwMDc4MWEyYTJmZTNkOTk4YzFmZGJkZTQ1YmZhZGRiNHxqcGd8aW1hZ2UvanBlZw==", 
    "stills": [
        {
            "name": "Example-1.jpg",
            "image_url": "https://files-dordrecht.managr.io/public/free-image/M2QwODZiZjVlMGUwM2EzMjI1NGM1OGUzNzk2YzNjMjUxNTkxZmRjOGM0ZjkwNDBkMDYzNzAyMzQyMTk1MGU0Znxwbmd8aW1hZ2UvanBlZw=="
        }, 
        {
            "name": "Example-2.jpg",
            "image_url": "https://files-dordrecht.managr.io/public/free-image/M2ViOTExNmUwNDY4Y2VkZmYxMTFmNGQ2OGY0Mzk1Y2ExNWEzZWIwNDBjN2YyYWJlZGQ1OTNkYmI5NTU0MzdjNHxwbmd8aW1hZ2UvanBlZw=="
        }                
    ],
    "tags": [
        {
            "id": "73f913ca-620f-40f6-9d2d-71b4cf10272a",
            "description": "test_tag_1"
        }
    ],
    "files": [
        {
            "type": "Text",
            "name": "iams modelleren eerste opzet.txt",
            "url": null,
            "file_code": "M2QxMGMwYmFhOTJlYWM3MTgxZDgxMjcyNDViZGMyMzYyNjE1ZDMxNWQ3ODM2ZWM5ZDk2MDdjNmYxODg2YTVkN3x0eHR8dGV4dC9wbGFpbg==",
            "title": "iams modelleren eerste opzet",
            "introduction": ""
        },
        {
            "type": "PDF",
            "name": "ps1583inst.pdf",
            "url": null,
            "file_code": "YzFmNzA2MTg2Y2IzYzk1Y2E4MzZiODBkZmFjNDE3ZTQ3YmEwMzI4Yzc3YmJlYjg1MDA0YmFlMDU3NDJlOTBmOHxwZGZ8YXBwbGljYXRpb24vcGRm",
            "title": "ps1583inst",
            "introduction": ""
        }
    ],
    "categories": [
        {
            "id": "05bbaa82-6184-4240-967d-148dc1442ab5",
            "description": "Restaurants"
        }
    ],
    "is_donator": false
}

Films

Er bestaat de mogelijkheid om alleen film evenementen op te halen.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /events/movies

Voorbeeld antwoord:

{
    "total": 2,
    "movies": [
        {
            "title": "A Star is Born",
            "url": "https://www.themoviesdordrecht.nl",
            "subtitle": "Nederlands",
            "synopsis": "<p>Een in verval geraakte country-ster wordt verliefd op de onbekende artieste Ally.</p>",
            "location": [
                {
                    "name": "The Movies Dordrecht",
                    "address": "Nieuwstraat 60-62",
                    "house_number": 60,
                    "house_number_suffix": null,
                    "zip_code": "3311 XR",
                    "location": "Dordrecht",
                    "country": "Nederland",
                    "facebook": null,
                    "twitter": null,
                    "instagram": null,
                    "longitude": null,
                    "latitude": null,
                    "is_donator": false
                }            
            ],            
            "events": [
                {
                    "id": "7c667809-15ca-4b7b-8e70-8fe5409fe4e1",
                    "start_date": "2019-02-18T16:15:00+01:00",
                    "end_date": "2019-02-18T18:28:00+01:00", 
                    "modified_date": "2019-02-01T00:00:00+01:00",
                    "origin_url": "https://www.themoviesdordrecht.nl/films/a-star-is-born/",
                    "ticket_buy_url": "https://webshop.themoviesdordrecht.nl/themoviesdordrecht/nl/flow_configs/tmd/steps/start/show/235234"
                },
                {
                    "id": "e945bd9f-6ce2-4136-a575-d505e1ca3271",
                    "start_date": "2019-02-19T19:00:00+01:00",
                    "end_date": "2019-02-19T21:13:00+01:00",
                    "origin_url": "https://www.themoviesdordrecht.nl/films/a-star-is-born/",
                    "ticket_buy_url": "https://webshop.themoviesdordrecht.nl/themoviesdordrecht/nl/flow_configs/tmd/steps/start/show/235270"
                }
            ],
            "image_url": "https://files-dordrecht.managr.io/public/free-image/NmY2N2Q1NDYyMzMxNDFhOTM0OGNjYTVhMjY5OTQ2ZDAxNGY5NjlhMTg2NGJiYTYyN2Y5NWZjM2MzNGYyOGVmZHxqcGd8aW1hZ2UvanBlZw==", 
            "stills": [
                {
                    "name": "Example-1.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2QwODZiZjVlMGUwM2EzMjI1NGM1OGUzNzk2YzNjMjUxNTkxZmRjOGM0ZjkwNDBkMDYzNzAyMzQyMTk1MGU0Znxwbmd8aW1hZ2UvanBlZw=="
                }, 
                {
                    "name": "Example-2.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2ViOTExNmUwNDY4Y2VkZmYxMTFmNGQ2OGY0Mzk1Y2ExNWEzZWIwNDBjN2YyYWJlZGQ1OTNkYmI5NTU0MzdjNHxwbmd8aW1hZ2UvanBlZw=="
                }                
            ],
            "is_donator": false
        },
        {
            "title": "Alita: Battle Angel",
            "url": "https://www.kinepolis.nl",
            "subtitle": null,
            "synopsis": "<p>Het verhaal van Alita: Battle Angel speelt zich een aantal eeuwen in de toekomst af.</p>",
            "location": [
                {
                    "name": "Kinepolis Dordrecht",
                    "address": "Lijnbaan",
                    "house_number": 200,
                    "house_number_suffix": null,
                    "zip_code": "3311 RL",
                    "location": "Dordrecht",
                    "country": "Nederland",
                    "facebook": null,
                    "twitter": null,
                    "instagram": null,
                    "longitude": null,
                    "latitude": null,
                    "is_donator": false
                }            
            ],
            "events": [
                {
                    "id": "06cc9e7a-8693-43b5-bced-5ac61bcec63a",
                    "start_date": "2019-02-18T13:10:00+01:00",
                    "end_date": "2019-02-18T15:12:00+01:00", 
                    "modified_date": "2019-02-01T00:00:00+01:00",
                    "origin_url": "https://www.kinepolis.nl/goto-checkout-gate/407470/DORD",
                    "ticket_buy_url": "https://www.kinepolis.nl/goto-checkout-gate/407470/DORD"
                },
                {
                    "id": "e26aad3b-2d10-4cf8-a18a-2ead358f5913",
                    "start_date": "2019-02-18T16:00:00+01:00",
                    "end_date": "2019-02-18T18:02:00+01:00", 
                    "modified_date": "2019-02-01T00:00:00+01:00",
                    "origin_url": "https://www.kinepolis.nl/goto-checkout-gate/403246/DORD",
                    "ticket_buy_url": "https://www.kinepolis.nl/goto-checkout-gate/403246/DORD"
                },
                {
                    "id": "800aefd6-8139-44fe-83bc-220efd3b7115",
                    "start_date": "2019-02-18T18:50:00+01:00",
                    "end_date": "2019-02-18T20:52:00+01:00", 
                    "modified_date": "2019-02-01T00:00:00+01:00",
                    "origin_url": "https://www.kinepolis.nl/goto-checkout-gate/403247/DORD",
                    "ticket_buy_url": "https://www.kinepolis.nl/goto-checkout-gate/403247/DORD"
                }
            ],
            "image_url": "https://files-dordrecht.managr.io/public/free-image/NDlhMWY2NWI2ODFkZDUxYTJhODM0N2Y0Mjk4NDJlNTkzNjQ3ZmYwNDNjYjk1YjU1NTBkMTZiOTFiZjhiYjQ5MHxwbmd8aW1hZ2UvanBlZw==", 
            "stills": [
                {
                    "name": "Example-1.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2QwODZiZjVlMGUwM2EzMjI1NGM1OGUzNzk2YzNjMjUxNTkxZmRjOGM0ZjkwNDBkMDYzNzAyMzQyMTk1MGU0Znxwbmd8aW1hZ2UvanBlZw=="
                }, 
                {
                    "name": "Example-2.jpg",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/M2ViOTExNmUwNDY4Y2VkZmYxMTFmNGQ2OGY0Mzk1Y2ExNWEzZWIwNDBjN2YyYWJlZGQ1OTNkYmI5NTU0MzdjNHxwbmd8aW1hZ2UvanBlZw=="
                }                
            ],
            "is_donator": false
        }
    ]
}

De grootte van de afbeelding links in “image_url” is aan te passen via de parameters “w” en “h”.

Voorbeeld:

https://files-dordrecht.managr.io/public/image/MmU3M2EyMTYyNjRhZGM1MmE3NWVlNWZlYmY4MGMwYmIyM2E0OTJjYzdjMTNhODAyNmEzN2NlZDMyNTdhN2JlMXxqcGd8aW1hZ2UvanBlZw==?w=100&h=100

Beeldbank

Afbeeldingen zijn gegroepeerd op basis van titel.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /image-library

Voorbeeld antwoord:

{
    "total": 2,
    "previous_page": "https://api-dordrecht.managr.io/image-library/page/1",
    "current_page": "https://api-dordrecht.managr.io/image-library/page/1",
    "next_page": null,
    "last_page": "https://api-dordrecht.managr.io/image-library/page/1",
    "pages": 1,
    "per_page": 10,
    "images": [
        {
            "id": "204c0b6c-08a3-4a87-b4b0-db0603199b5e",
            "title": "Vogels",
            "description": "Een foto van vogels.",
            "author": "Jason Smith",
            "width": 3888,
            "height": 2592,
            "meta_data": "",
            "image_url": "https://files-dordrecht.managr.io/public/thumbnail-image/YTRiMDE4NjQzYjNjYmQ5MTE2NmQ2Njc4NzU2ZGMxNzE1N2YzMWM3OWNiNjU1YjM2OWFkOWJkZGZmNzA3NGYwNnxqcGd8aW1hZ2UvanBlZw==", 
            "modified_date": "2019-02-01T00:00:00+01:00"
        },
        {
            "id": "7c128449-104e-4a4e-ae5a-ba97b6f73743",
            "title": "Natuur",
            "description": "Een foto van het landschap.",
            "author": "Fred Miller",
            "width": 3272,
            "height": 4908,
            "meta_data": "",
            "image_url": "https://files-dordrecht.managr.io/public/thumbnail-image/MmU3M2EyMTYyNjRhZGM1MmE3NWVlNWZlYmY4MGMwYmIyM2E0OTJjYzdjMTNhODAyNmEzN2NlZDMyNTdhN2JlMXxqcGd8aW1hZ2UvanBlZw==", 
            "modified_date": "2019-02-01T00:00:00+01:00"
        }
    ]
}

Afbeelding tags

De afbeeldingen zijn gegroepeerd in “tags”. De beschikbare tags zijn op te halen via onderstaand adres.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /image-library/tags

Voorbeeld antwoord:

{
    "tags": [
        "Natuur",
        "Vogels",
        "Water"
    ]
}

Paginering

Het gaan naar de volgende pagina kan door de pagina nummer te plaatsen achter “/page”.

GET /image-library/page/2

Filteren van afbeeldingen

De “GET request” parameters die gebruikt kunnen worden bij het vinden van afbeeldingen zijn hieronder te vinden in de tabel.

Parameter Omschrijving
title het filteren op basis van de titel van de afbeelding.
tags het filteren op basis tags. Zie hoofdstuk “Afbeelding tags”.
id zoeken op basis van de ID van de afbeelding.
modified_since filter afbeeldingen vanaf de laatst bewerkte datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-ddThh:mm:ss”

Voorbeeld op basis van tags.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /image-library?tags=Natuur Vogels

Het is ook mogelijk om tags te scheiden via een komma (,).

Voorbeeld op basis van tags gescheiden door een komma.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /image-library?tags=Natuur,Vogels

Grootte afbeelding

De grootte is aan te passen via de parameters “w” en “h”. De maximale grootte van de afbeelding bedraagt 400 x 400 pixels. De originele afbeelding kan alleen worden gedownload wanneer de gebruiker gegevens heeft ingevuld.

Downloaden van originele afbeeldingen

Het is verplicht om in te schrijven voor het downloaden van de originele afbeeldingen.

Headers:

Api-Key:            (Api sleutel)
Content-Type:       application/json
Accept-Language:    nl

Adres:

POST /image-library/sign-up/for-download

Data die meegestuurd moeten worden.

{
	"agree_terms": true, 
	"name": "John Doe", 
	"email": "jonh.doe@example.com", 
	"reason": "Tonen in onze website.", 
	"images": [
	  "204c0b6c-08a3-4a87-b4b0-db0603199b5e", 
	  "7c128449-104e-4a4e-ae5a-ba97b6f73743"
	]
}

Voorbeeld antwoord:

{
    "images": [
        "https://files-dordrecht.managr.io/public/image/token/eb2a7ae6ad7f9f4c2c89c32697e297029955453b18184be06317734ad987efc1",
        "https://files-dordrecht.managr.io/public/image/token/3fd7f496df65befc2b4ff692d75c8d16eee97142cb7e460900d13595c4a293e3"
    ]
}

Download links zijn slechts éénmalig geldig!

Adresboek

Lijst van locaties

De beschikbare locaties zijn op te halen via onderstaand adres. Standaard worden 10 locaties per aanvraag getoond.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/locations/page/<int:page>

Voorbeeld antwoord:

{
    "total": 1,
    "previous_page": null,
    "current_page": "https://api-dordrecht.managr.io/address-book/locations/page/1",
    "next_page": null,
    "last_page": "https://api-dordrecht.managr.io/address-book/locations/page/1",
    "pages": 1,
    "per_page": 10,
    "locations": [
        {
            "id": "68cc569e-1580-4c46-881c-bf2e2a2b2468",
            "organisation_name": "Test bedrijf",
            "address": "Teststraat",
            "house_number": 100,
            "house_number_suffix": "A",
            "zip_code": "1234AB",
            "city": "Amsterdam",
            "country": "Nederland",
            "phone": "020 - 12 34 56 78",
            "website": "www.testbedrijf.nl",
            "facebook": "www.facebook.com/testbedrijf",
            "twitter": "www.twitter.com/testbedrijf",
            "instagram": "www.instagram.com/instagram",
            "public_email": "info@testbedrijf.nl",
            "note": "Bedrijf bestaat al sinds 1900", 
            "modified_date": "2019-02-01T00:00:00+01:00", 
            "opening_hours": {
                "holidays": "Gesloten",
                "monday": "gesloten",
                "tuesday": "10.00-17.00",
                "wednesday": "10.00-17.00",
                "thursday": "10.00-17.00",
                "friday": "10.00-19.00",
                "saturday": "10.00-17.00",
                "sunday": "Gesloten"
            },
            "longitude": null,
            "latitude": null,
            "categories": [
                {
                    "id": "a94ef5b2-5c56-4244-91d6-495e6454bcab",
                    "description": "test cat 1"
                },
                {
                    "id": "741a4ca6-97a1-4bfb-aa56-58824d50a25e",
                    "description": "test cat 2"
                }
            ],
            "tags": [
                {
                    "id": "73f913ca-620f-40f6-9d2d-71b4cf10272a",
                    "description": "test_tag_1"
                }
            ],
            "files": [
                {
                    "type": "Text",
                    "name": "example_text.txt",
                    "url": null,
                    "title": "Example text",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/M2QxMGMwYmFhOTJlYWM3MTgxZDgxMjcyNDViZGMyMzYyNjE1ZDMxNWQ3ODM2ZWM5ZDk2MDdjNmYxODg2YTVkN3x0eHR8dGV4dC9wbGFpbg=="
                },
                {
                    "type": "PDF",
                    "name": "example_pdf.pdf",
                    "url": null,
                    "title": "Example PDF",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/YzFmNzA2MTg2Y2IzYzk1Y2E4MzZiODBkZmFjNDE3ZTQ3YmEwMzI4Yzc3YmJlYjg1MDA0YmFlMDU3NDJlOTBmOHxwZGZ8YXBwbGljYXRpb24vcGRm"
                }
            ],
            "stills": [
                {
                    "type": "Image",
                    "name": "example_image.jpg",
                    "url": null,
                    "title": "Example image",
                    "introduction": "",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
                }
            ],
            "image_url": "https://files-dordrecht.managr.io/public/free-image/MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw==",
            "is_donator": false
        }
    ]
}

Locatie details

Voor het ophalen van de details van een specifieke locatie kan het volgende adres gebruikt worden.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/location/<uuid:location_id>

Voorbeeld antwoord:

{
    "id": "68cc569e-1580-4c46-881c-bf2e2a2b2468",
    "organisation_name": "Test bedrijf",
    "address": "Teststraat",
    "house_number": 100,
    "house_number_suffix": "A",
    "zip_code": "1234AB",
    "city": "Amsterdam",
    "country": "Nederland",
    "phone": "020 - 12 34 56 78",
    "website": "www.testbedrijf.nl",
    "facebook": "www.facebook.com/testbedrijf",
    "twitter": "www.twitter.com/testbedrijf",
    "instagram": "www.instagram.com/instagram",
    "public_email": "info@testbedrijf.nl",
    "note": "Bedrijf bestaat al sinds 1900", 
    "modified_date": "2019-02-01T00:00:00+01:00", 
    "opening_hours": {
        "holidays": "Alleen tijdens nationale feestdagen gesloten",
        "monday": "09:00 - 17:00",
        "tuesday": "09:00 - 17:00",
        "wednesday": "09:00 - 17:00",
        "thursday": "09:00 - 17:00",
        "friday": "09:00 - 17:00",
        "saturday": "10:00 - 17:00",
        "sunday": "gesloten"
    },
    "longitude": null,
    "latitude": null,
    "categories": [
        {
            "id": "a94ef5b2-5c56-4244-91d6-495e6454bcab",
            "description": "test cat 1"
        },
        {
            "id": "741a4ca6-97a1-4bfb-aa56-58824d50a25e",
            "description": "test cat 2"
        }
    ],
    "tags": [
        {
            "id": "73f913ca-620f-40f6-9d2d-71b4cf10272a",
            "description": "test_tag_1"
        }
    ],
    "files": [
        {
            "type": "Text",
            "name": "example_text.txt",
            "url": null,
            "title": "Example text",
            "introduction": "",
            "file_url": "https://files-dordrecht.managr.io/public/document/M2QxMGMwYmFhOTJlYWM3MTgxZDgxMjcyNDViZGMyMzYyNjE1ZDMxNWQ3ODM2ZWM5ZDk2MDdjNmYxODg2YTVkN3x0eHR8dGV4dC9wbGFpbg=="
        },
        {
            "type": "PDF",
            "name": "example_pdf.pdf",
            "url": null,
            "title": "Example PDF",
            "introduction": "",
            "file_url": "https://files-dordrecht.managr.io/public/document/YzFmNzA2MTg2Y2IzYzk1Y2E4MzZiODBkZmFjNDE3ZTQ3YmEwMzI4Yzc3YmJlYjg1MDA0YmFlMDU3NDJlOTBmOHxwZGZ8YXBwbGljYXRpb24vcGRm"
        }
    ],
    "stills": [
        {
            "type": "Image",
            "name": "example_image.jpg",
            "url": null,
            "title": "Example image",
            "introduction": "",
            "image_url": "https://files-dordrecht.managr.io/public/free-image/MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
        }
    ],
    "image_url": "https://files-dordrecht.managr.io/public/free-image/MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw==",
    "is_donator": false
}

Filteren van locaties

De “GET request” parameters die gebruikt kunnen worden voor het vinden van locaties zijn hieronder te vinden in de tabel.

Parameter Omschrijving
per_page Aantal resultaten per pagina.
keyword Het zoeken naar een locatie op basis van een kenmerk.
name het filteren op basis van de naam.
email het filteren op basis van het beschikbare e-mail.
address het filteren op basis van het adres.
house_number het filteren op basis van het huisnummer.
house_number_suffix het filteren op basis van de huisnummer toevoeging.
zip_code het filteren op basis van de postcode.
location het filteren op basis van de plaats.
order het sorteren van de resultaten (keuze tussen “asc” of “desc”).
order_by het sorteren van de resultaten op basis van een sorteerveld. Deze zijn “name”, “email”, “city”, “address”, “house_number”, “house_number_suffix” en “zip_code”.
modified_since filter locaties vanaf de laatst bewerkte datum. De datum notatie moet voldoen aan het formaat “YYYY-mm-ddThh:mm:ss”

Voorbeeld op basis van per_page.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/locations/page/1?per_page=5&keyword=test&name=test1&email=a%40b.nl&address=test2&house_number=3&house_number_suffix=c&zip_code=1234AB&location=Rotterdam&order=desc&order_by=name

Locatie tags

De Locaties zijn gegroepeerd in “tags”. De beschikbare tags zijn op te halen via onderstaand adres.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/tags

Voorbeeld antwoord:

{
    "tags": [
        {
            "id": "0c6f9f45-271d-46c7-91f3-88f2bceea6ce",
            "description": "Ontbijt"
        },
        {
            "id": "19d04e7f-8b76-44d8-9e9f-79cfc46b1325",
            "description": "IJssalons"
        }
    ]
}

Locatie categorieën

De Locaties zijn gegroepeerd in “categorieën”. De beschikbare categorieën zijn op te halen via onderstaand adres.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/categories

Voorbeeld antwoord:

{
    "categories": [
        {
            "id": "edbc4904-722f-4d94-b179-f03ba48a7a78",
            "description": "Restaurants"
        },
        {
            "id": "7e221ebb-e2a2-4454-b31d-6466f4e99624",
            "description": "Kroegen"
        }
    ]
}

Categorieën gegroepeerd in een boomstructuur

De beschikbare categorieën zijn op te halen via onderstaand adres en worden in een boomstructuur teruggegeven.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/categories/tree

Voorbeeld antwoord:

{
    "categories": [
        {
            "category_id": "edbc4904-722f-4d94-b179-f03ba48a7a78",
            "description": "Restaurants",
            "subcategories": [
                {
                    "category_id": "ff08a79c-5268-40b6-bfed-c7f644997d00",
                    "description": "Amerikaans",
                    "subcategories": [
                        {
                            "id": "6f5190c7-74e1-4e94-806c-075d9dc0f0f5",
                            "description": "Kip",
                            "subcategories": []
                        }
                    ]
                },
                {
                    "category_id": "71c312ac-37e8-4ae1-976a-5251cdc5841e",
                    "description": "Spaans",
                    "subcategories": []
                }
            ]
        },
        {
            "category_id": "7e221ebb-e2a2-4454-b31d-6466f4e99624",
            "description": "Kroegen",
            "subcategories": []
        }
    ]
}

Adresboek locaties binnen categorie

Alle locaties die onder een specifieke categorie vallen worden getoond. In een antwoord worden ook de categorieën die onder de huidige categorie valt getoond en worden er tag groepen getoond die op de huidige categorie van toepassing is.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/locations/category/<uuid:category_id>

Voorbeeld antwoord:

{
    "id": "edbc4904-722f-4d94-b179-f03ba48a7a78",
    "description": "Restaurants",
    "categories": [
        {
            "id": "ff08a79c-5268-40b6-bfed-c7f644997d00",
            "description": "Amerikaans"
        },
        {
            "id": "71c312ac-37e8-4ae1-976a-5251cdc5841e",
            "description": "Spaans"
        }
    ],
    "tag_groups": {
        "<Naam van tag groep>": [
            {
                "id": "0c6f9f45-271d-46c7-91f3-88f2bceea6ce",
                "description": "Ontbijt"
            },
            {
                "id": "19d04e7f-8b76-44d8-9e9f-79cfc46b1325",
                "description": "IJssalons"
            }
        ]
    },
    "locations": [
        {
            "id": "68cc569e-1580-4c46-881c-bf2e2a2b2468",
            "organisation_name": "Kiptent",
            "address": "Street",
            "house_number": 1,
            "house_number_suffix": "a",
            "zip_code": "1100HH",
            "city": "Rotterdam",
            "country": "Nederland",
            "phone": "",
            "website": "",
            "facebook": "",
            "twitter": "",
            "instagram": "",
            "email": "test@managr.io",
            "note": "", 
            "modified_date": "2019-02-01T00:00:00+01:00", 
            "opening_hours": {
                "holidays": "Gesloten",
                "monday": "gesloten",
                "tuesday": "10.00-17.00",
                "wednesday": "10.00-17.00",
                "thursday": "10.00-17.00",
                "friday": "10.00-19.00",
                "saturday": "10.00-17.00",
                "sunday": "Gesloten"
            },
            "tags": [
                {
                    "id": "73f913ca-620f-40f6-9d2d-71b4cf10272a",
                    "description": "test_tag_1"
                }
            ],
            "longitude": null,
            "latitude": null,
            "categories": [
                {
                    "id": "a94ef5b2-5c56-4244-91d6-495e6454bcab",
                    "description": "test cat 1"
                },
                {
                    "id": "741a4ca6-97a1-4bfb-aa56-58824d50a25e",
                    "description": "test cat 2"
                }
            ],
            "files": [
                {
                    "type": "Text",
                    "name": "example_text.txt",
                    "url": null,
                    "title": "Example text",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/M2QxMGMwYmFhOTJlYWM3MTgxZDgxMjcyNDViZGMyMzYyNjE1ZDMxNWQ3ODM2ZWM5ZDk2MDdjNmYxODg2YTVkN3x0eHR8dGV4dC9wbGFpbg=="
                },
                {
                    "type": "PDF",
                    "name": "example_pdf.pdf",
                    "url": null,
                    "title": "Example PDF",
                    "introduction": "",
                    "file_url": "https://files-dordrecht.managr.io/public/document/YzFmNzA2MTg2Y2IzYzk1Y2E4MzZiODBkZmFjNDE3ZTQ3YmEwMzI4Yzc3YmJlYjg1MDA0YmFlMDU3NDJlOTBmOHxwZGZ8YXBwbGljYXRpb24vcGRm"
                }
            ],
            "stills": [
                {
                    "type": "Image",
                    "name": "example_image.jpg",
                    "url": null,
                    "title": "Example image",
                    "introduction": "",
                    "image_url": "https://files-dordrecht.managr.io/public/free-image/MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw=="
                }
            ],
            "image_url": "https://files-dordrecht.managr.io/public/free-image/MzA5ZGNiNmJmOGVkOWIxZTliM2MzMTVmMzcxYjg3MzBkNGMyODNmMzU4ZmUxZDY2N2Q1OWY1MzY3ZWYxM2M1ZHxqcGd8aW1hZ2UvanBlZw==",
            "is_donator": false
        }
    ]
}

Filteren van locaties binnen een categorie

De “GET request” parameters die gebruikt kunnen worden bij het vinden van locaties zijn hieronder te vinden in de tabel.

Parameter Omschrijving
subcategories[] het filteren op basis van de categorieën van de locaties.
tags[] het filteren op basis tags. Zie hoofdstuk “Locatie tags”.

Voorbeeld op basis van tags.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/locations/category/edbc4904-722f-4d94-b179-f03ba48a7a78?tags[]=0c6f9f45-271d-46c7-91f3-88f2bceea6ce&tags[]=19d04e7f-8b76-44d8-9e9f-79cfc46b1325

Voorbeeld op basis van subcategories.

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

GET /address-book/locations/category/edbc4904-722f-4d94-b179-f03ba48a7a78?subcategories[]=ff08a79c-5268-40b6-bfed-c7f644997d00&subcategories[]=71c312ac-37e8-4ae1-976a-5251cdc5841e

Evenement aanmaken via extern endpoint

Headers:

Api-Key:            (Api sleutel)
Accept-Language:    nl

Adres:

POST /events/create/

Data die meegestuurd moeten worden met een verplichte afbeelding, waarbij event_title en location_name verplicht zijn. Verder is organisation_name verplicht voor een organisatie en er wordt op een unieke combinatie organisation_name en organisation_address opgezicht in de database voor de uniekheid

{
	"event_title": "Event title",
	"location_name": "Location name",
	"event_subtitle": "",
	"event_description": "",
	"event_startdate": "",
	"event_enddate": "",
	"event_location": "",
	"event_origin_url": "",
	"event_ticket_price": "",
	"event_ticket_url": "",
	"event_recurrence_factor_description": "",
	"location_zipcode": "",
	"location_address": "",
	"location_phone_no": "",
	"location_city": "",
	"organisation_name": "",
	"organisation_address": "",
	"organisation_zipcode": "",
	"organisation_city": "",
	"organisation_email": "",
	"organisation_website": ""
}