POST api/job/job-batches/getpage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
job_id	integer	None.
batch_type	integer	None.
search_term	string	None.
page_number	integer	None.
page_size	integer	None.
sort_column	string	None.
sort_direction	string	None.
include_inactive	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "job_id": 1,
  "batch_type": 1,
  "search_term": "sample string 2",
  "page_number": 3,
  "page_size": 4,
  "sort_column": "sample string 5",
  "sort_direction": "sample string 6",
  "include_inactive": true
}

application/xml, text/xml

Sample:

<JobBatchesGetPageDTOW xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Xceed365EngageApi.core.DTOs.Writable">
  <batch_type>1</batch_type>
  <include_inactive>true</include_inactive>
  <job_id>1</job_id>
  <page_number>3</page_number>
  <page_size>4</page_size>
  <search_term>sample string 2</search_term>
  <sort_column>sample string 5</sort_column>
  <sort_direction>sample string 6</sort_direction>
</JobBatchesGetPageDTOW>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.