POST api/fdgdokumente/validate

Request Information

URI Parameters

None.

Body Parameters

FdgDokumenteValidate
NameDescriptionTypeAdditional information
Reason

integer

Required

Rec

FdgDokumente

None.

Id

integer

Required

RowGuid

globally unique identifier

Required

AntragId

integer

Required

AntragDetailsSusBauNwId

integer

None.

AntragDetailsSbrpVnId

integer

None.

Position

integer

Required

Bezeichnung

string

None.

Dateiname

string

None.

MimeTyp

string

None.

Inhalt

string

None.

Bemerkung

string

None.

Zusatzfeld1

string

None.

Zusatzfeld2

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Reason": 1,
  "Rec": {
    "Id": 1,
    "RowGuid": "fa0302de-da99-4c75-8edd-7a86bb9eadbb",
    "AntragId": 3,
    "AntragDetailsSusBauNwId": 1,
    "AntragDetailsSbrpVnId": 1,
    "Position": 4,
    "Bezeichnung": "sample string 5",
    "Dateiname": "sample string 6",
    "MimeTyp": "sample string 7",
    "Inhalt": "sample string 8",
    "Bemerkung": "sample string 9",
    "Zusatzfeld1": "sample string 10",
    "Zusatzfeld2": "sample string 11"
  },
  "Id": 2,
  "RowGuid": "1f95141d-07cd-498a-b667-abcc240956ec",
  "AntragId": 4,
  "AntragDetailsSusBauNwId": 1,
  "AntragDetailsSbrpVnId": 1,
  "Position": 5,
  "Bezeichnung": "sample string 6",
  "Dateiname": "sample string 7",
  "MimeTyp": "sample string 8",
  "Inhalt": "sample string 9",
  "Bemerkung": "sample string 10",
  "Zusatzfeld1": "sample string 11",
  "Zusatzfeld2": "sample string 12"
}

application/xml, text/xml

Sample:
<FdgDokumenteValidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.IntelliVerband.Fdg.Models">
  <AntragDetailsSbrpVnId>1</AntragDetailsSbrpVnId>
  <AntragDetailsSusBauNwId>1</AntragDetailsSusBauNwId>
  <AntragId>4</AntragId>
  <Bemerkung>sample string 10</Bemerkung>
  <Bezeichnung>sample string 6</Bezeichnung>
  <Dateiname>sample string 7</Dateiname>
  <Id>2</Id>
  <Inhalt>sample string 9</Inhalt>
  <MimeTyp>sample string 8</MimeTyp>
  <Position>5</Position>
  <RowGuid>1f95141d-07cd-498a-b667-abcc240956ec</RowGuid>
  <Zusatzfeld1>sample string 11</Zusatzfeld1>
  <Zusatzfeld2>sample string 12</Zusatzfeld2>
  <Reason>1</Reason>
  <Rec>
    <AntragDetailsSbrpVnId>1</AntragDetailsSbrpVnId>
    <AntragDetailsSusBauNwId>1</AntragDetailsSusBauNwId>
    <AntragId>3</AntragId>
    <Bemerkung>sample string 9</Bemerkung>
    <Bezeichnung>sample string 5</Bezeichnung>
    <Dateiname>sample string 6</Dateiname>
    <Id>1</Id>
    <Inhalt>sample string 8</Inhalt>
    <MimeTyp>sample string 7</MimeTyp>
    <Position>4</Position>
    <RowGuid>fa0302de-da99-4c75-8edd-7a86bb9eadbb</RowGuid>
    <Zusatzfeld1>sample string 10</Zusatzfeld1>
    <Zusatzfeld2>sample string 11</Zusatzfeld2>
  </Rec>
</FdgDokumenteValidate>

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 'FdgDokumenteValidate'.

Response Information

Resource Description

ValidationResult
NameDescriptionTypeAdditional information
ErrorMsg

string

None.

HintMsg

string

None.

ErrorFieldNames

Collection of string

None.

FieldName

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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