ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Clients

API	Description
GET api/pro/clinics/{clinicId}/clients	Gets all Clients for a specific clinic
GET api/pro/clinics/{clinicId}/clients/{clientId}	Gets a Client by clinic and client id.
POST api/pro/clinics/{clinicId}/clients	Creates a Zyto Pro Client.
PUT api/pro/clinics/{clinicId}/clients/{clientId}/person-info	Change the person information for the specific client
PUT api/pro/clinics/{clinicId}/clients/{clientId}/contact-info	Change the contact information for the specific client
PUT api/pro/clinics/{clinicId}/clients/{clientId}/archived	Change the archived property

ProductLicenses

API	Description
GET api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}	Gets a Product License for a clinic using the Product License Id
GET api/pro/clinics/{clinicId}/product-licenses	Gets all ProductLicenses
GET api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}/product-addon-licenses	No documentation available.
GET api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}/claim/{claimId}	Gets a value that indicates whether the specified license claim id exists and is valid
POST api/pro/clinics/{clinicId}/product-licenses	Creates a new pro ProductLicense.
POST api/pro/clinics/{clinicId}/product-licenses/{id}	Creates a new pro ProductLicense.
POST api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}/claim	Claims a license.
POST api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}/release	No documentation available.
PUT api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}/expiration-date	Sets the expiration date of the specified license.
PUT api/pro/clinics/{clinicId}/product-licenses/{productLicenseId}/claim	Sets the claim information of the specified product license.

ClinicLibraries

Clinic Libraries Controller Class

API	Description
GET api/pro/clinics/{clinicId}/clinic-libraries	Gets all Clinic Libraries
GET api/pro/clinics/{clinicId}/clinic-libraries/{clinicLibraryId}	Gets a ClinicLibrary account by id.
POST api/pro/clinics/{clinicId}/clinic-libraries	Creates a new Zyto Pro ClinicLibrary.
PUT api/pro/clinics/{clinicId}/clinic-libraries/{clinicLibraryId}/blob-metadata	Updates Blob Metadata for a given clinic library
PUT api/pro/clinics/{clinicId}/clinic-libraries/{clinicLibraryId}/name	Changes the name of the specified Clinic Library
PUT api/pro/clinics/{clinicId}/clinic-libraries/{clinicLibraryId}/archived	Changes the archived field of the specified clinic library

UserClaims

API	Description
GET api/pro/user-claims/{zapId}	Gets a UserClaim by zap id.

UserNotifications

API	Description
POST api/pro/user-notifications	Adds a new user notification.

ClientAppointments

API	Description
POST api/pro/clinics/{clinicId}/client-appointments	Creates a new zyto pro client appointment.
PUT api/pro/clinics/{clinicId}/client-appointments/{clientAppointmentId}/name	Update the name for the specific client appointment.
PUT api/pro/clinics/{clinicId}/client-appointments/{clientAppointmentId}/start-date	Update the start date for the specific client appointment.
PUT api/pro/clinics/{clinicId}/client-appointments/{clientAppointmentId}/archived	Update the archived for the specific client appointment.
GET api/pro/clinics/{clinicId}/client-appointments	Gets all client appointments for a specific clinic id.
GET api/pro/clinics/{clinicId}/client-appointments/{clientAppointmentId}	Gets a client appointment by clinic and client id.

PublishedLibraries

API	Description
GET api/pro/published-libraries	Gets all PublishedLibraries for a specific clinic
GET api/pro/published-libraries/{publishedlibraryid}	Gets a PublishedLibrary account by id.
POST api/pro/published-libraries	Creates a Published Library.
PUT api/pro/published-libraries/{publishedlibraryId}/blob-metadata	Change the blob metadata for a given published library
PUT api/pro/published-libraries/{publishedlibraryid}/name	Changes the name of the specified published library
PUT api/pro/published-libraries/{publishedlibraryid}/archived	Changes the archived field of the specified published library

Owners

API	Description
GET api/pro/owners/{id}/clinics	Gets all zyto pro clinics for the specified owner.
GET api/pro/owners/{userId}/clinicrightsforuser	No documentation available.

Administrators

API	Description
GET api/pro/administrators	Gets all administrators.
GET api/pro/administrators/{id}	Gets an administrator by id.
POST api/pro/administrators	Creates a new administrator.
POST api/pro/administrators/{id}	Creates a new administrator.
PUT api/pro/administrators/{id}/rights	Changes the rights of the specified administrator.
DELETE api/pro/administrators/{id}	Removes a ZAP identity from the list of administrators.

Clinics

API	Description
POST api/pro/clinics	Creates a new pro Clinic.
POST api/pro/clinics/{id}	Add Clinic
PUT api/pro/clinics/{id}/owner	Changes the owner of the specified zyto pro clinic.
PUT api/pro/clinics/{id}/admin	Changes the admin of the specified zyto pro clinic.
PUT api/pro/clinics/{id}/name	Changes the name of the specified zyto pro clinic.
PUT api/pro/clinics/{id}/owner-contact-info	Changes the customer contact info of the specified zyto pro clinic.
PUT api/pro/clinics/{id}/primary-library	Changes the primary library of the specified zyto pro clinic.
GET api/pro/clinics/{id}	Gets a Clinic account by id.
GET api/pro/clinics	Gets all zyto pro clinics.
GET api/pro/clinics/{id}/blob-container	Gets an Azure blob access token for the specified clinic.

ProductAddonLicenses

API	Description
GET api/pro/clinics/{clinicId}/product-addon-licenses	Gets all product add-on licenses for the specified clinic.
GET api/pro/clinics/{clinicId}/product-addon-licenses/{productAddonLicenseId}	Gets the specified product add-on license for a clinic.
POST api/pro/clinics/{clinicId}/product-addon-licenses	Creates a new product add-on license.
POST api/pro/clinics/{clinicId}/product-addon-licenses/{id}	Creates a new product add-on license.
POST api/pro/clinics/{clinicId}/product-addon-licenses/{productAddonLicenseId}/associate	Associates a product license with the specified product add-on license.
POST api/pro/clinics/{clinicId}/product-addon-licenses/{productAddonLicenseId}/disassociate	Disassociates a product license from the specified product add-on license.
PUT api/pro/clinics/{clinicId}/product-addon-licenses/{productAddonLicenseId}/expiration-date	Modifies the expiration date of the specified product add-on license.
DELETE api/pro/clinics/{clinicId}/product-addon-licenses/{productAddonLicenseId}	Deletes a product add-on license.

Products

API	Description
GET api/pro/products/{id}	Gets a Product account by id.
GET api/pro/products	Gets all products.
POST api/pro/products	Creates a new zyto-pro Product.
POST api/pro/products/{id}	Creates a new zyto-pro Product.
PUT api/pro/products/{id}/name	Changes the name of the specified product.
PUT api/pro/products/{id}/libraries	Changes the libraries of the specified product.
PUT api/pro/products/{id}/default-product-addons	Changes the default product addons ids of the specified product.

Sessions

API	Description
GET api/pro/clinics/{clinicId}/sessions/{id}	Gets a Session clinic by id.
GET api/pro/clinics/{clinicId}/sessions	Gets all sessions for the specified clinic.
GET api/pro/clinics/{clinicId}/sessions/start-dates	Gets all session start dates for the specified clinic.
POST api/pro/clinics/{clinicId}/sessions	Creates a new pro Session.
PUT api/pro/clinics/{clinicId}/sessions/{sessionId}/blob-metadata	Updates the blob metadata for a given session.
PUT api/pro/clinics/{clinicId}/sessions/{sessionId}/name	Updates the session name for a given session.
PUT api/pro/clinics/{clinicId}/sessions/{sessionId}/archived	Updates the session name for a given session.

ProductAddons

API	Description
POST api/pro/product-addons	Creates a new pro ProductAddon.
POST api/pro/product-addons/{id}	Creates a new pro ProductAddon.
PUT api/pro/product-addons/{id}/name	Changes the name of the specified product.
PUT api/pro/product-addons/{id}/libraries	Changes the Library List of the specified product.
PUT api/pro/product-addons/{id}/archived	Changes the Archived value of the specified product.
GET api/pro/product-addons	Gets all ProductAddons
GET api/pro/product-addons/{id}	Gets a ProductAddon by id.
GET api/pro/product-addons/{id}/clinics	Gets all Clinic for a given ProductAddons
GET api/pro/product-addons/{id}/clinicIds	No documentation available.

ClinicEmployees

API	Description
POST api/pro/clinics/{clinicId}/employees	Creates a new Clinic Employee.
POST api/pro/clinics/{clinicId}/employees/{id}	Creates a new Clinic Employee.
GET api/pro/clinics/{clinicId}/employees/{employeeId}	Gets a ClinicEmployee by id.
GET api/pro/clinics/{clinicId}/employees	Gets all Clinic Employees.
PUT api/pro/clinics/{clinicId}/employees/{employeeId}/Rights	Changes a clinic employees rights
PUT api/pro/clinics/{clinicId}/employees/{employeeId}/manage-clinic-library-ids	Changes a clinic employees rights
DELETE api/pro/clinics/{clinicId}/employees/{employeeId}	Removes a Clinic Employee from the list.