Welcome to coach-admin-api’s documentation!

Contents:

The Basics

• Getting Started
  • Conventions used
  • Coach
  • Formats
  • Authentication
  • Create, Update and Lookups
  • REST API Methods and Models
  • HTTP PUT and DELETE Issue
  • TODO List
• C# Wrapper
  • Setup and Dependencies
  • Authentication
  • Response Content and API Wrapper
• Client Errors
  • Error Model
  • Request Argument Model
  • Known Errors
• Release History
  • 1.0.2 (2015-11-20)
  • 1.0.1 (2015-01-01)
  • 1.0.0 (2014-01-01)
• Roles
  • System Administrator
  • Application Administrator
  • Manager
  • Agent

API

• Tenant
  • Tenant Domain Model
  • Get Tenant by Id
  • Update Tenant
• Unit
  • Unit Domain Model
  • Unit List Model
  • List of Units
  • Get Unit by Id
  • Create Unit
  • Update Unit
  • Delete Unit
• Team
  • Team Domain Model
  • Team List Model
  • List of Teams
  • Get Team by Id
  • Create Team
  • Update Team
  • Delete Team
• User
  • User Domain Model
  • User List Model
  • List of Users
  • Get User by Id
  • Create User
  • Update User
  • Delete User
• Media Player
  • Media Player Types
  • Media Player Domain Model
  • Media Player List Model
  • List of Media Players
  • Get Media Player by Id
  • Create Media Player
  • Update Media Player
  • Delete Media Player
• Recorder
  • Recorder Components
  • Recorder Domain Model
  • Recorder List Model
  • List of Recorders
  • Get Recorder by Id
  • Create Recorder
  • Update Recorder
  • Delete Recorder
• Search Criteria
  • Search Criteria Model
  • Data Type with Conditions Model
• Media File Metadata
  • Required Media File Metadata
  • Media File Metadata Model
  • Database Data Type Model
• Recorder Media Player
  • Recorder Media Player Domain Model
  • Recorder Media Player List Model
  • List of Recorder Media Players
  • Get Recorder Media Player by Id
  • Create Recorder Media Player
  • Update Recorder Media Player
  • Delete Recorder Media Player
• Schedule
  • Schedule Domain Model
  • Schedule List Model
  • Schedule Level List Model
  • List of Schedules
  • Get Schedule by Id
  • Create Schedule
  • Update Schedule
  • Delete Schedule
• Period Types and Occurrences
  • Period Types
  • Occurrences
  • Period Types and Occurrences Combinations
  • Period Types and Occurrences with Required [Schedule](/v1/schedule) Model Properties
• License
  • Obtain License
• Tenant Tree
  • Graphical Tenant Tree Representation
  • Tenant Tree Item Model
  • Tenant Tree Item
• Recording Evaluations
  • Recording Evaluations List Model
  • List of Evaluations for Recording Call Id