Rapid Apps Web API Help Page

Introduction

Rapid Apps API Services documentation.

ERP_AppInfo

Application Information Controller. It is not used currently anywhere in the application. Currently it is not authorized (unauthorized user can call it). If necessary [Authorize] and [RAAuthentication] should be added.

API	Description
GET api/ERP/AppInfo/PubLocation/{version}	Gets published location of ERP application

ERP_AppsData

Apps.Data Controller

API	Description
GET api/ERP/Apps/Data/GetAppDefaultValue?KeyName={KeyName}	Get app default value Key Name
GET api/ERP/Apps/Data/GetAppDefaultValues	Get app default value
GET api/ERP/Apps/Data/GetAppConfig	Get app default value

ERP_Authentication

This controller is used only to handle Sign out. Login is handled by Identity Server abd RAAuthenticate attribute (includin record in AppUserLog)

API	Description
GET api/ERP/Auth/Signout	Basically just logs the logout entry into AppUserLog. Actual logout happens when user is redirected to IdentityServer pages. When IdentityServer logouts the user the and invalidates the access token so it cannot be used anymore.

ERP_Jobs

DispatchJobs Controller

API	Description
GET api/ERP/Jobs/Jobs?JobDate={JobDate}&DispatchLocID={DispatchLocID}&Region={Region}&IncludeSubRegions={IncludeSubRegions}&WaitList={WaitList}	Gets jobs for specified parameters.
GET api/ERP/Jobs/Jobs?JobDate={JobDate}	Gets jobs for specified job date.
GET api/ERP/Jobs/Jobs	Gets jobs for current date.
GET api/ERP/Jobs/JobsByCanceledAndRange?FromDate={FromDate}&ToDate={ToDate}	Gets canceled jobs by date range.
POST api/ERP/Jobs/JobsByDateCrewTimelineOnly?JobDate={JobDate}	Gets jobs by date crew timeline.
POST api/ERP/Jobs/JobsByParams?CusID={CusID}&JobsiteID={JobsiteID}&EmpID={EmpID}&EqID={EqID}&LocID={LocID}&VenID={VenID}&FromDate={FromDate}&ToDate={ToDate}	Gets jobs for by specified paramters
GET api/ERP/Jobs/JobsByRange?FromDate={FromDate}&ToDate={ToDate}	Gets jobs by specified date range
POST api/ERP/Jobs/JobsByRangeForMonthlyCalendar?FromDate={FromDate}&ToDate={ToDate}	Gets jobs for monthly calendar by date range
GET api/ERP/Jobs/JobHistoryByJobID?JobID={JobID}	Gets history by job ID
GET api/ERP/Jobs/GetBillingAddressesCBX?JobID={JobID}	Gets history by job ID
GET api/ERP/Jobs/GetReasonsCBX	Gets history by job ID
GET api/ERP/Jobs/GetCurrentUser
POST api/ERP/Jobs/JobsMovedByJobDate?JobDate={JobDate}	Gets jobs by moved date
POST api/ERP/Jobs/JobUpdateJTPrinted?PourID={PourID}	Update Job Ticket Printed
DELETE api/ERP/Jobs/DeleteJob?JobID={JobID}	Delete specified job
GET api/ERP/Jobs/JobTypeByTypeID?TypeID={TypeID}	Gets JobType by TypeID
GET api/ERP/Jobs/GetAllSalesAgentsCBX/{salesAgentGid}	Gets all sales agents
GET api/ERP/Jobs/GetAllSalesRegionsCBX	Gets all sales agents
GET api/ERP/Jobs/GetPrelimitedListCBX	Gets all sales agents
GET api/ERP/Jobs/GetCrewTypeListCBX	Gets all crew types
GET api/ERP/Jobs/GetRoleTypeListCBX	Gets all role types
GET api/ERP/Jobs/GetAllDispatchersCBX	Gets all dispatchers
GET api/ERP/Jobs/GetAllEquipmentSizesCBX	Gets all equipment sizes
GET api/ERP/Jobs/GetAllJobTypesCBX	Gets all job types
GET api/ERP/Jobs/GetAllOperatorsCBX	Gets all operators
GET api/ERP/Jobs/GetAllDispatchLocationsCBX	Gets all dispatch locations
GET api/ERP/Jobs/GetAllYardsCBX	Gets all yard locations
GET api/ERP/Jobs/GetAllSpotProvidersCBX	Gets all spot providers
GET api/ERP/Jobs/GetJobInformationCBX	Gets all spot providers
GET api/ERP/Jobs/GetAllReportGroupsCBX	Gets all spot providers
GET api/ERP/Jobs/GetAllStatesCBX	Gets all spot providers
GET api/ERP/Jobs/GetAllCitiesCBX	Gets all spot providers
GET api/ERP/Jobs/GetJobStatusesCBX	Gets all spot providers
GET api/ERP/Jobs/GetAllSpecialFlagsCBX	Gets all spot providers
GET api/ERP/Jobs/GetAllJobsiteTypeCBX	Gets all spot providers
GET api/ERP/Jobs/GetDispatchLocationID?eqID={eqID}	Get dispatch location id
GET api/ERP/Jobs/GetCallerListCBX?cusID={cusID}	Get dispatch location id
GET api/ERP/Jobs/GetConfirmedListCBX?cusID={cusID}	Get dispatch location id
GET api/ERP/Jobs/GetDispatchLocation?locID={locID}	Get dispatch location name
GET api/ERP/Jobs/GetJobsRow?pourID={pourID}	Get jobs row
GET api/ERP/Jobs/GetYardName?yardID={yardID}	Get yard name
GET api/ERP/Jobs/GetJobsiteList?jobsiteID={jobsiteID}&WithJobs={WithJobs}&FromDate={FromDate}&ToDate={ToDate}&CusID={CusID}&JSStatus={JSStatus}&CusStatus={CusStatus}&SchemeID={SchemeID}&SalesAgentID={SalesAgentID}	Get jobsite list
GET api/ERP/Jobs/GetOperatorList?empID={empID}&typeID={typeID}	Get operator list
GET api/ERP/Jobs/GetJobCrewList?JobID={JobID}	Get job crew list
GET api/ERP/Jobs/GetEqCrewList?eqID={eqID}	Get job crew list
GET api/ERP/Jobs/GetJobCExtraSystemList?JobID={JobID}	Get job crew list
GET api/ERP/Jobs/DeleteJobCrewByJobID?JobID={JobID}	Delete job crew
GET api/ERP/Jobs/DeleteJobCrewByEmpID?JobID={JobID}&EmpID={EmpID}	Delete job crew member
GET api/ERP/Jobs/GetVerifyJobsiteRequestInfo?token={token}	Get the status and jobsite address of the verify request (status: ready to verify, verified, or unavailable - expired, etc).
GET api/ERP/Jobs/VerifyJobsite?clientID={clientID}&token={token}&latitude={latitude}&longitude={longitude}	Verify a jobsite's location.
GET api/ERP/Jobs/GetFleetList	Get fleet list
POST api/ERP/Jobs/ChangeInfo?JobID={JobID}&newInfo={newInfo}	Update Job Info
POST api/ERP/Jobs/ChangeStatus?jobID={jobID}&newStatus={newStatus}&statusMethod={statusMethod}&statusTime={statusTime}	Change Job Status
POST api/ERP/Jobs/AssignEquipment?jobID={jobID}&eqID={eqID}&operatorID={operatorID}&dispLocID={dispLocID}&empID={empID}	Assign Equipment
POST api/ERP/Jobs/AssignCrew?jobID={jobID}&empID={empID}&roleID={roleID}	Assign Crew
POST api/ERP/Jobs/ReassignJob?jobID={jobID}&eqID={eqID}	Reassign Job
POST api/ERP/Jobs/ChangeJobDate?jobID={jobID}&newJobDate={newJobDate}&empID={empID}	Change Job Date
GET api/ERP/Jobs/UpdateTimeDuration?jobID={jobID}&jobTime={jobTime}&clearTime={clearTime}&empID={empID}	Update Time Duration
GET api/ERP/Jobs/UpdateMultiDayTimeRange?jobID={jobID}&jobDate={jobDate}&endDate={endDate}&empID={empID}	Update MultiDay Time Range
GET api/ERP/Jobs/GetCurrentCulture	No documentation available.
GET api/ERP/Jobs/GetDailyNotes?selectedDate={selectedDate}	Get Daily Notes
GET api/ERP/Jobs/SaveDailyNotes?selectedDate={selectedDate}&notes={notes}	Save Daily Notes
GET api/ERP/Jobs/UpdateCrewNotified?jobID={jobID}&empID={empID}	Update Crew Notified
GET api/ERP/Jobs/UpdateCrewAcknowledgment?jobID={jobID}&empID={empID}	Update Crew Acknowledgment
GET api/ERP/Jobs/DeleteJob?jobID={jobID}	Delete Job
GET api/ERP/Jobs/GetJobSiteID?jobID={jobID}	Get JobSite ID
GET api/ERP/Jobs/GetEquipmentList	Get equipment list
GET api/ERP/Jobs/GetJobByID?jobID={jobID}	Get Job Info
GET api/ERP/Jobs/GetEmployees?typeID={typeID}	Get Employees
GET api/ERP/Jobs/GetAllEmployeesWithAllCBX	Get Employees
GET api/ERP/Jobs/GetJobsite?jobID={jobID}	Get Jobsite
GET api/ERP/Jobs/GetJobsiteJobHistory?jobsiteID={jobsiteID}	Get Jobsite Job History
GET api/ERP/Jobs/GetPrelimHistory?jobsiteID={jobsiteID}	Get Jobsite Job History
GET api/ERP/Jobs/GetJobsiteCbo?jobID={jobID}	Get Jobsite Cbo Listing Data
GET api/ERP/Jobs/GetReadyMix	Get ReadyMix Vendors
GET api/ERP/Jobs/GetPricingSchemes	Get Pricing Schemes
POST api/ERP/Jobs/UpdateJob	Update Job data
POST api/ERP/Jobs/CancelJob	Update Job data
POST api/ERP/Jobs/SaveMultibook?jobID={jobID}	Update Job data
POST api/ERP/Jobs/UpdateJobSite	No documentation available.
GET api/ERP/Jobs/GetCompany?companyID={companyID}	Get Company
GET api/ERP/Jobs/GetLineItemList	Get list of Line Items
POST api/ERP/Jobs/SaveJobGridState	No documentation available.
GET api/ERP/Jobs/GetJobGridState	No documentation available.
GET api/ERP_Jobs?customerID={customerID}&isInactive={isInactive}	Get list of Line Items

ERP_SalesData

Sales.Data Controller

API	Description
GET api/ERP/Sales/Data/GetCustomerList	Get customer list
GET api/ERP/Sales/Data/GetCustomer?customerID={customerID}	Get customer list
GET api/ERP/Sales/Data/DeleteCustomer?cusID={cusID}	Delete Customer