DBNS API v2 Dokumentation

Die API ist derzeit ohne Authentifizierung nutzbar.

Die API Base URL lautet /api/v2.

Die folgenden Ressourcen bündeln die Menge der verfügbaren Actions, welche per POST-Request an die API genutzt werden können

RESOURCE

NLS.OfferResource

ACTION

list

RETURN Array NLS.Offer
PARAMS
FILTERS q order page_size page offer_type_id offer_type_key actor_id
FIELDS title short_description description property_list costs requirements curriculum free child_friendly accessible climate_protection event_online event_canceled target_group info_url video_url updated_at offer_type locations media actor
{
  "resource": NLS.OfferResource,
  "action": list
  "fields": {
      "title": true,
        "short_description": true,
        "description": true,
        "property_list": true,
        "costs": true,
        "requirements": true,
        "curriculum": true,
        "free": true,
        "child_friendly": true,
        "accessible": true,
        "climate_protection": true,
        "event_online": true,
        "event_canceled": true,
        "target_group": true,
        "info_url": true,
        "video_url": true,
        "updated_at": true,
        "offer_type": true|{fields}, // set to true for ID or define list of eager loaded fields
        "locations": true|{fields}, // set to true for ID or define list of eager loaded fields
        "media": true|{fields}, // set to true for ID or define list of eager loaded fields
        "actor": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
ACTION

get

RETURN NLS.Offer
PARAMS id
FILTERS
FIELDS title short_description description property_list costs requirements curriculum free child_friendly accessible climate_protection event_online event_canceled target_group info_url video_url updated_at offer_type locations media actor
{
  "resource": NLS.OfferResource,
  "action": get
  "fields": {
      "title": true,
        "short_description": true,
        "description": true,
        "property_list": true,
        "costs": true,
        "requirements": true,
        "curriculum": true,
        "free": true,
        "child_friendly": true,
        "accessible": true,
        "climate_protection": true,
        "event_online": true,
        "event_canceled": true,
        "target_group": true,
        "info_url": true,
        "video_url": true,
        "updated_at": true,
        "offer_type": true|{fields}, // set to true for ID or define list of eager loaded fields
        "locations": true|{fields}, // set to true for ID or define list of eager loaded fields
        "media": true|{fields}, // set to true for ID or define list of eager loaded fields
        "actor": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
RESOURCE

NLS.LocationResource

ACTION

list

RETURN Array NLS.Location
PARAMS
FILTERS q order page_size page
FIELDS title street city zip lat long owner
{
  "resource": NLS.LocationResource,
  "action": list
  "fields": {
      "title": true,
        "street": true,
        "city": true,
        "zip": true,
        "lat": true,
        "long": true,
        "owner": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
ACTION

get

RETURN NLS.Location
PARAMS id
FILTERS
FIELDS title street city zip lat long owner
{
  "resource": NLS.LocationResource,
  "action": get
  "fields": {
      "title": true,
        "street": true,
        "city": true,
        "zip": true,
        "lat": true,
        "long": true,
        "owner": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
RESOURCE

NLS.ActorResource

ACTION

list

RETURN Array NLS.Actor
PARAMS
FILTERS q order page_size page
FIELDS title description slug info_url media locations
{
  "resource": NLS.ActorResource,
  "action": list
  "fields": {
      "title": true,
        "description": true,
        "slug": true,
        "info_url": true,
        "media": true|{fields}, // set to true for ID or define list of eager loaded fields
        "locations": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
ACTION

get

RETURN NLS.Actor
PARAMS id
FILTERS
FIELDS title description slug info_url media locations
{
  "resource": NLS.ActorResource,
  "action": get
  "fields": {
      "title": true,
        "description": true,
        "slug": true,
        "info_url": true,
        "media": true|{fields}, // set to true for ID or define list of eager loaded fields
        "locations": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
RESOURCE

NLS.ModelTypeResource

ACTION

list

RETURN Array NLS.ModelType
PARAMS
FILTERS q order page_size page
FIELDS key display_name description used_attributes
{
  "resource": NLS.ModelTypeResource,
  "action": list
  "fields": {
      "key": true,
        "display_name": true,
        "description": true,
        "used_attributes": true,
    }
}
ACTION

get

RETURN NLS.ModelType
PARAMS id
FILTERS
FIELDS key display_name description used_attributes
{
  "resource": NLS.ModelTypeResource,
  "action": get
  "fields": {
      "key": true,
        "display_name": true,
        "description": true,
        "used_attributes": true,
    }
}
ACTION

save

RETURN NLS.ModelType
PARAMS id
FILTERS
FIELDS key display_name description used_attributes
{
  "resource": NLS.ModelTypeResource,
  "action": save
  "fields": {
      "key": true,
        "display_name": true,
        "description": true,
        "used_attributes": true,
    }
}
RESOURCE

NLS.CategoryResource

ACTION

list

RETURN Array NLS.Category
PARAMS
FILTERS q order page_size page
FIELDS title description sub_categories
{
  "resource": NLS.CategoryResource,
  "action": list
  "fields": {
      "title": true,
        "description": true,
        "sub_categories": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
ACTION

get

RETURN NLS.Category
PARAMS id
FILTERS
FIELDS title description sub_categories
{
  "resource": NLS.CategoryResource,
  "action": get
  "fields": {
      "title": true,
        "description": true,
        "sub_categories": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
RESOURCE

NLS.CategoryTypeResource

ACTION

list

RETURN Array NLS.CategoryType
PARAMS
FILTERS q order page_size page
FIELDS target_type title categories
{
  "resource": NLS.CategoryTypeResource,
  "action": list
  "fields": {
      "target_type": true,
        "title": true,
        "categories": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
ACTION

get

RETURN NLS.CategoryType
PARAMS id
FILTERS
FIELDS target_type title categories
{
  "resource": NLS.CategoryTypeResource,
  "action": get
  "fields": {
      "target_type": true,
        "title": true,
        "categories": true|{fields}, // set to true for ID or define list of eager loaded fields
    }
}
TYPE

NLS.Offer

FIELDS
title of type Afeefa.StringAttribute
short_description of type Afeefa.StringAttribute
description of type Afeefa.StringAttribute
property_list of type Afeefa.StringAttribute
costs of type Afeefa.StringAttribute
requirements of type Afeefa.StringAttribute
curriculum of type Afeefa.StringAttribute
free of type Afeefa.BooleanAttribute
child_friendly of type Afeefa.BooleanAttribute
accessible of type Afeefa.BooleanAttribute
climate_protection of type Afeefa.BooleanAttribute
event_online of type Afeefa.BooleanAttribute
event_canceled of type Afeefa.BooleanAttribute
target_group of type Afeefa.StringAttribute
info_url of type Afeefa.StringAttribute
video_url of type Afeefa.StringAttribute
updated_at of type Afeefa.DateAttribute
offer_type of type Afeefa.Relation of type NLS.ModelType
locations of type Afeefa.Relation of type NLS.Location
media of type Afeefa.Relation of type NLS.MediaUsage
actor of type Afeefa.Relation of type NLS.Actor
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.ModelType

FIELDS
key of type Afeefa.StringAttribute
display_name of type Afeefa.StringAttribute
description of type Afeefa.StringAttribute
used_attributes of type Afeefa.IntAttribute
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.Location

FIELDS
title of type Afeefa.StringAttribute
street of type Afeefa.StringAttribute
city of type Afeefa.StringAttribute
zip of type Afeefa.StringAttribute
lat of type Afeefa.NumberAttribute
long of type Afeefa.NumberAttribute
owner of type Afeefa.Relation of type
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.Actor

FIELDS
title of type Afeefa.StringAttribute
description of type Afeefa.StringAttribute
slug of type Afeefa.StringAttribute
info_url of type Afeefa.StringAttribute
media of type Afeefa.Relation of type NLS.MediaUsage
locations of type Afeefa.Relation of type NLS.Location
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.MediaUsage

FIELDS
label of type Afeefa.StringAttribute
file of type Afeefa.Relation of type NLS.File
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.File

FIELDS
url of type Afeefa.StringAttribute
title of type Afeefa.StringAttribute
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.Category

FIELDS
title of type Afeefa.StringAttribute
description of type Afeefa.StringAttribute
sub_categories of type Afeefa.Relation of type NLS.Category
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none
TYPE

NLS.CategoryType

FIELDS
target_type of type Afeefa.StringAttribute
title of type Afeefa.StringAttribute
categories of type Afeefa.Relation of type NLS.Category
UPDATABLE FIELDS none
REQUIRED FIELDS WHEN CREATING none