POST api/dmsdocumenttype/select

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Number	integer	None.
Name	string	None.
Description	string	None.
DocumentLibraryId	integer	None.
DocumentReference	integer	None.
Visibility	integer	None.
Active	integer	None.
PageSize	integer	Required
PageIndex	integer	Required
SortField	string	None.
SortFieldDefault	string	None.
Quicksearch	string	None.
filterIsSet	boolean	None.
resetFilter	boolean	None.
TagIds	Collection of integer	None.
TagFullMatch	boolean	None.
WithTags	boolean	None.
RequestFields	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Number": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "DocumentLibraryId": 1,
  "DocumentReference": 1,
  "Visibility": 1,
  "Active": 1,
  "PageSize": 3,
  "PageIndex": 4,
  "SortField": "sample string 5",
  "SortFieldDefault": "sample string 6",
  "Quicksearch": "sample string 7",
  "filterIsSet": true,
  "resetFilter": true,
  "TagIds": [
    1,
    2
  ],
  "TagFullMatch": true,
  "WithTags": true,
  "RequestFields": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<DmsDocumentTypeSelect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">4</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">3</PageSize>
  <Quicksearch xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 7</Quicksearch>
  <RequestFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RequestFields>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 5</SortField>
  <SortFieldDefault xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 6</SortFieldDefault>
  <TagFullMatch xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</TagFullMatch>
  <TagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TagIds>
  <WithTags xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</WithTags>
  <filterIsSet xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</filterIsSet>
  <resetFilter xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</resetFilter>
  <Active>1</Active>
  <Description>sample string 2</Description>
  <DocumentLibraryId>1</DocumentLibraryId>
  <DocumentReference>1</DocumentReference>
  <Id>1</Id>
  <Name>sample string 1</Name>
  <Number>1</Number>
  <Visibility>1</Visibility>
</DmsDocumentTypeSelect>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DmsDocumentTypeQueryResult

Name	Type	Additional information
Entries	Collection of DmsDocumentTypeDisplay	None.
RecordsTotal	integer	Required
PageSize	integer	Required
PageIndex	integer	Required
SortField	string	None.

Response Formats

application/json, text/json

Sample:

Sample not available.