API: Plan Types
Plan Types are used to categorize Plans.
Attributes
All of the attribute fields are returned from GET (read) operations. Only those attributes not marked as read only may be set via POST (create) or PUT (update) operations.
| Name | Type | Notes |
|---|---|---|
| PlanTypeId | Integer | Read Only |
| Name | String 100 | Read Only |
| IsInactive | Boolean | Read Only |
List (GET)
Returns an array of Plan Types in descending order.
URL
https://cleverfoxbackup.com/api/plantypes
Optional Parameters
- PageNo: the page number to return, defaults to 1.
- PageSize: the maximum number of records per page, defaults to 25.
Response Codes
- 200 OK
{
"data": [
{
"PlanTypeId": 1,
"Name": "CleverFox Backup",
"IsInactive": false
}
],
"page_no": 1,
"page_size": 25
}
Read (GET)
Returns a single Plan Type.
URL
https://cleverfoxbackup.com/api/plantypes/{PlanTypeId}
Required Parameters
- PlanTypeId
Response Codes
- 200 OK
- 404 Not Found
{
"data": {
"PlanTypeId": 1,
"Name": "CleverFox Backup",
"IsInactive": false
}
}
Create (POST)
This action is not supported. If called it will return a 405 Method Not Allowed.
Update (PUT)
This action is not supported. If called it will return a 405 Method Not Allowed.
Delete (DELETE)
This action is not supported. If called it will return a 405 Method Not Allowed.