Introduction

Welcome to the ProClass Web API. The links below describe in detail the functionality available to you in this API.

Authentication

Access to the ProClass Web API service requires the client Unit's API authentication credentials. ProClass Web API service is using the HTTP Basic Authentication method.

Example:
The Demo API site credentials DemoApi:I49!un2BIS98 in username:password format gets Base64 encoded to Q29udGludWluZ0VkdWNhdGlvbkFwaTpZRkRuYjI4dw==

The encoded credentials should be set in the HTTP Authentication header of the request to ProClass Web API service. Here's an PHP code snippet to set the authentication credentials. Please refer to your preferred programming language or tools documentation on how to set the credentials in the HTTP Authentication header.


                    $username = "DemoApi";

                    $password = "I49!un2BIS98"; 

                    $remote_url = 'https://apidemo.imperisoft.com/api/AccountTypes'; 

                    

                    // Create a stream

                    $opts = array(

                    'http'=>array(

                    'method'=>"GET",

                    'header' => "Authorization: Basic " . base64_encode("$username:$password")

                    )

                    );

                    

                    $context = stream_context_create($opts);

                    

                    // Open the file using the HTTP headers set above

                    $file = file_get_contents($remote_url, false, $context);

                    

                    print($file);
                    


                    // Note: This is from this site, modified to set sample credentials only, not tested.

AccountContacts

API	Description
GET api/AccountContacts	Returns a list of all account contacts in your database. This list is searchable using the OData protocol.
GET api/AccountContacts/{id}	Returns a specific account contact

AccountContactTypes

API	Description
GET api/AccountContactTypes	Returns a list of all account contact types in your database
GET api/AccountContactTypes/{id}	Returns a specific account contact type

Accounts

API	Description
GET api/Accounts	Returns a list of all accounts in your database. This list is searchable using the OData protocol.
GET api/Accounts/{id}	Returns a specific account
GET api/Accounts?name={name}	Returns a list of all accounts in your database filtered by name

AccountTypes

API	Description
GET api/AccountTypes	Returns a list of all account types in your database
GET api/AccountTypes/{id}	Returns a specific account type

Addresses

API	Description
GET api/Addresses	Returns a list of all contact addresses in your database. This list is searchable using the OData protocol.
GET api/Addresses/{id}	Returns a specific contact address
PATCH api/Addresses/{id}	Peforms a partial update on an address

AddressTypes

API	Description
GET api/AddressTypes	Returns a list of all address types in your database
GET api/AddressTypes/{id}	Returns a specific address type

ContactList

API	Description
GET api/ContactList	Returns a summary list of all contacts in your database. This list is searchable using the OData protocol.
GET api/ContactList/{id}	Returns summary information about a specific contact

Contacts

API	Description
GET api/Contacts	Returns a list of all contacts in your database. This list is searchable using the OData protocol.
GET api/Contacts/{id}	Returns a specific contact
GET api/Contacts?lastName={lastName}	Returns a list of all contacts in your database filtered by last name

ContactUdfValues

API	Description
GET api/ContactUdfValues	Returns a list of all contact udf values in your database. This list is searchable using the OData protocol.
GET api/ContactUdfValues/{id}	Returns a specific contact udf value

CreditCardTypes

API	Description
GET api/CreditCardTypes	Returns a list of all credit card types in your database
GET api/CreditCardTypes/{id}	Returns a specific credit card type

Instructors

API	Description
GET api/Instructors	Returns a list of all instructors in your database
GET api/Instructors/{id}	Returns a specific instructor

InstructorTypes

API	Description
GET api/InstructorTypes	Returns a list of all instructor types in your database
GET api/InstructorTypes/{id}	Returns a specific instructor type

Invoices

API	Description
GET api/Invoices	Returns a list of all invoices in your database. This list is searchable using the OData protocol.
GET api/Invoices/{id}	Returns a specific invoice

MarkTypes

API	Description
GET api/MarkTypes	Returns a list of all mark types in your database
GET api/MarkTypes/{id}	Returns a specific mark type

MediaTypes

API	Description
GET api/MediaTypes	Returns a list of all media types in your database
GET api/MediaTypes/{id}	Returns a specific media type

OnlineProgramList

API	Description
GET api/OnlineProgramList	Returns a summary list of all currently online programs in your database. It includes the program's location and minimal Semester information. This list is searchable using the OData protocol.
GET api/OnlineProgramList/{id}	Returns a specific program
GET api/OnlineProgramList?semesterId={semesterId}	Returns a summary list of all currently online programs for the given semester.

OnlinePrograms

API	Description
GET api/OnlinePrograms	Returns a list of all currently online programs in your database. It includes the program's location and minimal Semester information. This list is searchable using the OData protocol.
GET api/OnlinePrograms?semesterId={semesterId}	Returns a list of all currently online programs for the given semester

OnlineSemesters

API	Description
GET api/OnlineSemesters	Returns a list of all currently online semesters in your database (programs for each semester are filtered to show only those that are currently online). This list is searchable using the OData protocol.
GET api/OnlineSemesters/{id}	Returns a specific online semester (programs for the semester are filtered to show only those that are currently online)

PaymentMethodTypes

API	Description
GET api/PaymentMethodTypes	Returns a list of all payment method types in your database
GET api/PaymentMethodTypes/{id}	Returns a specific payment method type

Payments

API	Description
GET api/Payments?accountId={accountId}	Returns a list of all payments for the given account
GET api/Payments?startDate={startDate}&endDate={endDate}&dateType={dateType}	Returns a list of all payments for the given date range
GET api/Payments/{id}	Returns a specific payment

PaymentStatusTypes

API	Description
GET api/PaymentStatusTypes	Returns a list of all payment status types in your database
GET api/PaymentStatusTypes/{id}	Returns a specific payment status type

ProgramInstructors

API	Description
GET api/ProgramInstructors	Returns a list of all program instructors in your database. This list is searchable using the OData protocol.
GET api/ProgramInstructors/{id}	Returns a specific program instructor

ProgramInstructorTypes

API	Description
GET api/ProgramInstructorTypes	Returns a list of all program instructor types in your database
GET api/ProgramInstructorTypes/{id}	Returns a specific program instructor type

ProgramList

API	Description
GET api/ProgramList	Returns a summary list of all programs in your database. It includes the program's location and minimal Semester information. This list is searchable using the OData protocol.
GET api/ProgramList/{id}	Returns a specific program
GET api/ProgramList?semesterId={semesterId}	Returns a list of all programs for the given semester

Programs

API	Description
GET api/Programs	Returns a list of all programs in your database. It includes the program's location information. This list is searchable using the OData protocol.
GET api/Programs/{id}	Returns a specific program
GET api/Programs?semesterId={semesterId}	Returns a list of all programs for the given semester

ProgramTypes

API	Description
GET api/ProgramTypes	Returns a list of all program types in your database
GET api/ProgramTypes/{id}	Returns a specific program type

RegistrationList

API	Description
GET api/RegistrationList	Returns a summary list of all registrations in your database. This list is searchable using the OData protocol.
GET api/RegistrationList/{id}	Returns summary information about a specific registration

Registrations

API	Description
GET api/Registrations	Returns a list of all registrations in your database. This list is searchable using the OData protocol.
GET api/Registrations/{id}	Returns a specific registration

RegistrationStatusTypes

API	Description
GET api/RegistrationStatusTypes	Returns a list of all registration status types in your database
GET api/RegistrationStatusTypes/{id}	Returns a specific registration status type

SemesterList

API	Description
GET api/SemesterList	Returns a summary list of all semesters in your database. This list is searchable using the OData protocol.
GET api/SemesterList/{id}	Returns a specific semester

Semesters

API	Description
GET api/Semesters	Returns a list of all semesters in your database. This list is searchable using the OData protocol.
GET api/Semesters/{id}	Returns a specific semester

SemesterTypes

API	Description
GET api/SemesterTypes	Returns a list of all semester types in your database
GET api/SemesterTypes/{id}	Returns a specific semester type

States

API	Description
GET api/States	Returns a list of all state lookups defined in your database
GET api/States/{id}	Returns a specific state lookup item

Students

API	Description
GET api/Students	Returns a list of all students in your database. This list is searchable using the OData protocol.
GET api/Students/{id}	Returns a specific student

StudentStatusTypes

API	Description
GET api/StudentStatusTypes	Returns a list of all student status types in your database
GET api/StudentStatusTypes/{id}	Returns a specific student status type

Transactions

API	Description
GET api/Transactions?accountId={accountId}	Returns a list of all parent transactions for the given account
GET api/Transactions?invoiceId={invoiceId}	Returns a list of all parent transactions for the given invoice
GET api/Transactions?startDate={startDate}&endDate={endDate}&dateType={dateType}	Returns a list of all transactions (parent or child) for the given date range
GET api/Transactions/{id}	Returns a specific transaction

TransactionSubTypes

API	Description
GET api/TransactionSubTypes	Returns a list of all transaction sub types in your database
GET api/TransactionSubTypes/{id}	Returns a specific transaction sub type

TransactionTypes

API	Description
GET api/TransactionTypes	Returns a list of all transaction types in your database
GET api/TransactionTypes/{id}	Returns a specific transaction type

UdfDataTypes

API	Description
GET api/UdfDataTypes	Returns a list of all user-defined field data types in your database
GET api/UdfDataTypes/{id}	Returns a specific user-defined field data type