POST api/krnanrede/v1/publickeyvalue

Stellt eine Liste von Key-Value-Paaren der verfügbaren Anreden basierend auf dem angegebenen Filter bereit.

Request Information

URI Parameters

None.

Body Parameters

Filter-Objekt

KrnAnredeSelect
NameDescriptionTypeAdditional information
Id

integer

None.

NummerFrom

integer

None.

NummerTo

integer

None.

Geschlecht

integer

None.

AnredeText

string

None.

PageSize

integer

Required

PageIndex

integer

Required

SortField

string

None.

SortFieldDefault

string

None.

Quicksearch

string

None.

filterIsSet

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "NummerFrom": 1,
  "NummerTo": 1,
  "Geschlecht": 1,
  "AnredeText": "sample string 1",
  "PageSize": 2,
  "PageIndex": 3,
  "SortField": "sample string 4",
  "SortFieldDefault": "sample string 5",
  "Quicksearch": "sample string 6",
  "filterIsSet": true
}

application/xml, text/xml

Sample:
<KrnAnredeSelect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.IntelliVerband.Krn.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>
  <filterIsSet xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</filterIsSet>
  <AnredeText>sample string 1</AnredeText>
  <Geschlecht>1</Geschlecht>
  <Id>1</Id>
  <NummerFrom>1</NummerFrom>
  <NummerTo>1</NummerTo>
</KrnAnredeSelect>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'KrnAnredeSelect'.

Response Information

Resource Description

Gibt ein ApiResponse zurück, das eine Liste von Key-Value-Paaren enthält.

ApiReponseOfListOfKeyValue
NameDescriptionTypeAdditional information
DataResult

Collection of KeyValue

None.

ValidationResult

ValidationResult

None.

Response Formats

application/json, text/json

Sample:
{
  "DataResult": [
    {
      "Id": 1,
      "Value": "sample string 2"
    },
    {
      "Id": 1,
      "Value": "sample string 2"
    }
  ],
  "ValidationResult": {
    "ErrorMsg": "sample string 1",
    "HintMsg": "sample string 2",
    "ErrorFieldNames": [
      "sample string 1",
      "sample string 2"
    ],
    "FieldName": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<ApiReponseOfArrayOfKeyValueLzOiBYJ4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.IntelliVerband.Common.Models">
  <DataResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:KeyValue>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValue>
    <d2p1:KeyValue>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValue>
  </DataResult>
  <ValidationResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:ErrorFieldNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:ErrorFieldNames>
    <d2p1:ErrorMsg>sample string 1</d2p1:ErrorMsg>
    <d2p1:FieldName>sample string 3</d2p1:FieldName>
    <d2p1:HintMsg>sample string 2</d2p1:HintMsg>
  </ValidationResult>
</ApiReponseOfArrayOfKeyValueLzOiBYJ4>