Perfect Gym api

Overview

The PerfectGym API lets you tap into PerfectGym and build your own PerfectGym-powered web, desktop and mobile applications.

The API provides a simple, resource-oriented, RESTful interface with JSON-formatted responses to use PerfectGym’s features.

General API conventions

All API access is over HTTPS, and accessed from the yourcompany.perfectgym.com/Api/. All data is sent and received as JSON.

curl -i https://yourcompany.perfectgym.com/Api/Classes/Classes/1/0

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 61
Content-Type: application/json; charset=utf-8
Expires: -1
Server: Microsoft-IIS/8.5
WWW-Authenticate: Bearer
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
pg-app: externalapi
X-Powered-By: ARR/3.0
pg-app: Routing
Date: Fri, 18 Dec 2015 16:47:49 GMT

Blank fields

Blank fields are included as null instead of being omitted.

Identifiers & timestamps

All resources are identified with long id and timestamp attributes.

Date format

All dates and times follow the ISO 8601 format and are provided in local time zone:

YYYY-MM-DDTHH:MM:SS

Endpoint names and return values

An endpoint's name indicates the type of data it handles and the action it performs on that data. The most common actions are:

Action HTTP Method Description
List GET Returns summary information for all entities that match query parameters you provide. To get detailed information for a particular entity, first get the entity's id with the appropriate List endpoint, then provide the id to the corresponding Retrieve endpoint.
Retrive GET Provides detailed information for the single entity that matches the identifier you provide.
Execute POST Used for invoking actions.
Add POST Used for creating resources.
Update PUT Used for updating resources.
Delete DELETE Used for deleting resources.
Perfect Gym api