POST v1/Licensee/CompanyList

Get Comapnies List

This is secure method and requires below attributes in header

Authorization: Authorize Token

Request Information

URI Parameters

None.

Body Parameters

Company Filter Parameters

CompanyRequest
NameDescriptionTypeAdditional information
CompanyID

Provide Company ID

integer

None.

CompanyCode

Provide Company Code

string

None.

ComapnyName

Provide Company Name

string

None.

ParentCompanyID

Provide Parent Company ID

integer

None.

Active

Provide Active status

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CompanyID": 1,
  "CompanyCode": "sample string 1",
  "ComapnyName": "sample string 2",
  "ParentCompanyID": 1,
  "Active": true
}

application/xml, text/xml

Sample:
<DJBListInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyID>1</CompanyID>
  <CompanyCode>sample string 1</CompanyCode>
  <ComapnyName>sample string 2</ComapnyName>
  <ParentCompanyID>1</ParentCompanyID>
  <Active>true</Active>
</DJBListInput>

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

Response Information

Response Formats

application/json, text/json

Sample:
[
  {
    "CompanyID": 1,
    "CompanyCode": "sample string 15",
    "ComapnyName": "sample string 16",
    "ParentCompanyID": 1,
    "Active": true,
    "ParentLicenseeName": "sample string 1",
    "URL": "sample string 2",
    "TaxJurisdictionName": "sample string 3",
    "LicenseeAddressLine1": "sample string 4",
    "LicenseeAddressLine2": "sample string 5",
    "LicenseeAddressLine3": "sample string 6",
    "LicenseeAddressCity": "sample string 7",
    "LicenseeAddressState": "sample string 8",
    "LicenseeAddressZip": "sample string 9",
    "LicenseeAddressCountry": "sample string 10",
    "LicenseeEmailAddress": "sample string 11",
    "LicenseePhone": "sample string 12",
    "LicenseePhoneExtension": "sample string 13",
    "LicenseeFax": "sample string 14"
  },
  {
    "CompanyID": 1,
    "CompanyCode": "sample string 15",
    "ComapnyName": "sample string 16",
    "ParentCompanyID": 1,
    "Active": true,
    "ParentLicenseeName": "sample string 1",
    "URL": "sample string 2",
    "TaxJurisdictionName": "sample string 3",
    "LicenseeAddressLine1": "sample string 4",
    "LicenseeAddressLine2": "sample string 5",
    "LicenseeAddressLine3": "sample string 6",
    "LicenseeAddressCity": "sample string 7",
    "LicenseeAddressState": "sample string 8",
    "LicenseeAddressZip": "sample string 9",
    "LicenseeAddressCountry": "sample string 10",
    "LicenseeEmailAddress": "sample string 11",
    "LicenseePhone": "sample string 12",
    "LicenseePhoneExtension": "sample string 13",
    "LicenseeFax": "sample string 14"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyResponse>
    <CompanyID>1</CompanyID>
    <CompanyCode>sample string 15</CompanyCode>
    <ComapnyName>sample string 16</ComapnyName>
    <ParentCompanyID>1</ParentCompanyID>
    <Active>true</Active>
    <ParentLicenseeName>sample string 1</ParentLicenseeName>
    <URL>sample string 2</URL>
    <TaxJurisdictionName>sample string 3</TaxJurisdictionName>
    <LicenseeAddressLine1>sample string 4</LicenseeAddressLine1>
    <LicenseeAddressLine2>sample string 5</LicenseeAddressLine2>
    <LicenseeAddressLine3>sample string 6</LicenseeAddressLine3>
    <LicenseeAddressCity>sample string 7</LicenseeAddressCity>
    <LicenseeAddressState>sample string 8</LicenseeAddressState>
    <LicenseeAddressZip>sample string 9</LicenseeAddressZip>
    <LicenseeAddressCountry>sample string 10</LicenseeAddressCountry>
    <LicenseeEmailAddress>sample string 11</LicenseeEmailAddress>
    <LicenseePhone>sample string 12</LicenseePhone>
    <LicenseePhoneExtension>sample string 13</LicenseePhoneExtension>
    <LicenseeFax>sample string 14</LicenseeFax>
  </CompanyResponse>
  <CompanyResponse>
    <CompanyID>1</CompanyID>
    <CompanyCode>sample string 15</CompanyCode>
    <ComapnyName>sample string 16</ComapnyName>
    <ParentCompanyID>1</ParentCompanyID>
    <Active>true</Active>
    <ParentLicenseeName>sample string 1</ParentLicenseeName>
    <URL>sample string 2</URL>
    <TaxJurisdictionName>sample string 3</TaxJurisdictionName>
    <LicenseeAddressLine1>sample string 4</LicenseeAddressLine1>
    <LicenseeAddressLine2>sample string 5</LicenseeAddressLine2>
    <LicenseeAddressLine3>sample string 6</LicenseeAddressLine3>
    <LicenseeAddressCity>sample string 7</LicenseeAddressCity>
    <LicenseeAddressState>sample string 8</LicenseeAddressState>
    <LicenseeAddressZip>sample string 9</LicenseeAddressZip>
    <LicenseeAddressCountry>sample string 10</LicenseeAddressCountry>
    <LicenseeEmailAddress>sample string 11</LicenseeEmailAddress>
    <LicenseePhone>sample string 12</LicenseePhone>
    <LicenseePhoneExtension>sample string 13</LicenseePhoneExtension>
    <LicenseeFax>sample string 14</LicenseeFax>
  </CompanyResponse>
</ArrayOfCompanyResponse>