GET api/Companies/{id}
Retrieves a company by the specified company ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Company ID |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns found provider company
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": "40ccdd23-f381-4339-9ab8-df3d446eb704",
"Name": "sample string 2",
"StorageLimit": 1,
"LicenseSettings": 0,
"Destinations": [
{
"DestinationId": "e2c426f4-d192-46b0-a18d-001a1c7eb9d5",
"PlanId": 1
},
{
"DestinationId": "e2c426f4-d192-46b0-a18d-001a1c7eb9d5",
"PlanId": 1
}
],
"DefaultLicense": 0,
"AllowedLicenses": [
0,
0
]
}
application/xml, text/xml
Sample:
<CompanyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
<AllowedLicenses xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSP360.MBS.Common.Types.License.Enums">
<d2p1:MBSLicenseType>Desktop</d2p1:MBSLicenseType>
<d2p1:MBSLicenseType>Desktop</d2p1:MBSLicenseType>
</AllowedLicenses>
<DefaultLicense>Desktop</DefaultLicense>
<Destinations>
<CompanyDestinationModel>
<DestinationId>e2c426f4-d192-46b0-a18d-001a1c7eb9d5</DestinationId>
<PlanId>1</PlanId>
</CompanyDestinationModel>
<CompanyDestinationModel>
<DestinationId>e2c426f4-d192-46b0-a18d-001a1c7eb9d5</DestinationId>
<PlanId>1</PlanId>
</CompanyDestinationModel>
</Destinations>
<LicenseSettings>CustomUsersSettings</LicenseSettings>
<Name>sample string 2</Name>
<StorageLimit>1</StorageLimit>
<Id>40ccdd23-f381-4339-9ab8-df3d446eb704</Id>
</CompanyModel>