POST api/appdashboardwidget/validate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Reason	integer	Required
Rec	AppDashboardWidget	None.
Id	integer	Required
RowGuid	globally unique identifier	Required
Active	integer	Required
Title	string	None.
WidgetType	integer	Required
ContentHeaderTitle	string	None.
ContentHeaderSubtitle	string	None.
ContentHeaderIcon	string	None.
ContentData	string	None.
Width	integer	None.
Height	integer	None.
PositionX	integer	None.
PositionY	integer	None.
MinWidth	integer	None.
MaxWidth	integer	None.
MinHeight	integer	None.
MaxHeight	integer	None.
IsCustom	integer	Required
LockedHeaderData	integer	Required
LockedConfig	integer	Required
LockedRestrictions	integer	Required
LockedPosition	integer	Required
LockedSize	integer	Required
LockedActive	integer	Required
Zusatzfeld1	string	None.
Zusatzfeld2	string	None.
Bemerkung	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Reason": 1,
  "Rec": {
    "Id": 1,
    "RowGuid": "52ac60eb-30c1-4279-9bec-f48707b7a574",
    "Active": 3,
    "Title": "sample string 4",
    "WidgetType": 5,
    "ContentHeaderTitle": "sample string 6",
    "ContentHeaderSubtitle": "sample string 7",
    "ContentHeaderIcon": "sample string 8",
    "ContentData": "sample string 9",
    "Width": 1,
    "Height": 1,
    "PositionX": 1,
    "PositionY": 1,
    "MinWidth": 1,
    "MaxWidth": 1,
    "MinHeight": 1,
    "MaxHeight": 1,
    "IsCustom": 10,
    "LockedHeaderData": 11,
    "LockedConfig": 12,
    "LockedRestrictions": 13,
    "LockedPosition": 14,
    "LockedSize": 15,
    "LockedActive": 16,
    "Zusatzfeld1": "sample string 17",
    "Zusatzfeld2": "sample string 18",
    "Bemerkung": "sample string 19"
  },
  "Id": 2,
  "RowGuid": "072082b8-0b69-45dd-a6a3-393c1f17bf89",
  "Active": 4,
  "Title": "sample string 5",
  "WidgetType": 6,
  "ContentHeaderTitle": "sample string 7",
  "ContentHeaderSubtitle": "sample string 8",
  "ContentHeaderIcon": "sample string 9",
  "ContentData": "sample string 10",
  "Width": 1,
  "Height": 1,
  "PositionX": 1,
  "PositionY": 1,
  "MinWidth": 1,
  "MaxWidth": 1,
  "MinHeight": 1,
  "MaxHeight": 1,
  "IsCustom": 11,
  "LockedHeaderData": 12,
  "LockedConfig": 13,
  "LockedRestrictions": 14,
  "LockedPosition": 15,
  "LockedSize": 16,
  "LockedActive": 17,
  "Zusatzfeld1": "sample string 18",
  "Zusatzfeld2": "sample string 19",
  "Bemerkung": "sample string 20"
}

application/xml, text/xml

Sample:

<AppDashboardWidgetValidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <Active>4</Active>
  <Bemerkung>sample string 20</Bemerkung>
  <ContentData>sample string 10</ContentData>
  <ContentHeaderIcon>sample string 9</ContentHeaderIcon>
  <ContentHeaderSubtitle>sample string 8</ContentHeaderSubtitle>
  <ContentHeaderTitle>sample string 7</ContentHeaderTitle>
  <Height>1</Height>
  <Id>2</Id>
  <IsCustom>11</IsCustom>
  <LockedActive>17</LockedActive>
  <LockedConfig>13</LockedConfig>
  <LockedHeaderData>12</LockedHeaderData>
  <LockedPosition>15</LockedPosition>
  <LockedRestrictions>14</LockedRestrictions>
  <LockedSize>16</LockedSize>
  <MaxHeight>1</MaxHeight>
  <MaxWidth>1</MaxWidth>
  <MinHeight>1</MinHeight>
  <MinWidth>1</MinWidth>
  <PositionX>1</PositionX>
  <PositionY>1</PositionY>
  <RowGuid>072082b8-0b69-45dd-a6a3-393c1f17bf89</RowGuid>
  <Title>sample string 5</Title>
  <WidgetType>6</WidgetType>
  <Width>1</Width>
  <Zusatzfeld1>sample string 18</Zusatzfeld1>
  <Zusatzfeld2>sample string 19</Zusatzfeld2>
  <Reason>1</Reason>
  <Rec>
    <Active>3</Active>
    <Bemerkung>sample string 19</Bemerkung>
    <ContentData>sample string 9</ContentData>
    <ContentHeaderIcon>sample string 8</ContentHeaderIcon>
    <ContentHeaderSubtitle>sample string 7</ContentHeaderSubtitle>
    <ContentHeaderTitle>sample string 6</ContentHeaderTitle>
    <Height>1</Height>
    <Id>1</Id>
    <IsCustom>10</IsCustom>
    <LockedActive>16</LockedActive>
    <LockedConfig>12</LockedConfig>
    <LockedHeaderData>11</LockedHeaderData>
    <LockedPosition>14</LockedPosition>
    <LockedRestrictions>13</LockedRestrictions>
    <LockedSize>15</LockedSize>
    <MaxHeight>1</MaxHeight>
    <MaxWidth>1</MaxWidth>
    <MinHeight>1</MinHeight>
    <MinWidth>1</MinWidth>
    <PositionX>1</PositionX>
    <PositionY>1</PositionY>
    <RowGuid>52ac60eb-30c1-4279-9bec-f48707b7a574</RowGuid>
    <Title>sample string 4</Title>
    <WidgetType>5</WidgetType>
    <Width>1</Width>
    <Zusatzfeld1>sample string 17</Zusatzfeld1>
    <Zusatzfeld2>sample string 18</Zusatzfeld2>
  </Rec>
</AppDashboardWidgetValidate>

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

Response Information

Resource Description

ValidationResult

Name	Type	Additional 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>