Quick Start Guide

API Basics

API Resources

API: Partners

Partners contains basic information about your Partner account.


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
PartnerId Integer Read Only
PlanTypeId Integer Required on POST, otherwise Read Only
PlanType Object See API Plan Types
Name String 100 Required
ApplicationId String 25 Special code assigned to every Partner account. You should consult with CleverFox Backup Support before changing this value.
IsInactive Boolean
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only
Token String 50 See API Duplication Prevention

List (GET)

Returns an array of Partners in descending order.

URL
https://cleverfoxbackup.com/api/partners
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
Sample JSON 
{
    "data": [
    {
        "PartnerId": 1,
        "PlanTypeId": 1,
        "PlanType": {
        "PlanTypeId": 1,
        "Name": "CleverFox Backup",
        "IsInactive": false
        },
        "Name": "Forward Thinking Software, LLC",
        "ApplicationId": null,
        "IsInactive": false,
        "AddedOn": "2015-01-01T00:00:00.000",
        "UpdatedOn": null,
        "Token": null
    }
    ],
    "page_no": 1,
    "page_size": 25
}

Read (GET)

Returns a single Partner.

URL
https://cleverfoxbackup.com/api/partners/{PartnerId}
Required Parameters
  • PartnerId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
    "data": {
    "PartnerId": 1,
    "PlanTypeId": 1,
    "PlanType": {
        "PlanTypeId": 1,
        "Name": "CleverFox Backup",
        "IsInactive": false
    },
    "Name": "CleverFox Backup",
    "ApplicationId": null,
    "IsInactive": false,
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null,
    "Token": null
    }
}

Create (POST)


Update (PUT)

Updates a Partner and returns the updated data.

URL
https://cleverfoxbackup.com/api/partners/{PartnerId}
Required Parameters
  • PartnerId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
    "data": {
    "Name": "CleverFox Backup",
    "ApplicationId": null,
    "IsInactive": false,
    "Token": null
    }
}

Delete (DELETE)