POST v1/Lookups/BusinessTypes

Gets a list of Business Types used for Commercial Customers, such as LLC or Incorporation.

Request Information

URI Parameters

None.

Body Parameters

Page options

Name	Description	Type	Additional information
PageNumber	The 1-based page number to retrieve	integer	None.
PageSize	The number of items per page	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PageNumber": 1,
  "PageSize": 2
}

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

application/xml, text/xml

Sample:

<BusinessTypePageOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
</BusinessTypePageOptions>

Response Information

Resource Description

List of Business Types

PageOfOfBusinessTypeDTO

Name	Type	Additional information
Data	Collection of BusinessTypeDTO	None.
PageNumber	integer	None.
PagesTotal	integer	None.
TotalItems	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
DisplayMessage	string	None.
Links	Collection of PageLink	None.
Href	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "BusinessTypeID": 1,
      "BusinessType": "sample string 2"
    },
    {
      "BusinessTypeID": 1,
      "BusinessType": "sample string 2"
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:

<PageOfBusinessTypeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
    <d2p1:BusinessTypeDTO>
      <d2p1:BusinessType>sample string 2</d2p1:BusinessType>
      <d2p1:BusinessTypeID>1</d2p1:BusinessTypeID>
    </d2p1:BusinessTypeDTO>
    <d2p1:BusinessTypeDTO>
      <d2p1:BusinessType>sample string 2</d2p1:BusinessType>
      <d2p1:BusinessTypeID>1</d2p1:BusinessTypeID>
    </d2p1:BusinessTypeDTO>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfBusinessTypeDTO>