POST api/bsterhebung/select

Request Information

URI Parameters

None.

Body Parameters

BstErhebungSelect
NameDescriptionTypeAdditional information
Id

integer

None.

Stichtag

date

None.

StichtagFrom

date

None.

StichtagTo

date

None.

Bezeichnung

string

None.

EingefrorenFrom

date

None.

EingefrorenTo

date

None.

Eingefroren

date

None.

IsEingefroren

boolean

None.

PageSize

integer

Required

PageIndex

integer

Required

SortField

string

None.

SortFieldDefault

string

None.

Quicksearch

string

None.

filterIsSet

boolean

None.

TagIds

Collection of integer

None.

TagFullMatch

boolean

None.

WithTags

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Stichtag": "2025-12-06T06:38:41.9682183+01:00",
  "StichtagFrom": "2025-12-06T06:38:41.9682183+01:00",
  "StichtagTo": "2025-12-06T06:38:41.9682183+01:00",
  "Bezeichnung": "sample string 1",
  "EingefrorenFrom": "2025-12-06T06:38:41.9692164+01:00",
  "EingefrorenTo": "2025-12-06T06:38:41.9692164+01:00",
  "Eingefroren": "2025-12-06T06:38:41.9692164+01:00",
  "IsEingefroren": true,
  "PageSize": 2,
  "PageIndex": 3,
  "SortField": "sample string 4",
  "SortFieldDefault": "sample string 5",
  "Quicksearch": "sample string 6",
  "filterIsSet": true,
  "TagIds": [
    1,
    2
  ],
  "TagFullMatch": true,
  "WithTags": true
}

application/xml, text/xml

Sample:
<BstErhebungSelect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.IntelliVerband.Bst.Models">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">2</PageSize>
  <Quicksearch xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 6</Quicksearch>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 4</SortField>
  <SortFieldDefault xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 5</SortFieldDefault>
  <TagFullMatch xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</TagFullMatch>
  <TagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TagIds>
  <WithTags xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</WithTags>
  <filterIsSet xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</filterIsSet>
  <Bezeichnung>sample string 1</Bezeichnung>
  <Eingefroren>2025-12-06T06:38:41.9692164+01:00</Eingefroren>
  <EingefrorenFrom>2025-12-06T06:38:41.9692164+01:00</EingefrorenFrom>
  <EingefrorenTo>2025-12-06T06:38:41.9692164+01:00</EingefrorenTo>
  <Id>1</Id>
  <IsEingefroren>true</IsEingefroren>
  <Stichtag>2025-12-06T06:38:41.9682183+01:00</Stichtag>
  <StichtagFrom>2025-12-06T06:38:41.9682183+01:00</StichtagFrom>
  <StichtagTo>2025-12-06T06:38:41.9682183+01:00</StichtagTo>
</BstErhebungSelect>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BstErhebungQueryResult
NameDescriptionTypeAdditional information
Entries

Collection of BstErhebungDisplay

None.

RecordsTotal

integer

Required

PageSize

integer

Required

PageIndex

integer

Required

SortField

string

None.

Response Formats

application/json, text/json

Sample:

Sample not available.