GET api/Companies

Retrieves a list of companies

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns companies list

Collection of CompanyModel

Name	Description	Type	Additional information
DefaultLicense		MBSLicenseType	None.
AllowedLicenses		Collection of MBSLicenseType	None.
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": "37d5f01a-84bd-4391-89f5-a95393500ab8",
    "Name": "sample string 2",
    "StorageLimit": 1,
    "LicenseSettings": 0,
    "Destinations": [
      {
        "DestinationId": "31e62527-fc3b-49df-8cc5-ace80b43961d",
        "PlanId": 1
      },
      {
        "DestinationId": "31e62527-fc3b-49df-8cc5-ace80b43961d",
        "PlanId": 1
      }
    ],
    "DefaultLicense": 0,
    "AllowedLicenses": [
      0,
      0
    ]
  },
  {
    "Id": "37d5f01a-84bd-4391-89f5-a95393500ab8",
    "Name": "sample string 2",
    "StorageLimit": 1,
    "LicenseSettings": 0,
    "Destinations": [
      {
        "DestinationId": "31e62527-fc3b-49df-8cc5-ace80b43961d",
        "PlanId": 1
      },
      {
        "DestinationId": "31e62527-fc3b-49df-8cc5-ace80b43961d",
        "PlanId": 1
      }
    ],
    "DefaultLicense": 0,
    "AllowedLicenses": [
      0,
      0
    ]
  }
]

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>
    <AllowedLicenses xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSP360.MBS.Common.Types.License.Enums">
      <d3p1:MBSLicenseType>Desktop</d3p1:MBSLicenseType>
      <d3p1:MBSLicenseType>Desktop</d3p1:MBSLicenseType>
    </AllowedLicenses>
    <DefaultLicense>Desktop</DefaultLicense>
    <Destinations>
      <CompanyDestinationModel>
        <DestinationId>31e62527-fc3b-49df-8cc5-ace80b43961d</DestinationId>
        <PlanId>1</PlanId>
      </CompanyDestinationModel>
      <CompanyDestinationModel>
        <DestinationId>31e62527-fc3b-49df-8cc5-ace80b43961d</DestinationId>
        <PlanId>1</PlanId>
      </CompanyDestinationModel>
    </Destinations>
    <LicenseSettings>CustomUsersSettings</LicenseSettings>
    <Name>sample string 2</Name>
    <StorageLimit>1</StorageLimit>
    <Id>37d5f01a-84bd-4391-89f5-a95393500ab8</Id>
  </CompanyModel>
  <CompanyModel>
    <AllowedLicenses xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSP360.MBS.Common.Types.License.Enums">
      <d3p1:MBSLicenseType>Desktop</d3p1:MBSLicenseType>
      <d3p1:MBSLicenseType>Desktop</d3p1:MBSLicenseType>
    </AllowedLicenses>
    <DefaultLicense>Desktop</DefaultLicense>
    <Destinations>
      <CompanyDestinationModel>
        <DestinationId>31e62527-fc3b-49df-8cc5-ace80b43961d</DestinationId>
        <PlanId>1</PlanId>
      </CompanyDestinationModel>
      <CompanyDestinationModel>
        <DestinationId>31e62527-fc3b-49df-8cc5-ace80b43961d</DestinationId>
        <PlanId>1</PlanId>
      </CompanyDestinationModel>
    </Destinations>
    <LicenseSettings>CustomUsersSettings</LicenseSettings>
    <Name>sample string 2</Name>
    <StorageLimit>1</StorageLimit>
    <Id>37d5f01a-84bd-4391-89f5-a95393500ab8</Id>
  </CompanyModel>
</ArrayOfCompanyModel>