POST v1/Licensee/CompanyList

Get Companies List

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: 
<CompanyRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CompanyID>1</CompanyID>
  <CompanyCode>sample string 1</CompanyCode>
  <ComapnyName>sample string 2</ComapnyName>
  <ParentCompanyID>1</ParentCompanyID>
  <Active>true</Active>
</CompanyRequest>

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

Resource Description

Collection of CompanyResponse
NameDescriptionTypeAdditional information
ParentLicenseeName

Get parent licensee Name

 string

None.
URL

Get URL licensee

 string

None.
TaxJurisdictionName

Get TaxJurisdictionName licensee

 string

None.
LicenseeAddressLine1

Get LicenseeAddressLine1 licensee

 string

None.
LicenseeAddressLine2

Get LicenseeAddressLine2 licensee

 string

None.
LicenseeAddressLine3

Get LicenseeAddressLine3 licensee

 string

None.
LicenseeAddressCity

Get LicenseeAddressCity licensee

 string

None.
LicenseeAddressState

Get LicenseeAddressState licensee

 string

None.
LicenseeAddressZip

Get LicenseeAddressZip licensee

 string

None.
LicenseeAddressCountry

Get LicenseeAddressCountry licensee

 string

None.
LicenseeEmailAddress

Get LicenseeEmailAddress licensee

 string

None.
LicenseePhone

Get LicenseePhone licensee

 string

None.
LicenseePhoneExtension

Get LicenseePhoneExtension licensee

 string

None.
LicenseeFax

Get LicenseeFax licensee

 string

None.
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.

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:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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>