GET api/corporates?IsActive={IsActive}&IsDisplay={IsDisplay}&PageIndex={PageIndex}&PageSize={PageSize}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IsActive

boolean

None.

IsDisplay

boolean

None.

PageIndex

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

PaginationRespModelOfCorporatesOutputModel
NameDescriptionTypeAdditional information
CurrentPage

integer

None.

LastPage

integer

None.

PerPage

integer

None.

Total

integer

None.

From

integer

None.

To

integer

None.

Data

Collection of CorporatesOutputModel

None.

Response Formats

application/json, text/json

Sample:
{
  "CurrentPage": 1,
  "LastPage": 2,
  "PerPage": 3,
  "Total": 4,
  "From": 5,
  "To": 6,
  "Data": [
    {
      "Id": 1,
      "CustomerId": "sample string 2",
      "CorpName": "sample string 3",
      "IsActive": true
    },
    {
      "Id": 1,
      "CustomerId": "sample string 2",
      "CorpName": "sample string 3",
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample:
<PaginationRespModelOfCorporatesOutputModelsdLWh09w xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <CurrentPage>1</CurrentPage>
  <Data>
    <CorporatesOutputModel>
      <CorpName>sample string 3</CorpName>
      <CustomerId>sample string 2</CustomerId>
      <Id>1</Id>
      <IsActive>true</IsActive>
    </CorporatesOutputModel>
    <CorporatesOutputModel>
      <CorpName>sample string 3</CorpName>
      <CustomerId>sample string 2</CustomerId>
      <Id>1</Id>
      <IsActive>true</IsActive>
    </CorporatesOutputModel>
  </Data>
  <From>5</From>
  <LastPage>2</LastPage>
  <PerPage>3</PerPage>
  <To>6</To>
  <Total>4</Total>
</PaginationRespModelOfCorporatesOutputModelsdLWh09w>