getPackagesByName
Gets a package, by name or assembly guid
Requires authentication as user
getPackagesByName
Request
get /Packages/{Name}
Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *Name | path | The name of the package |
||
| AssemblyGuid | query | The guid of the associated assembly |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | PackageInfo | Operation successful. Returning a PackageInfo object. |
|
| 400 | Bad Request. Server cannot process request. |
||
| 401 | Unauthorized. Client needs to authenticate. |
||
| 403 | Forbidden. No permission for the reqested operation. |
||
| 404 | Resource not found or unavailable. |
||
| 500 | Server error. |
Definitions
PackageInfo
| Name | Type | Notes |
|---|---|---|
| id | string | The internal id of this package. |
| name | string | The name. |
| shortDescription | string | The short description. |
| overview | string | The overview. |
| isPremium | boolean | A value indicating whether this instance is premium. |
| adult | boolean | A value indicating whether this instance is adult only content. |
| richDescUrl | string | The rich desc URL. |
| thumbImage | string | The thumb image. |
| previewImage | string | The preview image. |
| type | string | The type. |
| targetFilename | string | The target filename. |
| owner | string | The owner. |
| category | string | The category. |
| tileColor | string | The catalog tile color. |
| featureId | string | The feature id of this package (if premium). |
| price | number (float) | The price for this package (if premium). |
| targetSystem | PackageTargetSystem | Enum PackageType |
| guid | string | The guid of the assembly associated with this package (if a plug-in). This is used to identify the proper item for automatic updates. |
| isRegistered | boolean | Whether or not this package is registered. |
| expDate | string (date-time) | The expiration date for this package. |
| versions | PackageVersionInfo[] | The versions. |
| enableInAppStore | boolean | A value indicating whether [enable in application store]. |
| installs | integer (int32) | The installs. |
PackageTargetSystem
Enum Values
- Server
- MBTheater
- MBClassic
- Other
PackageVersionInfo
| Name | Type | Notes |
|---|---|---|
| name | string | The name. |
| guid | string | The guid. |
| versionStr | string | The version STR. |
| classification | PackageVersionClass | Enum PackageVersionClass |
| description | string | The description. |
| requiredVersionStr | string | The required version STR. |
| sourceUrl | string | The source URL. |
| checksum | string | The source URL. |
| targetFilename | string | The target filename. |
| infoUrl | string | |
| runtimes | string | |
| timestamp | string (date-time) |
PackageVersionClass
Enum Values
- Release
- Beta
- Dev