CreditType

API Endpoint for Credit Types

APIDescription
GET api/credittypes

Get Credit Types

Program

API Endpoint for Programs

APIDescription
GET api/programs/details

Get details of all programs

GET api/programs/examproduct/details

Get exam product details for all programs

FileType

API endpoint for File Types

APIDescription
GET api/filetypes?parentEntityValue={parentEntityValue}

Get Filetypes for a given Parent Entity

ContactsEducation

Contact Education

APIDescription
GET api/contacts/{id}/education

Retrieves a contact's education properties.

PUT api/contacts/{id}/education

Updates a contact's education properties.

EntityOptionSets

APIDescription
GET api/optionsets?entityName={entityName}

Get a list of Optionset fields and their metadata for a given Entity

CourseType

API Endpoint for CourseTypes

APIDescription
GET api/coursetypes?providerPurpose={providerPurpose}

Get Course Types

ErrorSample

APIDescription
GET api/ErrorSample?type={type}&description={description}

No documentation available.

ContactEligibilityStatus

APIDescription
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

CustomPricing

APIDescription
GET api/CustomPricing?ProcessingString={ProcessingString}&WebProductId={WebProductId}&Quantity={Quantity}&Price={Price}&ContactId={ContactId}&ShipToAddress1={ShipToAddress1}&ShipToAddress2={ShipToAddress2}&ShipToAddress3={ShipToAddress3}&ShipToCity={ShipToCity}&ShipToState={ShipToState}&ShipToZip={ShipToZip}&ShipToCountry={ShipToCountry}&AccountId={AccountId}

No documentation available.

Education

APIDescription
GET api/education/institutions

GET api/education/specialties

Recert

APIDescription
GET api/recertapp/recertcredittotals?applicationId={applicationId}

Gets recert credit hour totals related to a recert application

StateProvince

API Endpoint for State/Provinces

APIDescription
GET api/territories

Get State/Provinces

GET api/territories?countryId={countryId}

Get States by Country

WebCategory

API Endpoint for Webcategory

APIDescription
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

Applications

APIDescription
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

Receipt

APIDescription
GET api/receipt?cartId={cartId}

Get Receipt Info by passing cartId.

Country

API Endpoint for Countries

APIDescription
GET api/Country?contactId={contactId}

Get countries

ContactCheckout

API Endpoint for Checkout Contact

APIDescription
GET api/ContactCheckout?contactId={contactId}

Get contact information for id within checkout context

ShoppingCart

APIDescription
GET api/shoppingcart?contactId={contactId}&accountId={accountId}&clearCart={clearCart}&ignoreCartType={ignoreCartType}

Retrieves existing Shopping Cart or creates an empty Shopping Cart

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.

Indcert

APIDescription
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

Cpp

APIDescription
GET api/cpp

No documentation available.

Affiliations

APIDescription
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

Accounts

APIDescription
GET api/accounts?startsWith={startsWith}

No documentation available.

GET api/accounts/affiliates

No documentation available.

VoucherStore

API Endpoint for VoucherStore

APIDescription
GET api/voucherstore?contactId={contactId}&accountId={accountId}

Gets a collection of web product kits

DashboardConfiguration

API Endpoint for DashboardConfig

APIDescription
GET api/dashboardconfig?dashboardType={dashboardType}

Gets dashboard configurationn for a given dashboard type

Contacts

APIDescription
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

Health

API Endpoint for Health

APIDescription
GET api/health

Get Health status

ContactsWorkExperience

Contact Work Experience

APIDescription
GET api/contacts/{id}/WorkExperience

Gets a contact's work experience

PUT api/contacts/{id}/WorkExperience

Updates a contact's work experience

AccessCode

API Endpoint for VoucherStore

APIDescription
GET api/accesscode/validate?accessCode={accessCode}

Verify if an access code is valid

PUT api/accesscode/activate?accessCode={accessCode}&contactId={contactId}

Activate access code

ProgramEligibility

APIDescription
GET api/programs/education/{educationId}/eligibility

Get programs exeperience requirement by passing Degree Speciality Optionset ID

ApplicationsTermsAndConditions

APIDescription
GET api/applications/{id}/termsandconditions

No documentation available.

PUT api/applications/{id}/termsandconditions

No documentation available.

ContactsExperience

Common Application Work Experience for Contacts

APIDescription
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

Provider

APIDescription
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

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

ProviderProgram

APIDescription
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

GET api/provider/program/activity?courseNumber={courseNumber}&contactId={contactId}

No documentation available.

WebProduct

API Endpoint for Webproduct

APIDescription
GET api/webproduct/coursetype?accountId={accountId}&courseTypeId={courseTypeId}

Get Webproduct for a Course Type

ShoppingCartItem

APIDescription
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.