POST api/dmsdocumentmetadata/validate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Reason	integer	Required
Rec	DmsDocumentMetadata	None.
Id	integer	Required
RowGuid	globally unique identifier	Required
DocumentLibraryId	integer	Required
Name	string	None.
DataType	integer	Required
DefaultValue	string	None.
InternalFieldName	string	None.
ExternalFieldName	string	None.
FilterMode	integer	Required
AccessMode	integer	Required
Mandatory	boolean	Required
Searchable	boolean	Required
Active	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "Reason": 1,
  "Rec": {
    "Id": 1,
    "RowGuid": "ed672495-f3d6-4d61-9eb8-a85a76a4ce0c",
    "DocumentLibraryId": 3,
    "Name": "sample string 4",
    "DataType": 5,
    "DefaultValue": "sample string 6",
    "InternalFieldName": "sample string 7",
    "ExternalFieldName": "sample string 8",
    "FilterMode": 9,
    "AccessMode": 10,
    "Mandatory": true,
    "Searchable": true,
    "Active": true
  },
  "Id": 2,
  "RowGuid": "74572254-2919-46ef-8b57-493723596ad4",
  "DocumentLibraryId": 4,
  "Name": "sample string 5",
  "DataType": 6,
  "DefaultValue": "sample string 7",
  "InternalFieldName": "sample string 8",
  "ExternalFieldName": "sample string 9",
  "FilterMode": 10,
  "AccessMode": 11,
  "Mandatory": true,
  "Searchable": true,
  "Active": true
}

application/xml, text/xml

Sample:

<DmsDocumentMetadataValidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <AccessMode>11</AccessMode>
  <Active>true</Active>
  <DataType>6</DataType>
  <DefaultValue>sample string 7</DefaultValue>
  <DocumentLibraryId>4</DocumentLibraryId>
  <ExternalFieldName>sample string 9</ExternalFieldName>
  <FilterMode>10</FilterMode>
  <Id>2</Id>
  <InternalFieldName>sample string 8</InternalFieldName>
  <Mandatory>true</Mandatory>
  <Name>sample string 5</Name>
  <RowGuid>74572254-2919-46ef-8b57-493723596ad4</RowGuid>
  <Searchable>true</Searchable>
  <Reason>1</Reason>
  <Rec>
    <AccessMode>10</AccessMode>
    <Active>true</Active>
    <DataType>5</DataType>
    <DefaultValue>sample string 6</DefaultValue>
    <DocumentLibraryId>3</DocumentLibraryId>
    <ExternalFieldName>sample string 8</ExternalFieldName>
    <FilterMode>9</FilterMode>
    <Id>1</Id>
    <InternalFieldName>sample string 7</InternalFieldName>
    <Mandatory>true</Mandatory>
    <Name>sample string 4</Name>
    <RowGuid>ed672495-f3d6-4d61-9eb8-a85a76a4ce0c</RowGuid>
    <Searchable>true</Searchable>
  </Rec>
</DmsDocumentMetadataValidate>

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

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>