PersonDurationStatistic

CRM3 EndpointsCRM / PersonDurationStatistic

Find persons matching one or several duration criteria for honors.

GET/api/crm/person_duration_honors

Query parameters

`archived`boolean	Default value: false
`hasLoginUser`boolean
`subscribedNewsletter`boolean
`subscribedMagazine`boolean
`logBookStaff`boolean
`logBookStaff1`boolean
`logBookStaff2`boolean
`logBookMember`boolean
`logBookTrainer`boolean
`logBookTrainer1`boolean
`logBookTrainer2`boolean
`logBookHeadOfDepartment`boolean
`logBookSupervisoryBoard`boolean
`logBookBoardOfDirectors`boolean
`logBookHonoraryMember`boolean
`logBookClubCardOne`boolean
`logBookHealthRecovered`boolean
`logBookHealthVaccinated`boolean
`logBookHealthVaccinatedAddition`string
`logBookGoodConduct`boolean
`logBookFirstAid`boolean
`logBookMeaslesVaccination`boolean
`birthday`string
`formOfSalutation`string
`specialSalutation`string
`language`string
`position`string
`title`string
`gender`string
`numberString`string
`manualNumber`string
`number`string
`firstName`string
`lastName`string
`importOriginId`string
`startTime`string
`endTime`string
`created`string
`bitmaskLogBookContentType`string	This is a bitmask value of the different log book content types
`category`string
`confirmedNoAllergies`string
`knownAllergies`string
`allowPhotos`string
`allowLeavingAlone`string
`authorizedPickup`string
`needsSupport`string
`supportDescription`string
`financialSupport`string
`financialSupportNumber`string
`municipalSupport`string
`municipalSupportNumber`string
`gradeLevel`string
`schoolClass`string
`linkingIdentifier`string
`addressStreet`string
`addressHouseNumber`string
`addressStreetLevel`string
`addressCo`string
`addressCity`string
`addressZip`string
`addressAdminLevel1`string
`addressCountry`string
`addressFullCountry`string
`addressGeoLat`string
`addressGeoLng`string
`addressExternalProviderId`string	field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
`aiChurnRiskScore`string	Kündigungsrisiko 0-100 aus der KI-Bewertung (MemberChurnRiskHelper); nur für das Team.
`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

200Persons eligible for honorsarray<CRMPerson2>

Show fields (81)

idinteger
Primary key of the person. Internal ID.
first_namestring
First name of the person.
last_namestring
Last name of the person.
numberinteger
Member or customer number of the person.
manual_numberinteger
Number set manually instead of the automatic number.
number_stringstring
Member or customer number as text, including prefix.
genderstring
Gender of the person.
titlestring
Academic or other title of the person.
positionstring
Position or role of the person.
languagestring
Preferred language of the person.
special_salutationstring
Special salutation text for letters.
form_of_salutationstring
Form of salutation, for example formal or informal.
birthdaystring (date-time)
Birthday of the person.
known_allergiesstring
Known allergies of the person.
confirmed_no_allergiesboolean
Guardian confirmed that there are no known allergies.
allow_photosboolean
Photos of the person may be taken and published.
allow_leaving_aloneboolean
The person may leave the event alone.
authorized_pickupstring
Persons who are allowed to pick up the person.
needs_supportboolean
The person needs support, for example for inclusion.
support_descriptionstring
Description of the support the person needs.
financial_supportboolean
The person receives financial support.
financial_support_numberstring
Number of the financial support.
municipal_supportboolean
The person receives municipal support.
municipal_support_numberstring
Number of the municipal support.
grade_levelinteger
School grade level of the person.
school_classstring
School class of the person.
start_timestring (date-time)
Start of the membership or activity.
start_time_reasonstring
Reason for the start.
end_timestring (date-time)
End of the membership or activity.
end_time_reasonstring
Reason for the end.
ai_churn_risk_scoreinteger
Kündigungsrisiko 0-100 aus der KI-Bewertung (MemberChurnRiskHelper); nur für das Team.
confirmed_gtc_timestring (date-time)
Time the general terms and conditions were confirmed.
chatbot_opt_inboolean
Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)
Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstring
Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outboolean
Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
companiesarray<CRMCompany>
Companies the person belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- 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.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
crm_person_contact_dataarray<CRMPersonContactData>
Contact data of the person, for example phone and e-mail.
Show fields (6)
- idinteger
  Primary key of the contact data entry. Internal ID.
- namestring
  Name of the contact data entry.
- valuestring
  Value of the contact data entry, e.g. a phone number or e-mail address.
- generated_valuestring
  Value generated from the entered value.
- contact_data_typeContactDataType
  Type of the contact data.
- search_stringstring
  Text that the entity can be searched by.
archivedboolean
Whether the person is archived.
subscribed_newsletterboolean
Whether the person subscribed to the newsletter.
subscribed_magazineboolean
Whether the person subscribed to the magazine.
printed_member_cardboolean
Whether a member card has been printed for the person.
has_login_userboolean
Whether the person has a login user.
profile_picture_urlstring
URL of the profile picture of the person.
log_book_staffboolean
Log book flag: staff.
log_book_staff1boolean
Log book flag: staff, level 1.
log_book_staff2boolean
Log book flag: staff, level 2.
log_book_memberboolean
Log book flag: member.
log_book_trainerboolean
Log book flag: trainer.
log_book_trainer1boolean
Log book flag: trainer, level 1.
log_book_trainer2boolean
Log book flag: trainer, level 2.
log_book_head_of_departmentboolean
Log book flag: head of department.
log_book_supervisory_boardboolean
Log book flag: supervisory board.
log_book_board_of_directorsboolean
Log book flag: board of directors.
log_book_honorary_memberboolean
Log book flag: honorary member.
log_book_club_card_oneboolean
Log book flag: club card.
log_book_health_recoveredboolean
Log book flag: recovered from illness.
log_book_health_vaccinatedboolean
Log book flag: vaccinated.
log_book_health_vaccinated_additionstring
Details of the vaccination.
log_book_good_conductboolean
Log book flag: certificate of good conduct.
log_book_first_aidboolean
Log book flag: first aid training.
log_book_measles_vaccinationboolean
Log book flag: measles vaccination.
sync_lanistaboolean
Whether the person is synchronized with Lanista.
categoryCRMPersonCategory
Person category.
Show fields (12)
- idinteger
  Primary key of the person category. Internal ID.
- namestring
  Name of the person category.
- name_pluralstring
  Plural name of the person category.
- descriptionstring
  Description of the person category.
- deletedboolean
  The category is deleted.
- is_publicboolean
  The category is shown publicly.
- enabled_customer_create_newboolean
  Persons of this category may create new persons in the customer app.
- customer_register_min_numberinteger
  Minimum number of persons that can be registered together.
- customer_add_ignore_invite_codeboolean
  Persons can be added without an invite code.
- customer_ui_allowed_ticket_typesstring
  Ticket types that customers may create in the customer app.
- enabled_customer_ui_selectionboolean
  Customers may select the category in the customer app.
- orderinteger
  Position of the entity in the order.
nicknamestring
Nickname of the person.
preferred_color_hexstring
Preferred color of the person as hex value.
avatar_tokenstring
Token of the avatar image.
search_stringstring
Text that the entity can be searched by.
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.
… 4 more fields

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/person_duration_honors', 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/crm/person_duration_honors"

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/crm/person_duration_honors', [
  '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/crm/person_duration_honors"),
  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/crm/person_duration_honors")
  .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/crm/person_duration_honors"

	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 package:http (no controller in the iw_erp_api package)

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

final response = await http.get(
  Uri.parse('https://your-instance.iw-erp.de/api/crm/person_duration_honors'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

[
  {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
]

Get a single CRMPersonDurationStatistic by ID

GET/api/crm/crmpersondurationstatistics/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single CRMPersonDurationStatisticCRMPersonDurationStatistic

Show fields (21)

contentTypeLabelstring
personIdinteger
totalYearsinteger
Get total duration in full years
totalRemainingMonthsinteger
Get remaining months after full years
currentContinuousYearsinteger
Get current continuous duration in full years
currentContinuousRemainingMonthsinteger
Get remaining months of current continuous period after full years
isCurrentlyActiveboolean
Check whether the current date lies within the latest continuous period
totalFormattedstring
Get formatted total duration string
currentContinuousFormattedstring
Get formatted current continuous duration string
idinteger
Primary key of the duration statistic. Internal ID.
personCRMPerson10
Person the statistic belongs to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- 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
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
content_typestring
Logbook content type or CONTENT_TYPE_VOLUNTEER for the configured combined activity
unified_categoryUnifiedCategory15
Optional unified category. NULL means aggregated across all categories for this content type.
Show fields (32)
- idinteger
  Primary key of the unified category. Internal ID.
- category_typestring
  Type of the category, for example course or membership.
- childrenarray<UnifiedCategory15>
  Child categories.
- parentUnifiedCategory15
  Parent category.
- view_orderinteger
  Sort order of the category in lists.
- is_publicboolean
  The category is shown publicly.
- 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.
- 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.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- search_stringstring
  Text that the entity can be searched by.
- short_identifierstring
  Short identifier of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- image_urlstring
  URL of the image of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
total_monthsinteger
Total months accumulated for this content type (across all periods, excluding gaps)
current_continuous_monthsinteger
Current continuous months without a gap longer than RESET_GAP_MONTHS
first_startstring (date-time)
The very first start date ever recorded for this content type
current_startstring (date-time)
The start date of the current continuous period
current_endstring (date-time)
The latest period end (NULL means open-ended; a future end can still be active)
last_calculatedstring (date-time)
When the statistics were last calculated
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/crm/crmpersondurationstatistics/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/crm/crmpersondurationstatistics/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/crm/crmpersondurationstatistics/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/crm/crmpersondurationstatistics/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/crm/crmpersondurationstatistics/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/crm/crmpersondurationstatistics/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/crm/crmpersondurationstatistics/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/crm_person_duration_statistic_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 CrmPersonDurationStatisticController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "contentTypeLabel": "string",
  "personId": 42,
  "totalYears": 1,
  "totalRemainingMonths": 1,
  "currentContinuousYears": 1,
  "currentContinuousRemainingMonths": 1,
  "isCurrentlyActive": true,
  "totalFormatted": "string",
  "currentContinuousFormatted": "string"
}

Returns a list of CRMPersonDurationStatistic

GET/api/crm/crmpersondurationstatistics

Query parameters

`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 CRMPersonDurationStatisticarray<CRMPersonDurationStatistic>

Show fields (21)

contentTypeLabelstring
personIdinteger
totalYearsinteger
Get total duration in full years
totalRemainingMonthsinteger
Get remaining months after full years
currentContinuousYearsinteger
Get current continuous duration in full years
currentContinuousRemainingMonthsinteger
Get remaining months of current continuous period after full years
isCurrentlyActiveboolean
Check whether the current date lies within the latest continuous period
totalFormattedstring
Get formatted total duration string
currentContinuousFormattedstring
Get formatted current continuous duration string
idinteger
Primary key of the duration statistic. Internal ID.
personCRMPerson10
Person the statistic belongs to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- 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
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
content_typestring
Logbook content type or CONTENT_TYPE_VOLUNTEER for the configured combined activity
unified_categoryUnifiedCategory15
Optional unified category. NULL means aggregated across all categories for this content type.
Show fields (32)
- idinteger
  Primary key of the unified category. Internal ID.
- category_typestring
  Type of the category, for example course or membership.
- childrenarray<UnifiedCategory15>
  Child categories.
- parentUnifiedCategory15
  Parent category.
- view_orderinteger
  Sort order of the category in lists.
- is_publicboolean
  The category is shown publicly.
- 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.
- 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.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- search_stringstring
  Text that the entity can be searched by.
- short_identifierstring
  Short identifier of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- image_urlstring
  URL of the image of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
total_monthsinteger
Total months accumulated for this content type (across all periods, excluding gaps)
current_continuous_monthsinteger
Current continuous months without a gap longer than RESET_GAP_MONTHS
first_startstring (date-time)
The very first start date ever recorded for this content type
current_startstring (date-time)
The start date of the current continuous period
current_endstring (date-time)
The latest period end (NULL means open-ended; a future end can still be active)
last_calculatedstring (date-time)
When the statistics were last calculated
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/crmpersondurationstatistics', 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/crm/crmpersondurationstatistics"

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/crm/crmpersondurationstatistics', [
  '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/crm/crmpersondurationstatistics"),
  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/crm/crmpersondurationstatistics")
  .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/crm/crmpersondurationstatistics"

	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/crm_person_duration_statistic_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 CrmPersonDurationStatisticController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "contentTypeLabel": "string",
    "personId": 42,
    "totalYears": 1,
    "totalRemainingMonths": 1,
    "currentContinuousYears": 1,
    "currentContinuousRemainingMonths": 1,
    "isCurrentlyActive": true,
    "totalFormatted": "string",
    "currentContinuousFormatted": "string"
  }
]