GET api/Companies

Get companies list

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns companies list

Collection of CompanyModel
NameDescriptionTypeAdditional information
Id

Company Id

globally unique identifier

None.

Name

Company Name

string

None.

StorageLimit

Company backup limit. A negative value indicates the resource is unconstrained by a quota.

integer

None.

LicenseSettings

Company license settings: 0 - Custom (Users have custom license settings) 1 - Global Pool(Users activate paid licenses from the global pool automatically) 2 - Company Pool(Users can activate only limited number of paid licenses from the company pool)

LicensingMode

None.

Destinations

Collection of CompanyDestinationModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "90820a41-6074-449b-8c39-9042a6218204",
    "Name": "sample string 2",
    "StorageLimit": 1,
    "LicenseSettings": 0,
    "Destinations": [
      {
        "DestinationId": "fba78c6d-16ee-4cd8-bbf0-af097cc353a9"
      },
      {
        "DestinationId": "fba78c6d-16ee-4cd8-bbf0-af097cc353a9"
      }
    ]
  },
  {
    "Id": "90820a41-6074-449b-8c39-9042a6218204",
    "Name": "sample string 2",
    "StorageLimit": 1,
    "LicenseSettings": 0,
    "Destinations": [
      {
        "DestinationId": "fba78c6d-16ee-4cd8-bbf0-af097cc353a9"
      },
      {
        "DestinationId": "fba78c6d-16ee-4cd8-bbf0-af097cc353a9"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCompanyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <CompanyModel>
    <Destinations>
      <CompanyDestinationModel>
        <DestinationId>fba78c6d-16ee-4cd8-bbf0-af097cc353a9</DestinationId>
      </CompanyDestinationModel>
      <CompanyDestinationModel>
        <DestinationId>fba78c6d-16ee-4cd8-bbf0-af097cc353a9</DestinationId>
      </CompanyDestinationModel>
    </Destinations>
    <LicenseSettings>CustomUsersSettings</LicenseSettings>
    <Name>sample string 2</Name>
    <StorageLimit>1</StorageLimit>
    <Id>90820a41-6074-449b-8c39-9042a6218204</Id>
  </CompanyModel>
  <CompanyModel>
    <Destinations>
      <CompanyDestinationModel>
        <DestinationId>fba78c6d-16ee-4cd8-bbf0-af097cc353a9</DestinationId>
      </CompanyDestinationModel>
      <CompanyDestinationModel>
        <DestinationId>fba78c6d-16ee-4cd8-bbf0-af097cc353a9</DestinationId>
      </CompanyDestinationModel>
    </Destinations>
    <LicenseSettings>CustomUsersSettings</LicenseSettings>
    <Name>sample string 2</Name>
    <StorageLimit>1</StorageLimit>
    <Id>90820a41-6074-449b-8c39-9042a6218204</Id>
  </CompanyModel>
</ArrayOfCompanyModel>