Backend Services for our Website

Because nowadays nothing works without a little help from a server...

For more information see the documentation below.

Contact Form

Request Body (application/json)

ContactForm
  • message: String required
  • sender: ContactForm.Sender required
  • subject: String required
ContactForm.Sender
  • email: String required
  • name: String required

News

Query parameters

PaginationQuery<NewsSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: NewsSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
NewsSortAttribute
  • - id
  • - createdAt (created-at)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<NewsEntry>
  • entries: Array<NewsEntry> required
  • total: Int required
Array<NewsEntry>
  • {0...}: NewsEntry required
NewsEntry
  • author: NewsAuthor required
  • content: NewsEntry.Content required
  • createdAt: Date required
  • id: Int required
  • slug: String required
  • tags: Array<NewsTag> required
  • title: String required
  • updatedAt: Date optional
NewsEntry.Content
  • html: String required
NewsAuthor
  • fediverseHandle: String optional
  • fullName: String required
  • username: String required
Array<NewsTag>
  • {0...}: NewsTag required
NewsTag
  • id: Int required
  • name: String required
  • slug: String required

Response Body (application/json)

NewsEntry
  • author: NewsAuthor required
  • content: NewsEntry.Content required
  • createdAt: Date required
  • id: Int required
  • slug: String required
  • tags: Array<NewsTag> required
  • title: String required
  • updatedAt: Date optional
NewsAuthor
  • fediverseHandle: String optional
  • fullName: String required
  • username: String required
NewsEntry.Content
  • html: String required
Array<NewsTag>
  • {0...}: NewsTag required
NewsTag
  • id: Int required
  • name: String required
  • slug: String required

Response Body (application/json)

NewsAuthor
  • fediverseHandle: String optional
  • fullName: String required
  • username: String required

Query parameters

PaginationQuery<NewsSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: NewsSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
NewsSortAttribute
  • - id
  • - createdAt (created-at)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<NewsEntry>
  • entries: Array<NewsEntry> required
  • total: Int required
Array<NewsEntry>
  • {0...}: NewsEntry required
NewsEntry
  • author: NewsAuthor required
  • content: NewsEntry.Content required
  • createdAt: Date required
  • id: Int required
  • slug: String required
  • tags: Array<NewsTag> required
  • title: String required
  • updatedAt: Date optional
NewsEntry.Content
  • html: String required
NewsAuthor
  • fediverseHandle: String optional
  • fullName: String required
  • username: String required
Array<NewsTag>
  • {0...}: NewsTag required
NewsTag
  • id: Int required
  • name: String required
  • slug: String required

Query parameters

PaginationQuery<NewsSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: NewsSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
NewsSortAttribute
  • - id
  • - createdAt (created-at)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<NewsEntry>
  • entries: Array<NewsEntry> required
  • total: Int required
Array<NewsEntry>
  • {0...}: NewsEntry required
NewsEntry
  • author: NewsAuthor required
  • content: NewsEntry.Content required
  • createdAt: Date required
  • id: Int required
  • slug: String required
  • tags: Array<NewsTag> required
  • title: String required
  • updatedAt: Date optional
NewsEntry.Content
  • html: String required
NewsAuthor
  • fediverseHandle: String optional
  • fullName: String required
  • username: String required
Array<NewsTag>
  • {0...}: NewsTag required
NewsTag
  • id: Int required
  • name: String required
  • slug: String required

Query parameters

PaginationQuery<NewsSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: NewsSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
NewsSortAttribute
  • - id
  • - createdAt (created-at)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<NewsEntry>
  • entries: Array<NewsEntry> required
  • total: Int required
Array<NewsEntry>
  • {0...}: NewsEntry required
NewsEntry
  • author: NewsAuthor required
  • content: NewsEntry.Content required
  • createdAt: Date required
  • id: Int required
  • slug: String required
  • tags: Array<NewsTag> required
  • title: String required
  • updatedAt: Date optional
NewsEntry.Content
  • html: String required
NewsAuthor
  • fediverseHandle: String optional
  • fullName: String required
  • username: String required
Array<NewsTag>
  • {0...}: NewsTag required
NewsTag
  • id: Int required
  • name: String required
  • slug: String required

Response Body (application/json)

NewsTag
  • id: Int required
  • name: String required
  • slug: String required

Response Body (application/json)

NewsTag
  • id: Int required
  • name: String required
  • slug: String required

References

Query parameters

PaginationQuery<ReferenceSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: ReferenceSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
ReferenceSortAttribute
  • - id
  • - createdAt (created-at)
  • - featuredPosition (featured-position)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<Reference>
  • entries: Array<Reference> required
  • total: Int required
Array<Reference>
  • {0...}: Reference required
Reference
  • createdAt: Date required
  • customer: ReferenceCustomer optional
  • details: Reference.Details optional
  • featuredDetails: Reference.FeaturedDetails optional
  • id: Int required
  • images: Reference.Images optional
  • kind: Reference.Kind required
  • links: Array<Reference.Link> required
  • name: String required
  • slug: String required
  • summary: String required
  • tags: Array<ReferenceTag> required
  • technologies: Array<ReferenceTechnology> required
  • updatedAt: Date optional
ReferenceCustomer
  • name: String required
Reference.FeaturedDetails
  • image: URL required
  • position: Int required
  • subtitle: String required
  • teaser: String required
Array<ReferenceTechnology>
  • {0...}: ReferenceTechnology required
ReferenceTechnology
  • id: Int required
  • name: String required
Reference.Kind
  • - product
  • - project
Array<ReferenceTag>
  • {0...}: ReferenceTag required
ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required
Array<Reference.Link>
  • {0...}: Reference.Link required
Reference.Link
  • kind: Reference.Link.Kind required
  • url: URL required
Reference.Link.Kind
  • - appStore
  • - website
Reference.Details
  • features: Array<String> required
  • kind: Reference.Details.Kind required
Array<String>
  • {0...}: String required
Reference.Details.Kind
  • - featureList
Reference.Images
  • background: URL optional
  • foreground: URL optional

Response Body (application/json)

Reference
  • createdAt: Date required
  • customer: ReferenceCustomer optional
  • details: Reference.Details optional
  • featuredDetails: Reference.FeaturedDetails optional
  • id: Int required
  • images: Reference.Images optional
  • kind: Reference.Kind required
  • links: Array<Reference.Link> required
  • name: String required
  • slug: String required
  • summary: String required
  • tags: Array<ReferenceTag> required
  • technologies: Array<ReferenceTechnology> required
  • updatedAt: Date optional
Array<Reference.Link>
  • {0...}: Reference.Link required
Reference.Link
  • kind: Reference.Link.Kind required
  • url: URL required
Reference.Link.Kind
  • - appStore
  • - website
Reference.Kind
  • - product
  • - project
Reference.FeaturedDetails
  • image: URL required
  • position: Int required
  • subtitle: String required
  • teaser: String required
Array<ReferenceTag>
  • {0...}: ReferenceTag required
ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required
Reference.Details
  • features: Array<String> required
  • kind: Reference.Details.Kind required
Array<String>
  • {0...}: String required
Reference.Details.Kind
  • - featureList
Reference.Images
  • background: URL optional
  • foreground: URL optional
ReferenceCustomer
  • name: String required
Array<ReferenceTechnology>
  • {0...}: ReferenceTechnology required
ReferenceTechnology
  • id: Int required
  • name: String required

Query parameters

PaginationQuery<ReferenceSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: ReferenceSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
ReferenceSortAttribute
  • - id
  • - createdAt (created-at)
  • - featuredPosition (featured-position)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<Reference>
  • entries: Array<Reference> required
  • total: Int required
Array<Reference>
  • {0...}: Reference required
Reference
  • createdAt: Date required
  • customer: ReferenceCustomer optional
  • details: Reference.Details optional
  • featuredDetails: Reference.FeaturedDetails optional
  • id: Int required
  • images: Reference.Images optional
  • kind: Reference.Kind required
  • links: Array<Reference.Link> required
  • name: String required
  • slug: String required
  • summary: String required
  • tags: Array<ReferenceTag> required
  • technologies: Array<ReferenceTechnology> required
  • updatedAt: Date optional
ReferenceCustomer
  • name: String required
Reference.FeaturedDetails
  • image: URL required
  • position: Int required
  • subtitle: String required
  • teaser: String required
Array<ReferenceTechnology>
  • {0...}: ReferenceTechnology required
ReferenceTechnology
  • id: Int required
  • name: String required
Reference.Kind
  • - product
  • - project
Array<ReferenceTag>
  • {0...}: ReferenceTag required
ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required
Array<Reference.Link>
  • {0...}: Reference.Link required
Reference.Link
  • kind: Reference.Link.Kind required
  • url: URL required
Reference.Link.Kind
  • - appStore
  • - website
Reference.Details
  • features: Array<String> required
  • kind: Reference.Details.Kind required
Array<String>
  • {0...}: String required
Reference.Details.Kind
  • - featureList
Reference.Images
  • background: URL optional
  • foreground: URL optional

Query parameters

PaginationQuery<ReferenceSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: ReferenceSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
ReferenceSortAttribute
  • - id
  • - createdAt (created-at)
  • - featuredPosition (featured-position)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<Reference>
  • entries: Array<Reference> required
  • total: Int required
Array<Reference>
  • {0...}: Reference required
Reference
  • createdAt: Date required
  • customer: ReferenceCustomer optional
  • details: Reference.Details optional
  • featuredDetails: Reference.FeaturedDetails optional
  • id: Int required
  • images: Reference.Images optional
  • kind: Reference.Kind required
  • links: Array<Reference.Link> required
  • name: String required
  • slug: String required
  • summary: String required
  • tags: Array<ReferenceTag> required
  • technologies: Array<ReferenceTechnology> required
  • updatedAt: Date optional
ReferenceCustomer
  • name: String required
Reference.FeaturedDetails
  • image: URL required
  • position: Int required
  • subtitle: String required
  • teaser: String required
Array<ReferenceTechnology>
  • {0...}: ReferenceTechnology required
ReferenceTechnology
  • id: Int required
  • name: String required
Reference.Kind
  • - product
  • - project
Array<ReferenceTag>
  • {0...}: ReferenceTag required
ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required
Array<Reference.Link>
  • {0...}: Reference.Link required
Reference.Link
  • kind: Reference.Link.Kind required
  • url: URL required
Reference.Link.Kind
  • - appStore
  • - website
Reference.Details
  • features: Array<String> required
  • kind: Reference.Details.Kind required
Array<String>
  • {0...}: String required
Reference.Details.Kind
  • - featureList
Reference.Images
  • background: URL optional
  • foreground: URL optional

Query parameters

PaginationQuery<ReferenceSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: ReferenceSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
ReferenceSortAttribute
  • - id
  • - createdAt (created-at)
  • - featuredPosition (featured-position)
  • - updatedAt (updated-at)

Response Body (application/json)

Paginated<Reference>
  • entries: Array<Reference> required
  • total: Int required
Array<Reference>
  • {0...}: Reference required
Reference
  • createdAt: Date required
  • customer: ReferenceCustomer optional
  • details: Reference.Details optional
  • featuredDetails: Reference.FeaturedDetails optional
  • id: Int required
  • images: Reference.Images optional
  • kind: Reference.Kind required
  • links: Array<Reference.Link> required
  • name: String required
  • slug: String required
  • summary: String required
  • tags: Array<ReferenceTag> required
  • technologies: Array<ReferenceTechnology> required
  • updatedAt: Date optional
ReferenceCustomer
  • name: String required
Reference.FeaturedDetails
  • image: URL required
  • position: Int required
  • subtitle: String required
  • teaser: String required
Array<ReferenceTechnology>
  • {0...}: ReferenceTechnology required
ReferenceTechnology
  • id: Int required
  • name: String required
Reference.Kind
  • - product
  • - project
Array<ReferenceTag>
  • {0...}: ReferenceTag required
ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required
Array<Reference.Link>
  • {0...}: Reference.Link required
Reference.Link
  • kind: Reference.Link.Kind required
  • url: URL required
Reference.Link.Kind
  • - appStore
  • - website
Reference.Details
  • features: Array<String> required
  • kind: Reference.Details.Kind required
Array<String>
  • {0...}: String required
Reference.Details.Kind
  • - featureList
Reference.Images
  • background: URL optional
  • foreground: URL optional

Query parameters

PaginationQuery<ReferenceSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending

Response Body (application/json)

Paginated<Reference>
  • entries: Array<Reference> required
  • total: Int required
Array<Reference>
  • {0...}: Reference required
Reference
  • createdAt: Date required
  • customer: ReferenceCustomer optional
  • details: Reference.Details optional
  • featuredDetails: Reference.FeaturedDetails optional
  • id: Int required
  • images: Reference.Images optional
  • kind: Reference.Kind required
  • links: Array<Reference.Link> required
  • name: String required
  • slug: String required
  • summary: String required
  • tags: Array<ReferenceTag> required
  • technologies: Array<ReferenceTechnology> required
  • updatedAt: Date optional
ReferenceCustomer
  • name: String required
Reference.FeaturedDetails
  • image: URL required
  • position: Int required
  • subtitle: String required
  • teaser: String required
Array<ReferenceTechnology>
  • {0...}: ReferenceTechnology required
ReferenceTechnology
  • id: Int required
  • name: String required
Reference.Kind
  • - product
  • - project
Array<ReferenceTag>
  • {0...}: ReferenceTag required
ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required
Array<Reference.Link>
  • {0...}: Reference.Link required
Reference.Link
  • kind: Reference.Link.Kind required
  • url: URL required
Reference.Link.Kind
  • - appStore
  • - website
Reference.Details
  • features: Array<String> required
  • kind: Reference.Details.Kind required
Array<String>
  • {0...}: String required
Reference.Details.Kind
  • - featureList
Reference.Images
  • background: URL optional
  • foreground: URL optional

Response Body (application/json)

ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required

Response Body (application/json)

ReferenceTag
  • id: Int required
  • name: String required
  • slug: String required

Response Body (application/json)

ReferenceTechnology
  • id: Int required
  • name: String required

Status

Response Body (application/json)

Status
  • timestamp: Date required
  • version: String required

Team

Query parameters

PaginationQuery<TeamMemberSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: TeamMemberSortAttribute optional
  • sort-in: SortDirection optional
TeamMemberSortAttribute
  • - id
  • - name
  • - createdAt (created-at)
  • - employedSince (employed-since)
  • - updatedAt (updated-at)
SortDirection
  • - ascending
  • - descending

Response Body (application/json)

Paginated<TeamMember>
  • entries: Array<TeamMember> required
  • total: Int required
Array<TeamMember>
  • {0...}: TeamMember required
TeamMember
  • createdAt: Date required
  • gender: TeamMember.Gender required
  • id: Int required
  • images: TeamMember.Images optional
  • introduction: String required
  • name: String required
  • roles: Array<String> required
  • updatedAt: Date optional
Array<String>
  • {0...}: String required
TeamMember.Gender
  • - female
  • - male
  • - unspecified
TeamMember.Images
  • flipSide: URL optional
  • primary: URL optional

Response Body (application/json)

TeamMember
  • createdAt: Date required
  • gender: TeamMember.Gender required
  • id: Int required
  • images: TeamMember.Images optional
  • introduction: String required
  • name: String required
  • roles: Array<String> required
  • updatedAt: Date optional
TeamMember.Images
  • flipSide: URL optional
  • primary: URL optional
Array<String>
  • {0...}: String required
TeamMember.Gender
  • - female
  • - male
  • - unspecified

Timeline

Query parameters

PaginationQuery<TimelineEventSortAttribute>
  • count: Int optional
  • offset: Int optional
  • sort-by: TimelineEventSortAttribute optional
  • sort-in: SortDirection optional
SortDirection
  • - ascending
  • - descending
TimelineEventSortAttribute
  • - id
  • - pointInTime (point-in-time)

Response Body (application/json)

Paginated<TimelineEvent>
  • entries: Array<TimelineEvent> required
  • total: Int required
Array<TimelineEvent>
  • {0...}: TimelineEvent required
TimelineEvent
  • event: String required
  • id: Int required
  • pointInTime: String required

Response Body (application/json)

TimelineEvent
  • event: String required
  • id: Int required
  • pointInTime: String required

A ser.soft GmbH creation.

© 2022 - All rights reserved.