POST api/dmsdocumenttype/validate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Reason	integer	Required
Rec	DmsDocumentType	None.
Id	integer	Required
RowGuid	globally unique identifier	Required
Number	integer	Required
Name	string	None.
Description	string	None.
DocumentLibraryId	integer	Required
DocumentReference	integer	Required
ReadVisibility	integer	Required
WriteVisibility	integer	Required
Active	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "Reason": 1,
  "Rec": {
    "Id": 1,
    "RowGuid": "fb748a44-1638-44af-842e-997925a75a5a",
    "Number": 3,
    "Name": "sample string 4",
    "Description": "sample string 5",
    "DocumentLibraryId": 6,
    "DocumentReference": 7,
    "ReadVisibility": 8,
    "WriteVisibility": 9,
    "Active": true
  },
  "Id": 2,
  "RowGuid": "51103cff-cc10-4abb-ad19-2331fd1d1fcf",
  "Number": 4,
  "Name": "sample string 5",
  "Description": "sample string 6",
  "DocumentLibraryId": 7,
  "DocumentReference": 8,
  "ReadVisibility": 9,
  "WriteVisibility": 10,
  "Active": true
}

application/xml, text/xml

Sample:

<DmsDocumentTypeValidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <Active>true</Active>
  <Description>sample string 6</Description>
  <DocumentLibraryId>7</DocumentLibraryId>
  <DocumentReference>8</DocumentReference>
  <Id>2</Id>
  <Name>sample string 5</Name>
  <Number>4</Number>
  <ReadVisibility>9</ReadVisibility>
  <RowGuid>51103cff-cc10-4abb-ad19-2331fd1d1fcf</RowGuid>
  <WriteVisibility>10</WriteVisibility>
  <Reason>1</Reason>
  <Rec>
    <Active>true</Active>
    <Description>sample string 5</Description>
    <DocumentLibraryId>6</DocumentLibraryId>
    <DocumentReference>7</DocumentReference>
    <Id>1</Id>
    <Name>sample string 4</Name>
    <Number>3</Number>
    <ReadVisibility>8</ReadVisibility>
    <RowGuid>fb748a44-1638-44af-842e-997925a75a5a</RowGuid>
    <WriteVisibility>9</WriteVisibility>
  </Rec>
</DmsDocumentTypeValidate>

application/x-www-form-urlencoded

Sample:

Sample not available.

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>