Account

Controller for dealing with insured account creation and updating

APIDescription
POST api/v1/account

Action for creating a new insured login that will also create a new contact in srpolicy contacts table. If account already exists, Contact Row will be updated If a new account is made, a tokenized email will be sent for password

GET api/v1/profile?employeeNumber={employeeNumber}

Get profile information by employee number. UserName will attempt to be retreived via customer info first, then agents info and finally internal info.

RecurringProfileManagement

The controller for all recurring payment profile functions.

APIDescription
POST api/v1/recurringprofilemanagement/register

Performs all actions necessary to register a recurring profile including registering via the external payment processor and saving a record in the internal database.

POST api/v1/recurringprofilemanagement/update

Performs all actions necessary to update a recurring profile including registering a new profile via the external payment processor, saving a record of the new profile in the internal database, suspending the previous profile via the external payment processor, and canceling the record in the internal database.

PUT api/v1/recurringprofilemanagement/cancel

Performs all actions necessary to cancel a recurring profile including suspending via the external payment processor and canceling the record in the internal database.

PUT api/v1/recurringprofilemanagement/reactivate

Performs all actions necessary to reactivate a recurring profile including reactivating via the external payment processor and reactivating the record in the internal database.

PUT api/v1/recurringprofilemanagement/suspend

Performs all actions necessary to suspend a recurring profile including suspending via the external payment processor and suspending the record in the internal database.

Comment

retrieves and adds comments to a contract

APIDescription
GET api/v1/comments/{referenceNumber}/{type}

Gets all comments for a given contract or RO

POST api/v1/comment

Adds a comment to the given reference number

ExternalServicerRequest

Controller for submitting and retrieving External Servicer Interface (ESI) Requests

APIDescription
GET api/v1/externalServicerRequest/requestSearch?validationNumber={validationNumber}&repairOrderNumber={repairOrderNumber}&requestNumber={requestNumber}&payNumber={payNumber}

search for servicer requests

GET api/v1/externalServicerRequest/requestSearchByDate

search for servicer requests by date and type

GET api/v1/externalServicerRequest/getContractRequestDetails?requestNumber={requestNumber}

gets contract request details

GET api/v1/externalServicerRequest/getContractModificationDetails?requestNumber={requestNumber}

gets contract modification request details

GET api/v1/externalServicerRequest/getRtypeRequestDetails?requestNumber={requestNumber}

gets r-type request details

POST api/v1/externalServicerRequest/submitLocateContract

submits a contract request

POST api/v1/externalServicerRequest/submitModifyContract

submits a contract modification request

POST api/v1/externalServicerRequest/updateRequest

submits an update request

Dealer

APIDescription
GET api/v1/dealer/{id}

Gets dealer information by id

GET api/v1/dealer?brandCode={brandCode}&countryCode={countryCode}&dealerName={dealerName}

No documentation available.

PUT api/v1/dealer/brandcode

No documentation available.

PlanDetail

Controller for retrieving details about a contract

APIDescription
GET api/v1/plandetail/{id}

Gets plan details by contract number

GET api/v1/plandetail/deductibleoptions/{id}

Get all deductible options for a plan

PUT api/v1/plandetail/updateplancontactinfo

Updates the contact information associated with a plan

PUT api/v1/plandetail/transferplan

Allows a plan to be transferred to a new name

GET api/v1/plandetail/getallplansforuser?EmployeeNumber={EmployeeNumber}&BrandCode={BrandCode}&IsCustomer={IsCustomer}&CanFileClaim={CanFileClaim}

Gets all warranties for a user based off of their employeenumber.

Troubleshooting

controller for retrieving troubleshooting questions for the claims process

APIDescription
GET api/v1/troubleshooting/{lineOfBusiness}/{troubleShootingCode}?validationNumber={validationNumber}

returns troubleshooting for a given product code. Returns questions that apply to all proudcts if product is not found

POST api/v1/troubleshooting/rulecheck

No documentation available.

POST api/v1/troubleshooting/SubmitTroubleshooting

Post Troubleshooting Question with Anwser to database.

GET api/Troubleshooting/GetUnderwritingQuestions?validationNumber={validationNumber}&languageOption={languageOption}

Get Troubleshooting Questions from underwriting API

DeviceConfirmation

Controller for saving device confirmation and ascertaining if confirmed info matches AS400

APIDescription
GET api/v1/deviceConfirmation?warNum={warNum}&repairOrderNumber={repairOrderNumber}&payNumber={payNumber}&claimId={claimId}

No documentation available.

POST api/v1/deviceConfirmation

No documentation available.

ComponentMaintenance

Controller for adding and removing items from a contract

APIDescription
GET api/v1/componentmaintenance/getavailablemanufacturersforproductclass?productClass={productClass}

Gets available manufacturers for a product class

GET api/v1/componentmaintenance/getavailablemodels?productClass={productClass}&mfgId={mfgId}

Gets available models for a manufacturer and product class

GET api/v1/componentmaintenance/getavailableproductclasses?warrantyNumber={warrantyNumber}&skuNumber={skuNumber}

Gets available product classes for a warranty number or sku. If the plan is not eligible to add, returns null

DELETE api/v1/componentmaintenance/dropcomponent?user={user}&warrantyNumberToDrop={warrantyNumberToDrop}

Drops a component.

POST api/v1/componentmaintenance/addcomponent

Action for adding a component to a multi component contract

WarrantyManagement

The controller for all general warranty management functions.

APIDescription
POST api/v1/warrantymanagement/createwarranty

DEPRECATED - Please use api/v2/warrantymanagement/create Performs all actions necessary to create a warranty including making the down payment, creating the account, creating the policy, creating invoices (if applicatble), and creating the recurring profile (if applicable).

POST api/v1/warrantymanagement/createwarrantywithdetails

DEPRECATED - Please use api/v2/warrantymanagement/create Performs all actions necessary to create a warranty including making the down payment, creating the account, creating the policy, creating invoices (if applicatble), and creating the recurring profile (if applicable).

POST api/v2/warrantymanagement/create

Performs all actions necessary to create a warranty including making the down payment, creating the account, creating the policy, creating invoices (if applicatble), and creating the recurring profile (if applicable).

GET api/v1/warrantymanagement/cancelwarranty?policyId={policyId}&product={product}&requestedCancellationDate={requestedCancellationDate}

Returns data about a requested cancellation.

PUT api/v1/warrantymanagement/cancelwarranty

DEPRECATED - Please use api/v2/warrantymanagement/cancel Performs all actions necessary to cancel a warranty including cancelling the policy, cancelling the recurring profile (if applicable), and saving a refund to be issued by the daily batch program on the next day (if applicable).

PUT api/v2/warrantymanagement/cancel

Performs all actions necessary to cancel a warranty including cancelling the policy, cancelling the recurring profile (if applicable), and saving a refund to be issued by the daily batch program on the next day (if applicable).

PUT api/v1/warrantymanagement/reactivatewarranty

Performs all actions necessary to reactivate a warranty including reactivating the policy, reactivating the recurring profile (if applicable), and canceling the refund saved from the cancellation process (if applicable).

PUT api/v1/warrantymanagement/suspendwarranty

Performs all actions necessary to suspend a warranty including suspending emails sent to the policyholder and suspending the recurring profile (if applicable).

Plan

API controller used to perform CRUD functions on CPS plans.

APIDescription
POST api/v{version}/plan

Create new plan

GET api/v{version}/plan?id={id}

Retrieve individual plan using Warrantech warranty number

PUT api/v{version}/plan?id={id}

Update specified plan

DELETE api/v{version}/plan?id={id}

Delete specified plan

POST api/Plan/Post

Create new plan

GET api/Plan/Get/{id}

Retrieve individual plan using Warrantech warranty number

PUT api/Plan/Put/{id}

Update specified plan

DELETE api/Plan/Delete/{id}

Delete specified plan

Claim

Controller that handles all things claims related

APIDescription
GET api/v1/claim/checkoverrides/{id}?claimDate={claimDate}&isAgent={isAgent}

Checks all potential overrides for a claim

POST api/v1/claim

Validates, Creates, and Continues Claims

POST api/v1/claim/subclaim

Create sub claim on existing claim

POST api/v1/claim/authorization

Validates, creates, updates, and syncs Authorization Requests.

ServicePowerAuthorization

API Controller used to create, update, or retrieve Requests for Authorization in Service power.

APIDescription
GET api/v1/spauth/get?CallNumber={CallNumber}&FromChangedOn={FromChangedOn}&ToChangedOn={ToChangedOn}

Retrieves the data for a Request For Authorization in Service Power.

GET api/v1/servicePowerCalls/{status}

Retrieves a collection of Service Power calls, from the last seven days, assigned to the given status

Payment

The controller for processing the various types of payments.

APIDescription
POST api/v1/payment/processsubsequentpayment

DEPRECATED - Please use api/v2/payment/subsequent Performs all actions necessary to process a subsequent payment including making the payment and recording it.

POST api/v2/payment/subsequent

Performs all actions necessary to process a subsequent payment including making the payment and recording it.

POST api/v1/payment/processdownpayment

Performs all actions necessary to process a down payment including making the payment and recording it.

POST api/v1/payment/processdeductiblepayment

Performs all actions necessary to process a deductible payment including making the payment and recording it.

ServiceCenter

The controller for service center management. Retrieve / Add / Edit Service Centers Retrieve / Add / Edit Product/Rates Retrieve / Add / Edit Manufacturer Retrieve / Add / Edit Zipcodes Retrieve / Add / Edit ACH profiles

APIDescription
GET api/v1/servicecenter?ServiceCenterNumber={ServiceCenterNumber}&ServiceCenterName={ServiceCenterName}&ServiceCenterCity={ServiceCenterCity}&ServiceCenterState={ServiceCenterState}&ServiceCenterPhoneNumber={ServiceCenterPhoneNumber}&PageNumber={PageNumber}&PageSize={PageSize}

No documentation available.

POST api/v1/servicecenter

Creates and saves a new service center

PUT api/v1/servicecenter

Updates an existing service center

GET api/v1/servicecenter/{serviceCenterNumber}/{withNotes}

Returns service center information for the given service center number

GET api/v1/servicecenter/repairgroups?serviceCenterNumber={serviceCenterNumber}&activeOnly={activeOnly}

Retrieves repair groups and product rates information for a given service center number

GET api/v1/servicecenter/repaircodes?serviceCenterNumber={serviceCenterNumber}

Retrieves repair group information for repair groups not associated with the given service center

POST api/v1/servicecenter/repairgroups

Creates a connection between a service center and a repair group

PUT api/v1/servicecenter/repairgroups

Updates repair group information

GET api/v1/servicecenter/zipcodes/{serviceCenterNumber}

Returns zip codes affiliated with the given service center

POST api/v1/servicecenter/zipcodes

Adds zip codes to a given service center

PUT api/v1/servicecenter/zipcodes

Deletes zip codes attached to a given service center

GET api/v1/servicecenter/manufacturers?searchType={searchType}&serviceCenterNumber={serviceCenterNumber}&firstLetterSearch={firstLetterSearch}&keywordSearch={keywordSearch}&pageNumber={pageNumber}&pageSize={pageSize}

Retrieves manufacturers according to parameters

GET api/v1/servicecenter/manufacturerscount?searchType={searchType}&serviceCenterNumber={serviceCenterNumber}&repairGroupCode={repairGroupCode}&firstLetterSearch={firstLetterSearch}&keywordSearch={keywordSearch}

Retrieves the number of manufacturers search criteria would return

GET api/v1/servicecenter/manufacturersauthorizations?serviceCenterNumber={serviceCenterNumber}&repairGroupCode={repairGroupCode}

Retrieves all manufacturers and their authorization status for a service center's repair group

POST api/v1/servicecenter/manufacturersauthorizations

Updates relationships between manufacturers and a given service center's repair groups

GET api/v1/servicecenter/ach/{serviceCenterNumber}

Returns ACH profile affiliated with the given service center

POST api/v1/servicecenter/ach

Adds an ACH profile to a service center

POST api/v1/servicecenter/deactivateach

Deactivate an ACH profile to a service center

POST api/v1/servicecenter/achemail

Sends an email to a service center's ACH Officer's email address to allow them to set up their ACH profile or reset their password

GET api/v1/servicecenter/search?valNum={valNum}&zip={zip}

Returns AS400 service center information pertinent to search criteria given

GET api/v1/servicecenter/search?valNum={valNum}&zip={zip}&isPreferServiceChange={isPreferServiceChange}&startDate={startDate}&endDate={endDate}&timePeriod={timePeriod}&searchWithServiceCenterId={searchWithServiceCenterId}

Returns Service Power service center information pertinent to search criteria given

RepairOrderSubStatus

Endpoint for updating a repair order's sub-status.

APIDescription
PUT api/v1/repairOrder/subStatus/update

Updates the sub-status for given repair order's sub-status.

Rate

Contorller for dealing with Rates

APIDescription
GET api/v1/rate/rates?DealerId={DealerId}&DealerName={DealerName}&ProgramName={ProgramName}&CoverageName={CoverageName}&Region={Region}&ProductName={ProductName}&PromoCode={PromoCode}&ManufacturerName={ManufacturerName}

Gets the rates

GET api/v1/rate/ratesdetails?DealerId={DealerId}&DealerName={DealerName}&ProgramName={ProgramName}&CoverageName={CoverageName}&Region={Region}&ProductName={ProductName}&PromoCode={PromoCode}&ManufacturerName={ManufacturerName}

Gets the rates with details

PlanSearch

API Controller used to look up summary plan information.

APIDescription
GET api/v1/PlanSearch/RO/{repairOrderNumber}

Gets a summary list of all plans for a given repair order number.

GET api/v1/PlanSearch/RO?serviceCenterNumbers[0]={serviceCenterNumbers[0]}&serviceCenterNumbers[1]={serviceCenterNumbers[1]}&startDate={startDate}&endDate={endDate}

PlanRegistration

Controller for registering plans

APIDescription
GET api/v1/planregistration/search

Get registration information given brand specific inputs

POST api/v1/planregistration/register

Register component and membership number

POST api/v1/planregistration/completeregistration

Complete registration for semi-registered plans

GET api/v1/planregistration/productsearch?membershipNumber={membershipNumber}&modelNumber={modelNumber}&manufacturerName={manufacturerName}

Search for manufacturer products valid for the given membership number

RepairOrder

controller for retrieving and updating repair orders

APIDescription
GET api/v1/repairorder/{id}?includeCalls={includeCalls}&includeRepairOrderDispatchRecords={includeRepairOrderDispatchRecords}

retrieves all repair orders for a given contract. If the master contract is given, all component repair orders are returned

GET api/v1/RepairOrderDetail?id={id}&payNum={payNum}&includeDispatchMethod={includeDispatchMethod}

Retrieve details for a specific repair order

GET api/v2/RepairOrderDetail?id={id}&payNum={payNum}&includeDispatchRecord={includeDispatchRecord}

Retrieve details for a specific repair order

GET api/v1/RoPaymentDetail?id={id}&payNum={payNum}

Retrieve payment details for a specific repair order

GET api/v1/RoApprovalDetail?id={id}&payNum={payNum}&withPartsList={withPartsList}

Retrieve parts and labor approval details for a specific repair order

POST api/v1/repairorder/deleteRo

deletes a repair order

POST api/v1/repairorder/dispatch

Dispatches RO using service power or AS400

PUT api/v1/repairorder/lossdate

Update Loss Date

POST api/v1/repairorder/addDeductibleBypass

Creates a Deductible Bypass

BillingInformation

The controller for retrieving billing information

APIDescription
GET api/v1/billinginformation?userId={userId}

Retrieve all of a user's billing information

GET api/v1/billinginformation?policyId={policyId}&includeAllPolicies={includeAllPolicies}

Retrieve all of a policy's billing information

ShippingLabel

controller for creating and retrieving shipping labels

APIDescription
POST api/v1/shippinglabel/create

create new shipping label for eligible repair order

POST api/v1/shippinglabel/sendemail

create new shipping label for eligible repair order

InventorySearch

APIDescription
GET api/v1/inventorySearch/{ModelNumber}/{Manufacturer}/{Color}/{Capacity}/{Carrier}?InventoryId={InventoryId}&SKU={SKU}&ModelName={ModelName}&InventoryReportTime={InventoryReportTime}&StartingUnitCount={StartingUnitCount}&UnitsInStock={UnitsInStock}&LastOutTimeStamp={LastOutTimeStamp}&IsExpired={IsExpired}&ItemDescription={ItemDescription}&MatchDeviations={MatchDeviations}&IsRefurbished={IsRefurbished}

No documentation available.

Manufacturer

Controller for retrieving information about a manufacturers

APIDescription
GET api/v2/manufacturer/getrecalls/{manufacturerId}/{productModel}

Gets all the OEM recalls for a given manufacturer and model.

GET api/v2/manufacturer/getrecalls?manufacturerId={manufacturerId}&productModel={productModel}

Gets all the OEM recalls for a given manufacturer and model.

GET api/v1/manufacturer/products

No documentation available.

ContractValidations

Controller for handling Contract Validations

APIDescription
GET api/v1/contractvalidations/{warrantyNumber}

Given a warranty number, retrieves the contractValidationsInfo

POST api/v1/contractvalidations/save

Saves Contract Validations