Social Posts

Media19 EndpointsMedia / Social Posts

GET/api/media/social/status

Includes feature enablement, posting capabilities, profile status, and global profile existence.

Responses

default

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social/status \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social/status"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social/status', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social/status"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social/status")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.getStatus();
if (result.success) {
  print(result.data);
}

GET/api/media/social_post

Query parameters

`headline`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`socialProfile`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseEvent`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBooking`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`newsArticle`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`created`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`visibilityType`string	Requires access right: LOGGED_IN, SCOPE
`id`integer
`deleted`boolean	This property is used to mark an entity as deleted / archived
`moderationStatus`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of MediaSocialPost objectsarray<MediaSocialPost>

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social_post \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social_post', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "url_image": "string",
    "headline": "string",
    "url_source_image": "string",
    "image_token": "string",
    "moderation_status": "string",
    "moderation_reason": "string"
  }
]

POST/api/media/social_post

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Admin creates a social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/social_post \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/media/social_post', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_social_post.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.post(MediaSocialPost.fromJson({
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "headline": "string",
  "url_source_image": "string",
  "moderation_status": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

GET/api/media/social_post/feed/favorites

Query parameters

`headline`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`socialProfile`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseEvent`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBooking`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`newsArticle`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`created`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`visibilityType`string	Requires access right: LOGGED_IN, SCOPE
`id`integer
`deleted`boolean	This property is used to mark an entity as deleted / archived
`moderationStatus`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a feed of favorite-related social postsarray<MediaSocialPost3>

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social_post/feed/favorites \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/feed/favorites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/feed/favorites"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social_post/feed/favorites', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/feed/favorites"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/feed/favorites")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/feed/favorites"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.getFavoritesFeed();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "url_image": "string",
    "headline": "string",
    "url_source_image": "string",
    "image_token": "string",
    "moderation_status": "string",
    "moderation_reason": "string"
  }
]

GET/api/media/social_post/feed/category/{ucatId}

Path parameters

ucatIdrequiredstring

Query parameters

`headline`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`socialProfile`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseEvent`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBooking`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`newsArticle`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`created`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`visibilityType`string	Requires access right: LOGGED_IN, SCOPE
`id`integer
`deleted`boolean	This property is used to mark an entity as deleted / archived
`moderationStatus`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a feed of MediaSocialPost objects by categoryarray<MediaSocialPost3>

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social_post/feed/category/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/feed/category/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/feed/category/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social_post/feed/category/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/feed/category/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/feed/category/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/feed/category/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.getCategoryFeed(42);
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "url_image": "string",
    "headline": "string",
    "url_source_image": "string",
    "image_token": "string",
    "moderation_status": "string",
    "moderation_reason": "string"
  }
]

GET/api/media/social_post/feed/profile/{profileIdentifier}

Path parameters

profileIdentifierrequiredstring

Query parameters

`headline`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`socialProfile`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseEvent`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBooking`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`newsArticle`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`created`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`visibilityType`string	Requires access right: LOGGED_IN, SCOPE
`id`integer
`deleted`boolean	This property is used to mark an entity as deleted / archived
`moderationStatus`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a feed of MediaSocialPost objects by profilearray<MediaSocialPost3>

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/feed/profile/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.getProfileFeed('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "url_image": "string",
    "headline": "string",
    "url_source_image": "string",
    "image_token": "string",
    "moderation_status": "string",
    "moderation_reason": "string"
  }
]

GET/api/media/social_post/link_preview

Query parameters

`url`string	Link of the post; https:// is added when no scheme is given
`baseEvent`string	Id or identifier of a linked event (social admins only)
`newsArticle`string	Id or identifier of a linked news article (social admins only)

Responses

200Link previewobject

Show fields (5)

typestring
Allowed: base_event news_article url
urlstring
url_titlestring
url_imagestring
url_subtitlestring

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social_post/link_preview \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/link_preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/link_preview"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social_post/link_preview', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/link_preview"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/link_preview")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/link_preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.getLinkPreview();
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "type": "base_event",
  "url_image": "string",
  "url_subtitle": "string"
}

GET/api/media/social_post/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single MediaSocialPostMediaSocialPost4

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent28
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 18 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable19
Bookable the post is about.
Show fields (50)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- visibility_typestring
  Type of visibility of the entity.
- arslistarray<AccessRightStorage11>
  Access rights list that controls the visibility.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- … 2 more fields
… 6 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/social_post/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/media/social_post/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

PUT/api/media/social_post/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Admin updates a social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/social_post/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/42"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/media/social_post/42', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/42"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_social_post.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.put(MediaSocialPost.fromJson({
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "headline": "string",
  "url_source_image": "string",
  "moderation_status": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

PATCH/api/media/social_post/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Admin updates a social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/media/social_post/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/42"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/media/social_post/42', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/42"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/media/social_post/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "text": "Text",
      "url": "https://vynst.de",
      "url_title": "Beispiel",
      "headline": "string",
      "url_source_image": "string",
      "moderation_status": "string"
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

DELETE/api/media/social_post/{identifier}

Path parameters

identifierrequiredstring

Responses

default

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/media/social_post/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/media/social_post/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.delete('42');
if (result.success) {
  print(result.data);
}

POST/api/media/social_post/user

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200User creates a social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/social_post/user \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/user"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/media/social_post/user', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/user"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/user")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/user"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_social_post.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.postUser(MediaSocialPost.fromJson({
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "headline": "string",
  "url_source_image": "string",
  "moderation_status": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

POST/api/media/social_post/trainer

Requires the person to be a trainer in at least one of the assigned unified categories (via active PersonLogBookEntry) and those categories must have trainerCanPostSocial enabled. Does NOT require the media_social_user_can_create_post setting.

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Trainer creates a social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/social_post/trainer \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/trainer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/trainer"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/media/social_post/trainer', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/trainer"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/trainer")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/trainer"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_social_post.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.postTrainer(MediaSocialPost.fromJson({
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "headline": "string",
  "url_source_image": "string",
  "moderation_status": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

PUT/api/media/social_post/user/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200User updates their own social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/social_post/user/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/user/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/user/42"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/media/social_post/user/42', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/user/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/user/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/user/42"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_social_post.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.putUser(MediaSocialPost.fromJson({
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "headline": "string",
  "url_source_image": "string",
  "moderation_status": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

PATCH/api/media/social_post/user/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200User updates their own social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/media/social_post/user/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/user/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/user/42"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/media/social_post/user/42', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/user/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/user/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/user/42"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/media/social_post/user/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "text": "Text",
      "url": "https://vynst.de",
      "url_title": "Beispiel",
      "headline": "string",
      "url_source_image": "string",
      "moderation_status": "string"
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

DELETE/api/media/social_post/user/{identifier}

Path parameters

identifierrequiredstring

Responses

default

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/media/social_post/user/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/user/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/user/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/media/social_post/user/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/user/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/user/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/user/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.deleteUser('42');
if (result.success) {
  print(result.data);
}

PUT/api/media/social_post/trainer/{identifier}

Does NOT require the media_social_user_can_edit_own_post setting. Validates ownership and that the person is a trainer in the post's categories.

Path parameters

identifierrequiredstring

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Trainer updates their own social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/social_post/trainer/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/trainer/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/trainer/42"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/media/social_post/trainer/42', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/trainer/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/trainer/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/trainer/42"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_social_post.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.putTrainer(MediaSocialPost.fromJson({
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "headline": "string",
  "url_source_image": "string",
  "moderation_status": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

PATCH/api/media/social_post/trainer/{identifier}

Does NOT require the media_social_user_can_edit_own_post setting. Validates ownership and that the person is a trainer in the post's categories.

Path parameters

identifierrequiredstring

Request body application/json

dataMediaSocialPost2
Show fields (15)
- headlinestring
  Headline of the post.
- textstring
  Text of the post.
- urlstring
  Link in the post.
- url_titlestring
  Title of the link in the post.
- url_source_imagestring
  Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
- moderation_statusstring
  Moderation status, for example pending or approved.
- moderation_reasonstring
  Reason for the moderation decision.
- social_profileMediaSocialProfile16
  Profile that wrote the post.
- attachmentsarray<Attachment12>
  Files attached to the post.
- base_eventBaseEvent26
  Event the post is about.
- base_bookingBaseBooking24
  Booking the post is about.
- base_bookableBaseBookable17
  Bookable the post is about.
- news_articleMediaNewsArticle11
  News article the post is linked to.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Trainer updates their own social postMediaSocialPost

Show fields (19)

url_imagestring
Proxy URL that resolves to this post's image. Returns null until a preview has been extracted and an imageToken is assigned.
idinteger
Primary key of the social post. Internal ID.
headlinestring
Headline of the post.
textstring
Text of the post.
urlstring
Link in the post.
url_titlestring
Title of the link in the post.
url_source_imagestring
Raw origin URL of the preview image. Stored as scope-only; never exposed directly to non-admin callers — use the virtual url_image property instead.
image_tokenstring
Server-assigned, never accepted from API input — omitted from oaInput groups on purpose.
moderation_statusstring
Moderation status, for example pending or approved.
moderation_reasonstring
Reason for the moderation decision.
moderated_manuallyboolean
True once a moderator decided about this entry by hand. Automatic decisions - a trigger match on creation, the batch auto-approve - leave it false, and that is what lets member reports push an entry back into moderation later on.
report_countinteger
Number of distinct members who reported this entry. Moderators only.
moderated_atstring (date-time)
Time the post was moderated.
social_profileMediaSocialProfile10
Profile that wrote the post.
Show fields (11)
- idinteger
  Primary key of the social profile. Internal ID.
- public_namestring
  Name shown publicly.
- profile_picture_urlstring
  URL of the profile picture.
- public_about_mestring
  Text about the person shown publicly.
- global_profileboolean
  The profile is a global profile across installations.
- name_display_typestring
  How the name is shown, for example full name or first name only.
- show_profile_pictureboolean
  The profile picture is shown.
- profile_picture_check_statusstring
  Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper): null = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes Bild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
attachmentsarray<Attachment10>
Files attached to the post.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
base_eventBaseEvent25
Event the post is about.
Show fields (81)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- … 16 more fields
base_bookingBaseBooking13
Booking the post is about.
Show fields (17)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- booking_typestring
  Type of the booking, for example normal or substitution.
- booking_statusstring
  Status of the booking, for example planned, done or cancelled.
- externalboolean
  The booking was made by an external party.
- modified_timeboolean
  The time of the booking was changed after it was created.
- modified_locationboolean
  The location of the booking was changed after it was created.
- modified_bookableboolean
  The bookable of the booking was changed after it was created.
- modified_performing_personboolean
  The leader of the booking was changed after it was created.
- searching_for_performing_personboolean
  A leader for the booking is still being searched for.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
base_bookableBaseBookable16
Bookable the post is about.
Show fields (49)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
… 4 more fields

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/media/social_post/trainer/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      text: 'Text',
      url: 'https://vynst.de',
      url_title: 'Beispiel',
      headline: 'string',
      url_source_image: 'string',
      moderation_status: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/media/social_post/trainer/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/trainer/42"

payload = { "data": {
    "text": "Text",
    "url": "https://vynst.de",
    "url_title": "Beispiel",
    "headline": "string",
    "url_source_image": "string",
    "moderation_status": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/media/social_post/trainer/42', [
  'body' => '{"data":{"text":"Text","url":"https://vynst.de","url_title":"Beispiel","headline":"string","url_source_image":"string","moderation_status":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/trainer/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/trainer/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/trainer/42"

	payload := strings.NewReader("{\"data\":{\"text\":\"Text\",\"url\":\"https://vynst.de\",\"url_title\":\"Beispiel\",\"headline\":\"string\",\"url_source_image\":\"string\",\"moderation_status\":\"string\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/media/social_post/trainer/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "text": "Text",
      "url": "https://vynst.de",
      "url_title": "Beispiel",
      "headline": "string",
      "url_source_image": "string",
      "moderation_status": "string"
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "text": "Text",
  "url": "https://vynst.de",
  "url_title": "Beispiel",
  "url_image": "string",
  "headline": "string",
  "url_source_image": "string",
  "image_token": "string",
  "moderation_status": "string",
  "moderation_reason": "string"
}

DELETE/api/media/social_post/trainer/{identifier}

The counterpart to postTrainer / putTrainer: a trainer who may write and edit must also be able to take a post back, without the media_social_user_can_delete_own_post setting that governs ordinary members.

Path parameters

identifierrequiredstring

Responses

default

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/media/social_post/trainer/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/media/social_post/trainer/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/media/social_post/trainer/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/media/social_post/trainer/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/media/social_post/trainer/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/media/social_post/trainer/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/media/social_post/trainer/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/media_social_post_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaSocialPostController.deleteTrainer('42');
if (result.success) {
  print(result.data);
}