POST TenderPressReleaseModule/HelpDocument/Get
Request Information
URI Parameters
None.
Body Parameters
IndexModelName | Description | Type | Additional information |
---|---|---|---|
Page | integer |
None. |
|
PageSize | integer |
None. |
|
Search | string |
None. |
|
OrderBy | string |
None. |
|
OrderByAsc | integer |
None. |
|
AdvanceSearchModel | Dictionary of string [key] and Object [value] |
None. |
Request Formats
application/json, text/json
Sample:
{ "Page": 1, "PageSize": 2, "Search": "sample string 3", "OrderBy": "sample string 4", "OrderByAsc": 5, "AdvanceSearchModel": { "sample string 1": {}, "sample string 3": {} } }
application/xml, text/xml
Sample:
<IndexModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMOWebApi.Models.GeneralModel"> <AdvanceSearchModel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringanyType> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value /> </d2p1:KeyValueOfstringanyType> <d2p1:KeyValueOfstringanyType> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value /> </d2p1:KeyValueOfstringanyType> </AdvanceSearchModel> <OrderBy>sample string 4</OrderBy> <OrderByAsc>5</OrderByAsc> <Page>1</Page> <PageSize>2</PageSize> <Search>sample string 3</Search> </IndexModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Page" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PageSize" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Search" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OrderBy" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OrderByAsc" 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AdvanceSearchModel[0].Key" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AdvanceSearchModel[0].Value" System.Object --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AdvanceSearchModel[1].Key" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AdvanceSearchModel[1].Value" System.Object --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
ServiceResponseOfPagedDataOfHelpDocumentViewModelName | Description | Type | Additional information |
---|---|---|---|
IsSuccess | boolean |
None. |
|
Message | string |
None. |
|
StatusCode | integer |
None. |
|
Data | PagedDataOfHelpDocumentViewModel |
None. |
|
Exception | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccess": true, "Message": "sample string 2", "StatusCode": 3, "Data": { "Data": [ { "Id": 1, "TypeName": "sample string 2", "Url": "sample string 3", "BlankDocUrl": "sample string 4", "SSOID": "sample string 5", "ModifiedDate": "2025-04-29T00:04:28.9778001+05:30", "modifiedByName": "sample string 6" }, { "Id": 1, "TypeName": "sample string 2", "Url": "sample string 3", "BlankDocUrl": "sample string 4", "SSOID": "sample string 5", "ModifiedDate": "2025-04-29T00:04:28.9778001+05:30", "modifiedByName": "sample string 6" } ], "NumberOfPages": 1, "CurrentPage": 2, "ColumnNames": [ "sample string 1", "sample string 2" ], "PageSize": 3, "HeaderNames": [ "sample string 1", "sample string 2" ], "TotalRecords": 4, "HelpDocUrl": "sample string 5" }, "Exception": "sample string 4" }
application/xml, text/xml
Sample:
<ServiceResponseOfPagedDataOfHelpDocumentViewModelh1frI0Td6eOsfpQA xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMOWebApi.Services.ServiceHelper"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CMOWebApi.Models.GeneralModel"> <d2p1:ColumnNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:ColumnNames> <d2p1:CurrentPage>2</d2p1:CurrentPage> <d2p1:Data xmlns:d3p1="http://schemas.datacontract.org/2004/07/CMOWebApi.Models.AdminModel.MasterModel"> <d3p1:HelpDocumentViewModel> <d3p1:BlankDocUrl>sample string 4</d3p1:BlankDocUrl> <d3p1:Id>1</d3p1:Id> <d3p1:ModifiedDate>2025-04-29T00:04:28.9778001+05:30</d3p1:ModifiedDate> <d3p1:SSOID>sample string 5</d3p1:SSOID> <d3p1:TypeName>sample string 2</d3p1:TypeName> <d3p1:Url>sample string 3</d3p1:Url> <d3p1:modifiedByName>sample string 6</d3p1:modifiedByName> </d3p1:HelpDocumentViewModel> <d3p1:HelpDocumentViewModel> <d3p1:BlankDocUrl>sample string 4</d3p1:BlankDocUrl> <d3p1:Id>1</d3p1:Id> <d3p1:ModifiedDate>2025-04-29T00:04:28.9778001+05:30</d3p1:ModifiedDate> <d3p1:SSOID>sample string 5</d3p1:SSOID> <d3p1:TypeName>sample string 2</d3p1:TypeName> <d3p1:Url>sample string 3</d3p1:Url> <d3p1:modifiedByName>sample string 6</d3p1:modifiedByName> </d3p1:HelpDocumentViewModel> </d2p1:Data> <d2p1:HeaderNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:HeaderNames> <d2p1:HelpDocUrl>sample string 5</d2p1:HelpDocUrl> <d2p1:NumberOfPages>1</d2p1:NumberOfPages> <d2p1:PageSize>3</d2p1:PageSize> <d2p1:TotalRecords>4</d2p1:TotalRecords> </Data> <Exception>sample string 4</Exception> <IsSuccess>true</IsSuccess> <Message>sample string 2</Message> <StatusCode>3</StatusCode> </ServiceResponseOfPagedDataOfHelpDocumentViewModelh1frI0Td6eOsfpQA>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsSuccess" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Message" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="StatusCode" 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].Id" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].TypeName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].Url" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].BlankDocUrl" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].SSOID" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].ModifiedDate" 2025-04-29T00:04:28.9778001+05:30 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[0].modifiedByName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].Id" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].TypeName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].Url" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].BlankDocUrl" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].SSOID" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].ModifiedDate" 2025-04-29T00:04:28.9778001+05:30 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Data[1].modifiedByName" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.NumberOfPages" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.CurrentPage" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.ColumnNames[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.ColumnNames[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.PageSize" 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.HeaderNames[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.HeaderNames[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.TotalRecords" 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.HelpDocUrl" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Exception" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e--