Reference


Reference Data Controller

APIDescription
GET reference/torques/all/{releaseDate}


***DEPRECATED*** - use reference/torques?date= instead

Returns an object that contains a list with their corresponding data for each of the following:
Bolts, BoltApplications, BoltGroups, BoltSizes, BoltThreadPerInches, BoltTypes,
Compressors, MeasurementUnits, TorqueLubrications, TorqueModifiers,TorqueNotes ,TorqueResults

GET reference/torques?date={date}


Returns an object that contains a list for all changes made to the torque database since the given date. Lists include:
Bolts, BoltApplications, BoltGroups, BoltSizes, BoltThreadPerInches, BoltTypes,
Compressors, MeasurementUnits, TorqueLubrications, TorqueModifiers,TorqueNotes ,TorqueResults

Cornerstone

APIDescription
GET cornerstone/transcripts?user_id={user_id}

No documentation available.

Partner

APIDescription
GET partners?customerNumber={customerNumber}&partnerTypes={partnerTypes}


Get a list of partners based of a customerNumber, and or potentially limit the types that come back in partnerTypes

ValveSearch

APIDescription
GET valvesearch/fields/valveplates/{companyId}

No documentation available.

GET valvesearch/fields/valveplatethickness/{companyId}

No documentation available.

GET valvesearch/fields/guideringliftwasherdimensions/{companyId}

No documentation available.

GET valvesearch/fields/platespringthickness/{companyId}

No documentation available.

GET valvesearch/fields/coilspringshapediameters/{companyId}

No documentation available.

GET valvesearch/fields/springwirediameters/{companyId}

No documentation available.

GET valvesearch/fields/springcolors/{companyId}

No documentation available.

GET valvesearch/seatguard/{companyId}?PartNumber={PartNumber}

No documentation available.

GET valvesearch/plate/{companyId}?PartNumber={PartNumber}&PlateMaterial={PlateMaterial}&Thickness={Thickness}&Size={Size}

No documentation available.

GET valvesearch/guideringliftwasher/{companyId}?Thickness={Thickness}&Size={Size}

No documentation available.

GET valvesearch/spring/{companyId}?PartNumber={PartNumber}&SpringPlateOrWireThickness={SpringPlateOrWireThickness}&SpringDiameter={SpringDiameter}&SpringColor={SpringColor}&Size={Size}&IsCoilSpring={IsCoilSpring}

No documentation available.

Authentication

APIDescription
POST authenticate/user

No documentation available.

POST authenticate/user/TermsAndConditions?userId={userId}

No documentation available.

POST authenticate/user/TermsAndConditions/{userId}

No documentation available.

GET authenticate/user/TermsAndConditions?userId={userId}


Used to retrieve the terms and condition record for the given user

GET authenticate/user/TermsAndConditions/{userId}


Used to retrieve the terms and condition record for the given user

POST authenticate/user/asc?environment={environment}


Used to retrieve appKey for use in Ariel Fleet Manager mobile application

POST authenticate/user/asc/{environment}


Used to retrieve appKey for use in Ariel Fleet Manager mobile application

POST authenticate/accesscode/verify

No documentation available.

POST authenticate/accesscode/resend

No documentation available.

POST authenticate/accesscode/send

No documentation available.

POST authenticate/log

No documentation available.

GET authenticate/validationcode/{userId}

No documentation available.

Customer

APIDescription
GET customer/orders/search?callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}


Fuzzy Search for Customer Sales Orders - used for completion suggestions on the search page

GET customer/orders/basic?callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}


Get Customer Sales Orders using Basic Data, the one to use when you know what you are looking for

GET customer/orders/basic/excel?callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}


Get Customer Sales Orders using Basic Data - returns data node only for use with Excel export

GET customer/orders/advanced?accountFlag={accountFlag}&frameType={frameType}&userField1={userField1}&userField2={userField2}&pendingRevisions={pendingRevisions}&weeksBeforeShipment={weeksBeforeShipment}&dueDateBegin={dueDateBegin}&dueDateEnd={dueDateEnd}&invoiceDateBegin={invoiceDateBegin}&invoiceDateEnd={invoiceDateEnd}&orderDateBegin={orderDateBegin}&orderDateEnd={orderDateEnd}&callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}


Get Customer Sales Orders using Advanced Data - can search with more filter combinations

GET customer/orders/advanced/excel?accountFlag={accountFlag}&frameType={frameType}&userField1={userField1}&userField2={userField2}&pendingRevisions={pendingRevisions}&weeksBeforeShipment={weeksBeforeShipment}&dueDateBegin={dueDateBegin}&dueDateEnd={dueDateEnd}&invoiceDateBegin={invoiceDateBegin}&invoiceDateEnd={invoiceDateEnd}&orderDateBegin={orderDateBegin}&orderDateEnd={orderDateEnd}&callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}


Get Customer Sales Orders using Advanced Data, returns data nodes only for use with Excel

GET customer/orders/{id}/runfile?type={type}&orderType={orderType}


Get Customer Orders Runfile

POST customer/order

No documentation available.

GET customer/crossreferences/{companyId}


Get all part Cross Reference records for Customer

GET customer/crossreference?arielPartNumber={arielPartNumber}&customerId={customerId}&customerPartDescription={customerPartDescription}&customerPartNumber={customerPartNumber}&reportFlag={reportFlag}


Create Customer part Cross Reference Record

PUT customer/crossreference


Update Customer Cross Reference Record

DELETE customer/crossreference


Deletes Customer Cross Reference Record

POST customer/contact/create

No documentation available.

PUT customer/contact/update

No documentation available.

DELETE customer/contact/delete

No documentation available.

GET customer/contact

No documentation available.

GET customer/shiptos/{companyId}

No documentation available.

GET customer/shipto/{id}/{companyId}


Returns a single ShipTo address for a company

PUT customer/shipto/{id}/{companyId}

No documentation available.

GET customer/sparepartsmultiplier/{fiscalYear}/{companyId}


Get SpareParts Multiplier for a Customer

GET customer/requestpurchasingaccess

No documentation available.

GET customer/multipliergroup?companyNumber={companyNumber}


Get the multiplier group for select company number

GET customer/multipliergroup/companylist?companyNumber={companyNumber}&multiplierGroup={multiplierGroup}


Get a list of companies that are attached to a multiplier group.

GET customer/newunit/shippingmethods/{companyId}

No documentation available.

POST customer/ncr/{companyId}

No documentation available.

GET customer/ncr/all/{companyId}

No documentation available.

GET customer/ncr/{ncrId}/{companyId}

No documentation available.

GET customer/accountteam/{companyId}

No documentation available.

GET customer/detail

No documentation available.

GET customer/territories/parts

No documentation available.

GET customer/territories/parts/all

No documentation available.

GET customer/{companyNumber}/moUsersInHierarchy


Get Members Only Users for companies in the users hierarchy

GET customer/users

No documentation available.

GET customer/purchasers

No documentation available.

Supplier

APIDescription
GET supplier/invoices/{invoiceType}/{companyId}


Get all invoices for a Supplier

GET supplier/invoices/{companyId}


Get all invoices for a Supplier

GET supplier/invoice?invoiceType={invoiceType}&invoiceId={invoiceId}&sortBy={sortBy}&vendorId={vendorId}&maxRecords={maxRecords}


Get Invoice By Id

GET supplier/invoice/{invoiceId}


Get Invoice By Id

GET supplier/forecast?forecastReportType={forecastReportType}&viewInBucketsOf={viewInBucketsOf}&sortBy={sortBy}&maxRecords={maxRecords}&vendorId={vendorId}


Get Forecast of part orders for a Supplier

GET supplier/forecast/excel?forecastReportType={forecastReportType}&viewInBucketsOf={viewInBucketsOf}&sortBy={sortBy}&maxRecords={maxRecords}&vendorId={vendorId}


Get Forecast for a Supplier, use with Excel

GET supplier/purchaseorders?vendor={vendor}&buyer={buyer}&purchaseOrder={purchaseOrder}&partNumber={partNumber}&status={status}&sortBy={sortBy}&maxRecords={maxRecords}


Get all purchase orders for a supplier

GET supplier/purchaseorders/lineitems?vendor={vendor}&buyer={buyer}&purchaseOrder={purchaseOrder}&partNumber={partNumber}&status={status}&sortBy={sortBy}&maxRecords={maxRecords}


Get purchase order line items

PUT supplier/purchaseorders/lineitems/update


Update purchase order line items

PUT supplier/purchaseorders/lineitems/update/arieldates


Update all Ariel Acknowledge Dates to the same as Vendor Acknowledge Dates

PUT supplier/purchaseorders/lineitems/update/vendordates


Update all Vendor Acknowledge Dates to the same as Ariel Acknowledge Dates and set status = 'Confirmed'

GET supplier/advshippingnotifications?vendorId={vendorId}&asnNumber={asnNumber}&selectDate={selectDate}&maxRecords={maxRecords}


Get all Advanced Shipping Notices for a Supplier

GET supplier/advshippingnotification/{id}/{companyId}


Get an Advanced Shipping Notice By Id

GET suppliers?supplierListType={supplierListType}


Get a list of suppliers and their IDs

GET supplier/inventory/transactions?reportType={reportType}&arielPartNumber={arielPartNumber}&vendorPartNumber={vendorPartNumber}&workOrPurchaseOrder={workOrPurchaseOrder}&startDate={startDate}&endDate={endDate}&maxRecords={maxRecords}&vendorId={vendorId}

No documentation available.

GET supplier/crossreference/suppliers

No documentation available.

GET supplier/crossreference/changesforvendor/{companyId}

No documentation available.

PUT supplier/crossreference/changesforariel/{companyId}

No documentation available.

GET supplier/crossreference/vendorpendingchanges/{companyId}?showDenied={showDenied}

No documentation available.

PUT supplier/crossreference/vendorpendingchanges/{companyId}

No documentation available.

GET supplier/crossreference/vendormaterials/{companyId}?ArielPartNumber={ArielPartNumber}&SupplierPartNumber={SupplierPartNumber}&ReportType={ReportType}&SortCode={SortCode}&Disposition={Disposition}

No documentation available.

GET supplier/purchaseorder/ontime?reportType={reportType}&vendorId={vendorId}

No documentation available.

GET supplier/purchaseorder/ontime/detail?reportType={reportType}&weekOf={weekOf}&vendorId={vendorId}

No documentation available.

GET suppliers/purchasers


Get a list of purchasers

GET suppliers/quality/reports

No documentation available.

GET suppliers/quality/report?vendorQualityReportId={vendorQualityReportId}

No documentation available.

ArielInternal

APIDescription
GET arielinternal/sparesnotify/pollquotes

No documentation available.

GET arielinternal/company/contacts?companyId={companyId}&ektronId={ektronId}

No documentation available.

GET arielinternal/employee/getmydetails

No documentation available.

GET arielinternal/email/isofinalapproval?contentId={contentId}


Create a queue job to send email for ISO Final Approval

POST arielinternal/opportunities/notes


Create opportunity notes in SAP

Databook

APIDescription
GET databook/cylinderdata

No documentation available.

GET databook/framedata

No documentation available.

GET databook/valvedata/{cylinderFrameId}

No documentation available.

GET databook/legacy/cylinderdata

No documentation available.

GET databook/legacy/framedata

No documentation available.

GET databook/legacy/valvedata

No documentation available.

UrlShortener

APIDescription
GET UrlShortener/link?key={key}

No documentation available.

Employees


Employee Master API

APIDescription
GET employees/{id}


Get Active Employee By Id

GET employee/PTO/history


Get Logged in Employees PTO History

GET employee


Get employee data for currently logged-in user

GET employees/buyers


Get Buyers

POST employees/benefits/fsa


Inserts new Flexible Spending Account Election Record into the database

GET employees/benefits/fsa


Get Flexible Spending Account Election by Employee Id

GET employees/benefits/fsa/all


Get all existing Flexible Spending Account Election(s)

GET employees/benefits/fsa/allocatedamount


Get the current allowable FSA Election amount

GET employees/benefits/fsa/summaryofbenefits


Get the current allowable FSA Election amount

DELETE employees/benefits/fsa


Delete Flexible Spending Account Election by Employee Id

Utilities

APIDescription
GET utilities/user

GET utilities/user/companies

No documentation available.

GET utilities/companies/distributor

No documentation available.

GET utilities/companies/vendor

No documentation available.

GET utilities/excelexportest

No documentation available.

GET utilities/excelexport

No documentation available.

POST utilities/excelexport

No documentation available.

GET utilities/countries

No documentation available.

GET utilities/regions/{countryKey}

No documentation available.

GET utilities/regions?country={country}

No documentation available.

GET utilities/users/{companyId}

No documentation available.

GET utilities/purchasers/{companyId}

No documentation available.

GET utilities/shipcarriers?companyId={companyId}

No documentation available.

GET utilities/validateaddress?Street={Street}&City={City}&Region={Region}&PostalCode={PostalCode}&CountryCode={CountryCode}

No documentation available.

GET utilities/user/performance/validate?pcAccessCode={pcAccessCode}&pKey={pKey}&pVersion={pVersion}


Will be used by the performance program to validate user purchasing rights, and to trap some information for future use.

GET utilities/user/validate


Currently used by the performance program to return an ArielLoginResponse, and wether or not a user has ValidPurchasing rights.

GET utilities/queuemanager/status?queueId={queueId}&payloads={payloads}


Use the queue id to get the status of a job, completion / payloads etc...

POST utilities/arielsmartcompressor/requestaccess

No documentation available.

GET utilities/user/authenticated


Returns either an authenticated user or a guest user for the performance program.

GET utilities/user/distributor?companyID={companyID}&apiVersion={apiVersion}

No documentation available.

GET utilities/user/verification?userName={userName}

No documentation available.

GET utilities/user/companies/all

No documentation available.

GET utilities/companies

No documentation available.

GET utilities/companies/{companyTypeId}

No documentation available.

GET utilities/companies/{companyId}/users?externalId={externalId}

No documentation available.

GET afm/companies/{externalCompanyId}/users

No documentation available.

GET utilities/users/{filter}

No documentation available.

GET utilities/owrdropdowns/{dropDownType}

No documentation available.

GET utilities/hydrotestusers

No documentation available.

GET utilities/users/validateforpasswordchange?param1={param1}

No documentation available.

Material

APIDescription
GET material/groups/{companyId}

No documentation available.

GET material/search/{companyId}

No documentation available.

GET materialLookup/{partNumber}?includeAvailability={includeAvailability}&companyId={companyId}

No documentation available.

GET material/{partNumber}/lineage?companyId={companyId}

No documentation available.

GET material/bom/{partNumber}?bomDate={bomDate}&companyId={companyId}

No documentation available.

GET material/whereused/{partNumber}?companyId={companyId}

No documentation available.

GET material/multiwhereused/{partNumbers}?companyId={companyId}

No documentation available.

GET material/drawing/{partNumber}?companyId={companyId}


Returns drawing for given partNumber

GET material/drawing/kits/{partNumber}?companyId={companyId}


Returns drawing for given partNumber

Equipment

APIDescription
GET equipment?dataPrimaryKey={dataPrimaryKey}&search={search}&searchType={searchType}&retrieveBOMData={retrieveBOMData}


Retrieves as-built equipment information and returns it formatted for use with the compressor center

GET equipment/runfile/{id}


This is currently a dummy call, it was setup to serve a request that was not necessary

GET equipment/compressordiagram?dataPrimaryKey={dataPrimaryKey}&search={search}&searchType={searchType}&retrieveBOMData={retrieveBOMData}


Get the object structure used for the Compressor Center / Spare Parts System Diagram

GET equipment/recommendedspares/preliminary


Get preliminary recommended spares

GET aftermarket/search/serialnumber?searchString={searchString}&customerHierarchy={customerHierarchy}&soldToCustomerNumber={soldToCustomerNumber}&secondaryPackager={secondaryPackager}&startDate={startDate}&endDate={endDate}


Search Input/Output by SerialNumber

GET aftermarket/search/ordernumber?searchString={searchString}&customerHierarchy={customerHierarchy}&soldToCustomerNumber={soldToCustomerNumber}&secondaryPackager={secondaryPackager}&startDate={startDate}&endDate={endDate}


Search Input/Output by Order Number

GET aftermarket/search/purchaseordernumber?searchString={searchString}&customerHierarchy={customerHierarchy}&soldToCustomerNumber={soldToCustomerNumber}&secondaryPackager={secondaryPackager}&startDate={startDate}&endDate={endDate}


Search Input/Output by PurchaseOrderNumber

GET aftermarket/search/projectnumber?searchString={searchString}&customerHierarchy={customerHierarchy}&soldToCustomerNumber={soldToCustomerNumber}&secondaryPackager={secondaryPackager}&startDate={startDate}&endDate={endDate}


Search Input/Output by Project Number

GET aftermarket/search/projectname?searchString={searchString}&customerHierarchy={customerHierarchy}&soldToCustomerNumber={soldToCustomerNumber}&secondaryPackager={secondaryPackager}&startDate={startDate}&endDate={endDate}


Search Input/Output by Project Name

GET aftermarket/search/jobnumber?searchString={searchString}&customerHierarchy={customerHierarchy}&soldToCustomerNumber={soldToCustomerNumber}&secondaryPackager={secondaryPackager}&startDate={startDate}&endDate={endDate}


Search Input/Output by Job Number

GET aftermarket/{serialNumber}/history


Get the aftermarket history for a specific serial number

GET aftermarket/{serialNumber}/current?getHistory={getHistory}&getBOM={getBOM}


Get the current configuration for a specific serial number, with or without the aftermarket history
Added getHistory flag to speed up retrieval times for current configurations that have long history

GET aftermarket/current/{serialNumber}?getHistory={getHistory}&getBOM={getBOM}


Get the current configuration for a specific serial number, with or without the aftermarket history
Added getHistory flag to speed up retrieval times for current configurations that have long history

GET aftermarket/v2/{serialNumber}/current?getHistory={getHistory}&getBOM={getBOM}

No documentation available.

GET aftermarket/v2/current/{serialNumber}?getHistory={getHistory}&getBOM={getBOM}

No documentation available.

GET aftermarket/asbuilt/{serialNumber}?getBom={getBom}&getAsSoldEquipment={getAsSoldEquipment}&getCombinedData={getCombinedData}


This can be used to get the As Sold configuration for a serialnumber

GET aftermarket/{searchString}/asbuilt


This can be used to get the asbuilt information for either a Serial Number or a New Unit Order (NU000000)

GET aftermarket/{serialNumber}/{notificationId}


Get Aftermarket Notification by NotificationId for a specific serial number

GET aftermarket/asbuilt/search?searchString={searchString}&searchType={searchType}


Search Aftermarket As Built Notifications by passing in a search string, this could be a serial number or a new unit order number.

POST aftermarket/notification


Create Aftermarket Notification using a AftermarketNotifiationRequest object

POST aftermarket/notification/{queueChannel}


Create Aftermarket Notification using a AftermarketNotifiationRequest object, and a queueChannel (For Dev Purposes)

GET aftermarket/notification/{id}/runfile

No documentation available.

GET aftermarket/warranty/search?searchString={searchString}

No documentation available.

GET aftermarket/warranty/search?companyId={companyId}&year={year}&status={status}

No documentation available.

GET aftermarket/warranty/companies


Get distinct Company List for warranties out of the OWRReporting Table

GET aftermarket/warranty/chart?companyId={companyId}

No documentation available.

GET aftermarket/warranty/statistics?companyId={companyId}&year={year}

No documentation available.

GET aftermarket/warranty?serialNumber={serialNumber}

No documentation available.

GET aftermarket/warranty/print?serialNumber={serialNumber}

No documentation available.

POST aftermarket/warranty/complete

No documentation available.

POST aftermarket/warranty

No documentation available.

GET equipment/{equipmentType}/drawings/{equipmentId}


Get Equipment Drawings By Type

GET aftermarket/ariel7/notification/{serialNumber}?notificationId={notificationId}

No documentation available.

POST aftermarket/ariel7/submitdata?serialNumber={serialNumber}

No documentation available.

GET aftermarket/Ariel7/{serialNumber}?frameModel={frameModel}&isPackage={isPackage}

No documentation available.

POST aftermarket/ariel7/Post/{queueId}?confirmed={confirmed}

No documentation available.

GET aftermarket/equipment/notification/{serialNumber}?notificationId={notificationId}&includeRunFile={includeRunFile}

No documentation available.

GET aftermarket/equipment/notification/{salesOrderNumber}/asbuilt?includeRunFile={includeRunFile}

No documentation available.

GET aftermarket/equipment/{serialNumber}?frameModel={frameModel}&isPackage={isPackage}

No documentation available.

POST aftermarket/equipment/notifyequipmentchanges

No documentation available.

POST aftermarket/equipment/notifiction

No documentation available.

GET equipment/serialnumber/{orderNumber}

No documentation available.

POST equipment/ariel7/variantconfigurator

No documentation available.

GET equipment/outlinedrawings?drawingType={drawingType}&drawingListType={drawingListType}&drawingStatus={drawingStatus}&configurableMaterial={configurableMaterial}&effectivityDate={effectivityDate}&searchType={searchType}&searchString={searchString}&id={id}


Use Ariel.Integration security to make checks and call into the Outline Drawing API to return a List of Drawing Objects

GET equipment/outlinedrawings/download?drawingNumber={drawingNumber}&drawingFileType={drawingFileType}


Use Ariel.Integration security to perform authorization and call into the Outline Drawing API to execute a download of the specified drawing

TrainingVideos

APIDescription
GET TechTipVideos/data?date={date}&langCode={langCode}

GET TechTipVideos/link?key={key}&width={width}

GET TechTipVideos/shareData?videoId={videoId}

EventTransportation


Handles the routes for the event transportation API.

APIDescription
POST events/transportation/units


Create transportation unit.

POST events/transportation/users


Create a transportation user

DELETE events/transportation/units


Delete transportation units.

DELETE events/transportation/users/{id}


Delete transportation users by id(s)

GET events/transportation/units


Get all of the transportation units.

GET events/user/{employeeId}/transportation


Get employee and transportation unit information by logged in users ID.

GET events/workshifts


Get all employee work shifts

GET events/transportation/units/workshift/{workShiftId}


Get a transportation units by employee workshift ID.

GET events/transportation/units/{id}


Get a transportation unit by ID.

PUT events/transportation/units/{id}


Update transportation unit.

GET events/transportation/units/types


Get all transportation unit types

GET events/transportation/units/{id}/users


Get transportatin users by transportation unit ID.

PUT events/transportation/users/{id}


Update a transportation user

PartsApplication

APIDescription
GET partsapp/quotes/{companyId}


Get a list of quotes

GET partsapp/quotesearch/{companyId}?sortType={sortType}&sortOrder={sortOrder}&maxRecords={maxRecords}&recordTypes={recordTypes}&recSpares={recSpares}&quoteSearchType={quoteSearchType}&searchText={searchText}&validOnDate={validOnDate}&createdDateStart={createdDateStart}&createdDateEnd={createdDateEnd}&changedDateStart={changedDateStart}&changedDateEnd={changedDateEnd}&quoteStatus={quoteStatus}


Get a list of quotes

GET partsapp/latestquote/{companyId}

No documentation available.

GET partsapp/quote/copy/{id}/{companyId}

No documentation available.

GET partsapp/quote/{id}/{companyId}?returnAvailability={returnAvailability}


If quote id is -1, create a new quote, otherwise, return quote.

PUT partsapp/quote/{id}/{companyId}?returnAvailability={returnAvailability}


Edit a Quote Header

DELETE partsapp/quote/{id}/{companyId}


Delete a quote

PUT partsapp/quote/appendlines/{companyId}

No documentation available.

POST partsapp/quote/lines/{companyId}

No documentation available.

GET partsapp/lineitem/{companyId}?QuoteNumber={QuoteNumber}&PartNumber={PartNumber}&Quantity={Quantity}&SerialNumber={SerialNumber}&LineNumber={LineNumber}&CustomerPOLineNumber={CustomerPOLineNumber}&returnAvailability={returnAvailability}

No documentation available.

PUT partsapp/lineitem/{id}/{companyId}?returnAvailability={returnAvailability}

No documentation available.

PUT partsapp/EditLineItems/{companyId}

No documentation available.

DELETE partsapp/lineitems/{id}/{CompanyId}

No documentation available.

GET partsapp/alternatepart/{quoteNum}/{companyId}?lineNumber={lineNumber}&partNumber={partNumber}&materialEntered={materialEntered}&quantity={quantity}

No documentation available.

PUT partsapp/alternateparts/{quoteNum}/{companyId}

No documentation available.

PUT partsapp/recommenedparts/{quoteNum}/{companyId}

No documentation available.

GET partsapp/ordertypes/{companyId}

No documentation available.

GET partsapp/shipdata/{quoteNumber}/{companyId}

No documentation available.

PUT partsapp/shipdata/{quoteNumber}/{companyId}

No documentation available.

GET partsapp/validate/{quoteNumber}/{companyId}?validateHeader={validateHeader}&onlyCheckForSale={onlyCheckForSale}

No documentation available.

GET partsapp/converttoso/{quoteNumber}/{companyId}?orderType={orderType}&supressEmail={supressEmail}

No documentation available.

GET partsapp/setzp/{quoteNumber}/{companyId}

No documentation available.

GET partsapp/recommendedsparesquote/{companyId}

No documentation available.

GET partsapp/request/quotereview/{id}/{companyId}?requestNote={requestNote}

No documentation available.

GET partsapp/request/quotereviewcomplete/{id}/{companyId}?toMemberID={toMemberID}&requestNote={requestNote}

No documentation available.

GET partsapp/request/transferquoteto/{id}/{companyId}?transferToMemberID={transferToMemberID}&requestNote={requestNote}

No documentation available.

GET partsapp/request/transferquotefrom/{id}/{companyId}?transferFromMemberID={transferFromMemberID}&requestNote={requestNote}

No documentation available.

GET partsapp/request/transferquotetopurchaser/{id}/{companyId}?purchaserMemberID={purchaserMemberID}&requestNote={requestNote}

No documentation available.

GET partsapp/exportquote/{id}/{companyId}?recSparesData={recSparesData}&customMultiplier={customMultiplier}

No documentation available.

POST partsapp/shipto/requesttoadd

No documentation available.

DELETE partsapp/quote/{quoteId}/freightforwarder

No documentation available.

GET partsapp/maintenancebasedparts/createrequest/{queueId}

No documentation available.

GET partsapp/kitassembly?partNumber1={partNumber1}&partNumber2={partNumber2}&partNumber3={partNumber3}

No documentation available.

GET partsapp/parts/{partNumber}/availability

No documentation available.

DistributorException

APIDescription
GET distributorexceptions/fields?exceptionType={exceptionType}


Get list of distributor exceptions for distributor company of logged in user

GET distributorexceptions/fields/application-types

GET distributorexceptions/fields/distributor-presence-options

GET distributorexceptions/fields/current-company-relationship

GET distributorexceptions/fields/inventory-type

GET distributorexceptions/fields/customer-type-options

GET distributorexceptions/fields/exception-types

GET distributorexceptions


Get list of distributor exceptions for distributor company of logged in user

GET distributorexceptions/{id}

No documentation available.

POST distributorexceptions

POST distributorexceptions/runfile

GET distributorexceptions/runfile?sys_id={sys_id}

GET distributorexceptions/runfile/{sys_id}/{filename}

POST distributorexceptions/contractattachment

No documentation available.

GET distributorexceptions/contractattachment?sys_id={sys_id}

GET distributorexceptions/contractattachment/{sys_id}/{filename}

User

APIDescription
GET ektron/user/{id}


Get Ariel User Object By Ektron UserId

GET ektron/user/authenticate

No documentation available.

POST ektron/user

No documentation available.

TagReference


Tag Reference Controller

APIDescription
GET tr?serialNumber={serialNumber}&tagId={tagId}&tagDataId={tagDataId}&retrieveBOMData={retrieveBOMData}


Retrieves tag and URL information using tag Id or serial number

GET tr/equipment?serialNumber={serialNumber}&tagId={tagId}&tagDataId={tagDataId}&retrieveBOMData={retrieveBOMData}


Retrieves tag and URL information using tag Id or serial number - as-built configuration of equipment

GET tr/equipment/asbuilt?serialNumber={serialNumber}&tagId={tagId}&tagDataId={tagDataId}&retrieveBOMData={retrieveBOMData}


Retrieves tag and URL information using tag Id or serial number, as-built configuration of equipment

GET tr/equipment/current?serialNumber={serialNumber}&tagId={tagId}&tagDataId={tagDataId}&retrieveBOMData={retrieveBOMData}


Retrieves tag and URL information using tag Id or serial number, current configuration of equipment

PUT tr/verify


Validates reference between serial number and tag

GET tr/tagData?serialNumber={serialNumber}&tagId={tagId}&tagDataId={tagDataId}&retrieveBOMData={retrieveBOMData}


Gets tag reference, with no locations

PUT tr/location


Stores geo-location by serial number

PUT tr/initial


Stores TagReference record

DistributorFinder


DistributorFinderController

APIDescription
GET distributorFinder/locations


Retrieves all distributor branch locations from C4C

CompanyGoals

APIDescription
GET companygoals


Get a list of company goal records

GET companygoals/{id}


Get a single company goal record by ID

POST companygoals


Creates a company goals record

POST companygoals/{id}


Updates a company goals record by ID

Document


Produces PDF documents for various document types

APIDescription
GET document/orderack/am/{orderNumber}


Generate a PDF for an Aftermarket Order Acknowledgment

GET document/creditmemo/am/{invoiceNumber}


Generate a PDF for Parts RMA Credit Memo

GET document/rmaRequest/am/{rmaNumber}


Generate a PDF for Parts RMA Request

GET document/orderackestdelivery/am/{orderNumber}


Generate a PDF for an Aftermarket Order Estimated Delivery Acknowledgment

GET document/quoteack/am/{quoteNumber}


Generate a PDF for an Aftermarket Quote Acknowledgment

GET document/quoteack/cust/{pdfType}/{quoteNumber}/{customDiscount}


Generate a PDF for an Aftermarket Quote Acknowledgment

GET document/orderack/nu/{orderNumber}


Generate a PDF for a New Unit Order Acknowledgment

GET document/projectack/nu/{projectNumber}


Generate a PDF for a New Unit Project Acknowledgment

GET document/packslip/am/{documentNumber}


Generate a PDF for an Aftermarket Packing Slip

GET document/packslip/nu/{documentNumber}


Generate a PDF for a New Unit Packing Slip

GET document/invoice/am/{invoiceNumber}


Generate a PDF for an Aftermarket Customer Invoice

GET document/invoice/nu/{invoiceNumber}


Generate a PDF for a New Unit Customer Invoice

GET document/orders/basic/excel?callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}&reportName={reportName}

No documentation available.

GET document/orders/advanced/excel?accountFlag={accountFlag}&frameType={frameType}&userField1={userField1}&userField2={userField2}&pendingRevisions={pendingRevisions}&weeksBeforeShipment={weeksBeforeShipment}&dueDateBegin={dueDateBegin}&dueDateEnd={dueDateEnd}&invoiceDateBegin={invoiceDateBegin}&invoiceDateEnd={invoiceDateEnd}&orderDateBegin={orderDateBegin}&orderDateEnd={orderDateEnd}&callType={callType}&searchBy={searchBy}&searchText={searchText}&customerNumber={customerNumber}&maxRecords={maxRecords}&orderFlag={orderFlag}&orderStatus={orderStatus}&purchaser={purchaser}&orderType={orderType}&sortBy={sortBy}&ascendDescendFlag={ascendDescendFlag}&reportName={reportName}

No documentation available.

GET document/supplier/ontime/excel?reportType={reportType}&reportName={reportName}

No documentation available.

GET document/compressordocumentation?selectedPart={selectedPart}&searchString={searchString}


Retrieves list of Compressor Documentation File information formatted for use with the
Compressor Documentation Application.

GET document/compressordocumentation/directories


Retrieves a list of a Compressor Documentation file directories to allow for additional record filtering
when searching compressor documentation.

GET document/compressordocumentation/download?fileName={fileName}


Download a Compressor Documentation file from the appropriate file directory.

Torque

APIDescription
GET torque/engineeringReferenceDocuments


Gets a list of all Engineering Reference Document and their current revision

GET torque/compressors


Gets a list of all compressor models

GET torque/boltuses


Gets a list of all bolt uses/locations

GET torque/bolts


Gets a list of all bolts

GET torque/bolttypes


Gets a list of all bolt types

GET torque/notes


Gets a list of all notes

GET torque/lubrications


Gets a list of all lubricants used for fastener torques

GET torque/measurementunits


Gets a list of all measurement units

GET torque/torquemodifiers


Gets a list of all torque modifiers

GET torque/torqueresults


Gets a list of all composit torque results

GET torque/measurementconversions


Gets a list of all measurement conversion values

GET torque/engineeringchanges


Gets a list of all engineering changes

GET torque/unapproved/compressors


Gets a list of all compressors that have a pending change

GET torque/unapproved/boltuses


Gets a list of all bolt uses that have a pending change

GET torque/unapproved/bolts


Gets a list of all bolts that have a pending change

GET torque/unapproved/bolttypes


Gets a list of all bolt types that have a pending change

GET torque/unapproved/notes


Gets a list of all notes that have a pending change

GET torque/unapproved/lubrications


Gets a list of all lubricants that have a pending change

GET torque/unapproved/measurementunits


Gets a list of all measurement units that have a pending change

GET torque/unapproved/torqueresults


Gets a list of all composite torque results that have a pending change

GET torque/unapproved/measurementconversions


Gets a list of all measurement conversion values that have a pending change

POST torque/update/engineeringReferenceDocument?ecNumber={ecNumber}


If the compressor object passed in (comp) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/compressor?ecNumber={ecNumber}


If the compressor object passed in (comp) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/boltuse?ecNumber={ecNumber}


If the BoltUse object passed in (use) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/bolt?ecNumber={ecNumber}


If the Bolt object passed in (bolt) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/boltType?ecNumber={ecNumber}


If the BoltType object passed in (bt) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/note?ecNumber={ecNumber}


If the Note object passed in (note) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/measurementunit?ecNumber={ecNumber}


If the MeasurementUnit object passed in (mu) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/lubrication?ecNumber={ecNumber}


If the Lubrication object passed in (lube) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/torqueresult?ecNumber={ecNumber}


If the TorqueResult object passed in (tr) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/torqueresult/allframes?ecNumber={ecNumber}


Replicates the TorqueResult object passed in (tr) for all frames and inserts them all into the database

POST torque/update/measurementconversion?ecNumber={ecNumber}


If the MeasurementConversion object passed in (mc) already exists, the values will be updated in the database,
otherwise it will be newly inserted into the database.

POST torque/update/torqueresultlist?ecNumber={ecNumber}


Takes a list of TorqueResult objects and updates all of their changed values in the database

POST torque/reject/bolt


Rejects pending changes to the Bolt object that is passed in

POST torque/reject/boltuse


Rejects pending changes to the BoltUse object that is passed in

POST torque/reject/compressor


Rejects pending changes to the Compressor object that is passed in

POST torque/reject/lubrication


Rejects pending changes to the Lubrication object that is passed in

POST torque/reject/note


Rejects pending changes to the Note object that is passed in

POST torque/reject/torqueresult


Rejects pending changes to the TorqueResult object that is passed in

POST torque/reject/measurementconversion


Rejects pending changes to the MeasurementConversion object that is passed in

POST torque/rejectChanges


Rejects pending changes to all objects that are passed in

POST torque/delete/torqueresult?ecNumber={ecNumber}


Deletes the pending TorqueResult object that is passed in

POST torque/delete/bolttype?id={id}&ecNumber={ecNumber}


Deletes the BoltType object that is passed in

POST torque/approveChanges?erNumber={erNumber}


Approves pending changes to all objects that are passed in

POST torque/update/trerRelationships?trId={trId}


updates the ER document relationships for the given torque result