GET api/FormFiles/search?page={page}&itemsPerPage={itemsPerPage}
Returns a list of form files.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
page |
Page number requested (search results are paginated). |
integer |
Default value is 1 |
itemsPerPage |
Items to return on each page. See page parameter above. |
integer |
Default value is 10 |
Body Parameters
None.
Response Information
Resource Description
ListModelOfFormFileModelName | Description | Type | Additional information |
---|---|---|---|
TotalItems | integer |
None. |
|
ItemsPerPage | integer |
None. |
|
CurrentPage | integer |
None. |
|
TotalPages | integer |
None. |
|
FirstRowOnPage | integer |
None. |
|
LastRowOnPage | integer |
None. |
|
Rows | Collection of FormFileModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalItems": 1, "ItemsPerPage": 2, "CurrentPage": 3, "TotalPages": 4, "FirstRowOnPage": 5, "LastRowOnPage": 6, "Rows": [ { "Id": 1, "Name": "sample string 2", "FileName": "sample string 3", "UploadedDate": "sample string 4", "Active": true, "FormFileSignatureRequired": true }, { "Id": 1, "Name": "sample string 2", "FileName": "sample string 3", "UploadedDate": "sample string 4", "Active": true, "FormFileSignatureRequired": true } ] }
application/xml, text/xml
Sample:
<ListModelOfFormFileModelgLb3EXPR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models"> <CurrentPage>3</CurrentPage> <FirstRowOnPage>5</FirstRowOnPage> <ItemsPerPage>2</ItemsPerPage> <LastRowOnPage>6</LastRowOnPage> <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.FormFiles"> <d2p1:FormFileModel> <d2p1:Active>true</d2p1:Active> <d2p1:FileName>sample string 3</d2p1:FileName> <d2p1:FormFileSignatureRequired>true</d2p1:FormFileSignatureRequired> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:UploadedDate>sample string 4</d2p1:UploadedDate> </d2p1:FormFileModel> <d2p1:FormFileModel> <d2p1:Active>true</d2p1:Active> <d2p1:FileName>sample string 3</d2p1:FileName> <d2p1:FormFileSignatureRequired>true</d2p1:FormFileSignatureRequired> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:UploadedDate>sample string 4</d2p1:UploadedDate> </d2p1:FormFileModel> </Rows> <TotalItems>1</TotalItems> <TotalPages>4</TotalPages> </ListModelOfFormFileModelgLb3EXPR>