FileType
API endpoint for File Types
| API | Description |
|---|---|
| GET api/filetypes?parentEntityValue={parentEntityValue} |
Get Filetypes for a given Parent Entity |
StateProvince
API Endpoint for State/Provinces
| API | Description |
|---|---|
| GET api/territories |
Get State/Provinces |
| GET api/territories?countryId={countryId} |
Get States by Country |
WebProduct
API Endpoint for Webproduct
| API | Description |
|---|---|
| GET api/webproduct/coursetype?accountId={accountId}&courseTypeId={courseTypeId} |
Get Webproduct for a Course Type |
ProviderProgram
| API | Description |
|---|---|
| GET api/provider/program?accountId={accountId}&programId={programId} |
Get Provider Program |
| POST api/provider/program/create?accountId={accountId} |
Create provider program |
| PUT api/provider/program/update?accountId={accountId} |
Update Program Record |
| DELETE api/provider/program?accountid={accountid}&programId={programId} |
Delete a program |
| POST api/provider/program/courselocation?programId={programId} |
Create Course Location for a program |
| PUT api/provider/program/courselocation |
Update a course location |
| DELETE api/provider/program/courselocation?courseLocationId={courseLocationId} |
Delete a course location |
| PUT api/provider/program/submit?contactId={contactId}&accountId={accountId} |
Submit a zero $ Provider Application or Provider Program |
ShoppingCart
| API | Description |
|---|---|
| GET api/shoppingcart?contactId={contactId}&accountId={accountId}&clearCart={clearCart}&ignoreCartType={ignoreCartType} |
Retrieves existing Shopping Cart or creates an empty Shopping Cart |
| GET api/shoppingcart/idtype?contactId={contactId}&accountId={accountId} |
Retrieves Current Shopping Cart Summary Information such as Id and Cart Type |
| POST api/shoppingcart?contactId={contactId}&clearCart={clearCart} |
Updates the Cart and creates/updates related cart items |
| POST api/shoppingcart/save?contactId={contactId}&saveCart={saveCart} |
No documentation available. |
| PUT api/shoppingcart/add/coupon?shoppingCartId={shoppingCartId}&coupon={coupon}&addMissingProducts={addMissingProducts}&couponInCart={couponInCart} |
Add a coupon to a cart |
| DELETE api/shoppingcart/remove/coupon?shoppingCartId={shoppingCartId} |
Remove couopn item from the cart |
| PUT api/shoppingcart/replace/coupon?shoppingCartId={shoppingCartId}&coupon={coupon} |
No documentation available. |
Receipt
| API | Description |
|---|---|
| GET api/receipt?cartId={cartId} |
Get Receipt Info by passing cartId. |
Provider
| API | Description |
|---|---|
| GET api/provider/applications?accountId={accountId} |
Get AP Applications by accountId |
| POST api/provider/create |
Create new Provider account |
| GET api/provider?accountId={accountId} |
Get Provider Account by accountId |
| PUT api/provider/course/status?courseId={courseId}&isRequirementMet={isRequirementMet}&isPendingPayment={isPendingPayment} |
Set Provider Course Status to Pending Attestation |
| GET api/provider/course?courseId={courseId} |
Get provider program by course id |
| PATCH api/provider/application?applicationId={applicationId}&webProductId={webProductId} |
Update Webproduct selection on Provider Application |
| POST api/provider/account/attest?accountId={accountId} |
Update Provider Account Attestation |
ContactsEducation
Contact Education
| API | Description |
|---|---|
| GET api/contacts/{id}/education |
Retrieves a contact's education properties. |
| PUT api/contacts/{id}/education |
Updates a contact's education properties. |
Cpp
| API | Description |
|---|---|
| GET api/cpp |
No documentation available. |
CreditType
API Endpoint for Credit Types
| API | Description |
|---|---|
| GET api/credittypes |
Get Credit Types |
ContactsExperience
Common Application Work Experience for Contacts
| API | Description |
|---|---|
| GET api/contacts/{contactId}/experience |
Gets the contact's work experience |
| POST api/contacts/{contactId}/experience |
Creates a new record for the contact's work experience. |
| PUT api/contacts/{contactId}/experience/{id} |
Updates a record for the contact's work experience |
| DELETE api/contacts/{contactId}/experience/{id} |
Deletes a record from the contact's work experience |
CustomPricing
WebCategory
API Endpoint for Webcategory
| API | Description |
|---|---|
| GET api/webcategory?contactId={contactId}&programId={programId} |
Gets a collection of categories, preset bundles and products. Omitting the contact will return "retail" products. Passing the contact will return "byob" products and "preset bundles". Omitting the program will return relevant products for all programs. *Note* This endpoint no longer returns "exam fee" products. |
| GET api/webcategory/examproducts |
Gets a collection of all categories and products for all programs |
| GET api/webcategory/program?programSearch={programSearch}&productSet={productSet} |
Gets a collection of retail or public categories and products for a program. |
| GET api/webcategory/webProduct?webProductId={webProductId} |
Get webproduct by webProductId |
| GET api/webcategory/providerAppProducts?programId={programId}&accountId={accountId}&applicationId={applicationId} |
Get AP Application products |
Education
| API | Description |
|---|---|
| GET api/education/institutions | |
| GET api/education/specialties |
ContactEligibilityStatus
| API | Description |
|---|---|
| GET api/programs/contact/{contactId}/eligibility |
Get contact elgibility status for each program |
| PUT api/programs/contact/{contactId}?hasPriorAccessToExamContent={hasPriorAccessToExamContent} |
Update the contact answer to the has prior access to exam content |
ApplicationsTermsAndConditions
| API | Description |
|---|---|
| GET api/applications/{id}/termsandconditions |
No documentation available. |
| PUT api/applications/{id}/termsandconditions |
No documentation available. |
Country
API Endpoint for Countries
| API | Description |
|---|---|
| GET api/Country?contactId={contactId} |
Get countries |
CourseType
API Endpoint for CourseTypes
| API | Description |
|---|---|
| GET api/coursetypes?providerPurpose={providerPurpose} |
Get Course Types |
AccessCode
API Endpoint for VoucherStore
| API | Description |
|---|---|
| GET api/accesscode/validate?accessCode={accessCode} |
Verify if an access code is valid |
| PUT api/accesscode/activate?accessCode={accessCode}&contactId={contactId} |
Activate access code |
Affiliations
| API | Description |
|---|---|
| GET api/affiliations?contactId={contactId} |
Get affiliates associated to a contact. |
| POST api/affiliations?contactId={contactId}&accountId={accountId} |
Create an affiliate for a contact |
| DELETE api/affiliations?affiliateId={affiliateId} |
Delete affiliate associated with a contact |
Recert
| API | Description |
|---|---|
| GET api/recertapp/recertcredittotals?applicationId={applicationId} |
Gets recert credit hour totals related to a recert application |
VoucherStore
API Endpoint for VoucherStore
| API | Description |
|---|---|
| GET api/voucherstore?contactId={contactId}&accountId={accountId} |
Gets a collection of web product kits |
Health
API Endpoint for Health
| API | Description |
|---|---|
| GET api/health |
Get Health status |
Accounts
| API | Description |
|---|---|
| GET api/accounts?startsWith={startsWith} |
No documentation available. |
| GET api/accounts/affiliates |
No documentation available. |
Program
API Endpoint for Programs
| API | Description |
|---|---|
| GET api/programs/details |
Get details of all programs |
| GET api/programs/examproduct/details |
Get exam product details for all programs |
| GET api/programs/price?programIds[0]={programIds[0]}&programIds[1]={programIds[1]} |
Get price of App fee and Exam fee for programs |
ContactCheckout
API Endpoint for Checkout Contact
| API | Description |
|---|---|
| GET api/ContactCheckout?contactId={contactId} |
Get contact information for id within checkout context |
ErrorSample
| API | Description |
|---|---|
| GET api/ErrorSample?type={type}&description={description} |
No documentation available. |
ContactsWorkExperience
Contact Work Experience
| API | Description |
|---|---|
| GET api/contacts/{id}/WorkExperience |
Gets a contact's work experience |
| PUT api/contacts/{id}/WorkExperience |
Updates a contact's work experience |
EntityOptionSets
| API | Description |
|---|---|
| GET api/optionsets?entityName={entityName} |
Get a list of Optionset fields and their metadata for a given Entity |
Indcert
| API | Description |
|---|---|
| GET api/indcert/profile?contactId={contactId} |
Get Profile details for a contact |
| PUT api/indcert/profileimage?contactId={contactId} |
Update profile image of a contact. |
| GET api/indcert/applications/current?contactId={contactId} |
Get current exam applications data for indcert dashboard. |
| GET api/indcert/webproducts?contactId={contactId}&relatedprogramId={relatedprogramId} |
Get Web Product data for indcert dashboard. |
| GET api/indcert/recertapps/current?contactId={contactId} |
Get Current and recent recert apps |
Contacts
| API | Description |
|---|---|
| GET api/contacts/{contactId}/status |
Get Embargo Flags for a contact |
| POST api/contacts/CreateContact |
This method used to create a new contact based on the portal data |
| GET api/contacts/details?contactId={contactId}&portalId={portalId} |
Get Contact details. |
| GET api/contacts/authtype?contactId={contactId} |
Get Authtype for a given contact |
| GET api/contacts/accountType?contactId={contactId} |
Get Account Type of a given contact |
| GET api/contacts/relatedAccounts?contactId={contactId}&accountType={accountType} |
Get related accounts for a given contact |
| GET api/contacts/info?contactId={contactId} |
Get Contact details without the related accounts. |
| PUT api/contacts/demographics?contactId={contactId} |
Update Contact Demographics data |
| GET api/contacts/demographics?contactId={contactId} |
Get Contact Demographics data |
| PUT api/contacts/appInProcess?contactId={contactId}&appInProcess={appInProcess} |
Update exam in process flag |
Applications
| API | Description |
|---|---|
| POST api/applications/cpp |
Add CPP to Applications by passing a list of ApplicationId and CPPId |
| GET api/applications/cpp/contacts/{id} |
Get list of CPPs and the respective ApplicationId and ProgramId by passing ContactId |
| GET api/applications/CertApplication?contactId={contactId}&programId={programId} |
Returns pending application by passing contactId and programId |
DashboardConfiguration
API Endpoint for DashboardConfig
| API | Description |
|---|---|
| GET api/dashboardconfig?dashboardType={dashboardType} |
Gets dashboard configurationn for a given dashboard type |
ProgramEligibility
| API | Description |
|---|---|
| GET api/programs/education/{educationId}/eligibility |
Get programs exeperience requirement by passing Degree Speciality Optionset ID |
ShoppingCartItem
| API | Description |
|---|---|
| PUT api/ShoppingCartItem?shoppingCartItemId={shoppingCartItemId}&courseAvailabilityId={courseAvailabilityId} |
Update Shopping Cart Line Item. |
| DELETE api/ShoppingCartItem?shoppingCartItemId={shoppingCartItemId} |
Delete Shopping Cart Line Item. |
| POST api/ShoppingCartItem?webProductId={webProductId}&shoppingCartId={shoppingCartId}&quantity={quantity}&price={price} |
Add Shopping Cart Line Item. |
| PUT api/ShoppingCartItem?shoppingCartItemId={shoppingCartItemId}&quantity={quantity}&price={price} |
Update Shopping Cart Line Item. |