Entities and Endpoints
Abstract Crosstable
| API | Description |
|---|---|
| GET api/AbstractCrosstable |
Retrieves all |
| GET api/AbstractCrosstable(id) |
Retrieves with the specified key |
| POST api/AbstractCrosstable |
Creates a new |
Application Version
| API | Description |
|---|---|
| POST api/ApplicationVersion/GetApplicationVersionInfo |
No documentation available. |
| POST api/ApplicationVersion/GetLatestApplicationVersion |
No documentation available. |
| POST api/ApplicationVersion/AddUpdateApplicationVersion |
No documentation available. |
Article
Articles (=products, parts, materials). Used for Sales and Services
| API | Description |
|---|---|
| GET api/Article |
Retrieves all the articles |
| GET api/Article(id) |
Retrieves the article with the specified key |
Article Category
| API | Description |
|---|---|
| GET api/ArticleCategory |
No documentation available. |
| GET api/ArticleCategory(id) |
No documentation available. |
Article Discount
| API | Description |
|---|---|
| GET api/ArticleDiscount |
No documentation available. |
| GET api/ArticleDiscount(id) |
No documentation available. |
Article Group
| API | Description |
|---|---|
| GET api/ArticleGroup |
No documentation available. |
| GET api/ArticleGroup(id) |
No documentation available. |
Article Group Cache
| API | Description |
|---|---|
| GET api/ArticleGroupCache |
No documentation available. |
| GET api/ArticleGroupCache(id) |
No documentation available. |
Article No Warranty Reason
| API | Description |
|---|---|
| GET api/ArticleNoWarrantyReason |
No documentation available. |
| GET api/ArticleNoWarrantyReason(id) |
No documentation available. |
Article Price Label
| API | Description |
|---|---|
| GET api/ArticlePriceLabel |
No documentation available. |
| GET api/ArticlePriceLabel(id) |
No documentation available. |
Article Price List
| API | Description |
|---|---|
| GET api/ArticlePriceList |
No documentation available. |
| GET api/ArticlePriceList(id) |
No documentation available. |
Article Status
| API | Description |
|---|---|
| GET api/ArticleStatus |
Retrieves all article_status |
| GET api/ArticleStatus(id) |
Retrieves the article_status with the specified key |
Article Status List
| API | Description |
|---|---|
| GET api/ArticleStatusList |
Retrieves all article_status_list |
| GET api/ArticleStatusList(id) |
Retrieves the article_status_list with the specified key |
Article Stock Location
Article Stock Location (if you are working with different stock location and not a central stock (article.physical_stock)
| API | Description |
|---|---|
| GET api/ArticleStockLocation |
Retrieves all the article stock location |
| GET api/ArticleStockLocation(id) |
Retrieves the article stock location with the specified key |
Article Stock Location List
Article Stock Location List (stock value for this stock for this article)
| API | Description |
|---|---|
| GET api/ArticleStockLocationList |
Retrieves all the article stock location lists |
| GET api/ArticleStockLocationList(id) |
Retrieves the article stock location list with the specified key |
Article Stock Location Serial
Article Stock Location Serial (Serial part for this stock for this article)
| API | Description |
|---|---|
| GET api/ArticleStockLocationSerial |
No documentation available. |
| GET api/ArticleStockLocationSerial(id) |
No documentation available. |
| PUT api/ArticleStockLocationSerial(id) |
No documentation available. |
Article Translate
| API | Description |
|---|---|
| GET api/ArticleTranslate |
Cannot get by id because id is dymanic |
Car
Cars (If you whish to store the car travel)
| API | Description |
|---|---|
| POST api/Car/Save |
Saves a car |
| GET api/Car |
Retrieves all the cars |
| GET api/Car(id) |
Retrieves a car with the specified key |
| PUT api/Car(id) |
Updates the car with the specified key |
Car Travel
Car Travel. Used to place car travel
| API | Description |
|---|---|
| POST api/CarTravel/Save |
Save car_travel |
| GET api/CarTravel |
Retrieves all the car travels |
| GET api/CarTravel(id) |
Retrieves a car travel with the specified key |
| POST api/CarTravel |
Creates a new car travel |
Car Travel V2
Car Travel. Used to place car travel
| API | Description |
|---|---|
| POST api/CarTravelV2/Save |
Save car_travel |
| GET api/CarTravelV2 |
Retrieves all the car travels |
| GET api/CarTravelV2(id) |
Retrieves a car travel with the specified key |
| POST api/CarTravelV2 |
Creates a new car travel |
| PUT api/CarTravelV2(id) |
Updates the car travel with the specified key |
| DELETE api/CarTravelV2(id) |
Deletes the car_travel object with the specified key |
Communication
| API | Description |
|---|---|
| GET api/Communication |
No documentation available. |
| GET api/Communication(id) |
No documentation available. |
Company
| API | Description |
|---|---|
| GET api/Company/GetBySalesTerritory |
No documentation available. |
| GET api/Company/GetDataRelatedToCompany |
No documentation available. |
| POST api/Company/Save |
Add/update company |
| POST api/Company/GetControllerDataStatus |
Check if controllers have new data of a company or not |
| GET api/Company |
No documentation available. |
| GET api/Company(id) |
No documentation available. |
| POST api/Company |
No documentation available. |
| PUT api/Company(id) |
No documentation available. |
Company Account
Used to link company to more than one territory (main territory is on company.sales_territory_id)
| API | Description |
|---|---|
| GET api/CompanyAccount |
Retrieves all the company_account objects |
| GET api/CompanyAccount(id) |
Retrieves the company_account object with the specified key |
Company Calendar
| API | Description |
|---|---|
| GET api/CompanyCalendar |
No documentation available. |
| GET api/CompanyCalendar(id) |
No documentation available. |
Company Calendar Type
| API | Description |
|---|---|
| GET api/CompanyCalendarType |
No documentation available. |
| GET api/CompanyCalendarType(id) |
No documentation available. |
Company Contact
Company contact
| API | Description |
|---|---|
| POST api/CompanyContact/Save |
Save company_contact |
| GET api/CompanyContact |
Retrieves all the company contact |
| GET api/CompanyContact(id) |
Retrieves the company contact with the specified key |
| POST api/CompanyContact |
Creates a new company contact object |
| DELETE api/CompanyContact(id) |
Deletes the company contact with the specified key |
Company Discount Family
| API | Description |
|---|---|
| GET api/CompanyDiscountFamily |
No documentation available. |
| GET api/CompanyDiscountFamily(id) |
No documentation available. |
Company Sales Status
| API | Description |
|---|---|
| GET api/CompanySalesStatus |
No documentation available. |
| GET api/CompanySalesStatus(id) |
No documentation available. |
Company Sales Territory List
Used to link company to more than one territory (main territory is on company.sales_territory_id)
| API | Description |
|---|---|
| GET api/CompanySalesTerritoryList |
Retrieves all the company_sales_territory_list objects |
| GET api/CompanySalesTerritoryList(id) |
Retrieves the company_sales_territory_list object with the specified key |
Company Type
| API | Description |
|---|---|
| GET api/CompanyType |
No documentation available. |
| GET api/CompanyType(id) |
No documentation available. |
Company V2
| API | Description |
|---|---|
| POST api/CompanyV2/Save |
Add/update company |
| POST api/CompanyV2/GetControllerDataStatus |
Check if controllers have new data of a company or not |
| GET api/CompanyV2 |
No documentation available. |
| GET api/CompanyV2(id) |
No documentation available. |
| POST api/CompanyV2 |
No documentation available. |
| PUT api/CompanyV2(id) |
No documentation available. |
Company Vat
| API | Description |
|---|---|
| GET api/CompanyVat |
No documentation available. |
| GET api/CompanyVat(id) |
No documentation available. |
Contact
| API | Description |
|---|---|
| POST api/Contact/Save |
Add/update contact |
| GET api/Contact |
No documentation available. |
| GET api/Contact(id) |
No documentation available. |
| POST api/Contact |
No documentation available. |
| PUT api/Contact(id) |
No documentation available. |
Contract
Contract
| API | Description |
|---|---|
| GET api/Contract |
Retrieves all the contracts |
| GET api/Contract(id) |
Retrieves the Contract with the specified key |
Contract Discount
Contract discount
| API | Description |
|---|---|
| GET api/ContractDiscount |
Retrieves all contract discount |
| GET api/ContractDiscount(id) |
Retrieves the contract discount with the specified key |
Contract Discount Article
contract discount article article
| API | Description |
|---|---|
| GET api/ContractDiscountArticle |
Retrieves all contract discount article |
| GET api/ContractDiscountArticle(id) |
Retrieves the contract discount article with the specified key |
Contract Discount Feelist Price
Contract discount feelist price
| API | Description |
|---|---|
| GET api/ContractDiscountFeelistPrice |
Retrieves all contract discount feelist price |
| GET api/ContractDiscountFeelistPrice(id) |
Retrieves the contract discount feelist price with the specified key |
Contract Type
Contract type
| API | Description |
|---|---|
| GET api/ContractType |
Retrieves all contract type |
| GET api/ContractType(id) |
Retrieves the contract type with the specified key |
Country
| API | Description |
|---|---|
| GET api/Country |
No documentation available. |
| GET api/Country(id) |
No documentation available. |
Db Address Company
| API | Description |
|---|---|
| POST api/DbAddressCompany/Save |
Add/update db_address_company |
| GET api/DbAddressCompany |
No documentation available. |
| GET api/DbAddressCompany(id) |
No documentation available. |
| POST api/DbAddressCompany |
No documentation available. |
| PUT api/DbAddressCompany(id) |
No documentation available. |
Db Address Sales Organization
| API | Description |
|---|---|
| GET api/DbAddressSalesOrganization |
No documentation available. |
| GET api/DbAddressSalesOrganization(id) |
No documentation available. |
Db Address Type
| API | Description |
|---|---|
| GET api/DbAddressType |
No documentation available. |
| GET api/DbAddressType(id) |
No documentation available. |
Db Address User Unavailability
| API | Description |
|---|---|
| POST api/DbAddressUserUnavailability/Save |
Add/update db_address_user_unavailability |
| GET api/DbAddressUserUnavailability |
No documentation available. |
| GET api/DbAddressUserUnavailability(id) |
No documentation available. |
| POST api/DbAddressUserUnavailability |
No documentation available. |
| PUT api/DbAddressUserUnavailability(id) |
No documentation available. |
Db File
| API | Description |
|---|---|
| GET api/DbFile/GetFileContent/{id}?maxHeight={maxHeight}&maxWidth={maxWidth} |
Get the content of the file |
| POST api/DbFile/Save |
Add/update db_file |
| GET api/DbFile |
No documentation available. |
| GET api/DbFile(id) |
No documentation available. |
| POST api/DbFile |
No documentation available. |
| PUT api/DbFile(id) |
No documentation available. |
| DELETE api/DbFile(id) |
No documentation available. |
Db File Tag
| API | Description |
|---|---|
| GET api/DbFileTag |
No documentation available. |
| GET api/DbFileTag(id) |
No documentation available. |
Db File Tag List
| API | Description |
|---|---|
| POST api/DbFileTagList/Save |
Save db_file_tag_list |
| GET api/DbFileTagList |
No documentation available. |
| GET api/DbFileTagList(id) |
No documentation available. |
| POST api/DbFileTagList |
No documentation available. |
Db File V2
Files of other kind of objects (exclude job, task)
| API | Description |
|---|---|
| GET api/DbFileV2/GetFileContent/{id}?maxHeight={maxHeight}&maxWidth={maxWidth} |
Get the content of the file |
| POST api/DbFileV2/Save |
Add/update db_file |
| GET api/DbFileV2 |
No documentation available. |
| GET api/DbFileV2(id) |
No documentation available. |
| POST api/DbFileV2 |
No documentation available. |
| PUT api/DbFileV2(id) |
No documentation available. |
| DELETE api/DbFileV2(id) |
No documentation available. |
Db Functionbis
| API | Description |
|---|---|
| GET api/DbFunctionbis |
Retrieves all functionbis |
| GET api/DbFunctionbis(id) |
Retrieves functionbis with the specified key |
Db Info
Chapters of the info fields (See "Info Fields" help guide for more information)
| API | Description |
|---|---|
| GET api/DbInfo |
Retrieves all objects db_info that belongs to a static category (like Company,Project,...) |
| GET api/DbInfo(id) |
Retrieves an object of the specified key if belongs to a static category (like Company,Project,...) |
Db Info Category
| API | Description |
|---|---|
| GET api/DbInfoCategory |
No documentation available. |
| GET api/DbInfoCategory(id) |
No documentation available. |
Db Info Category List
| API | Description |
|---|---|
| GET api/DbInfoCategoryList |
No documentation available. |
| GET api/DbInfoCategoryList(id) |
No documentation available. |
Db Info Data Article
Data of the info fields belongs to Article
| API | Description |
|---|---|
| POST api/DbInfoDataArticle/Save |
Saves the object that belongs to category Article |
| GET api/DbInfoDataArticle |
Retrieves all objects db_info_data that belongs to category Article |
| GET api/DbInfoDataArticle(id) |
Retrieves an object of the specified key if belongs to category Article |
| POST api/DbInfoDataArticle |
Creates a new object that belongs to category Article |
| PUT api/DbInfoDataArticle(id) |
Updates the modifications done on the object that belongs to category Article |
Db Info Data Company
Data of the info fields belongs to Company
| API | Description |
|---|---|
| POST api/DbInfoDataCompany/Save |
Saves the object that belongs to category Company |
| GET api/DbInfoDataCompany |
Retrieves all objects db_info_data that belongs to category Company |
| GET api/DbInfoDataCompany(id) |
Retrieves an object of the specified key if belongs to category Company |
| POST api/DbInfoDataCompany |
Creates a new object that belongs to category Company |
| PUT api/DbInfoDataCompany(id) |
Updates the modifications done on the object that belongs to category Company |
Db Info Data Db Report
Data of the info fields belongs to DbReport
| API | Description |
|---|---|
| POST api/DbInfoDataDbReport/Save |
Saves the object that belongs to category DbReport |
| POST api/DbInfoDataDbReport/SaveMultiple |
Add/Update multiple db_info_data |
| GET api/DbInfoDataDbReport |
Retrieves all objects db_info_data that belongs to category DbReport |
| GET api/DbInfoDataDbReport(id) |
Retrieves an object of the specified key if belongs to category DbReport |
| POST api/DbInfoDataDbReport |
Creates a new object that belongs to category DbReport |
| PUT api/DbInfoDataDbReport(id) |
Updates the modifications done on the object that belongs to category DbReport |
| DELETE api/DbInfoDataDbReport(id) |
Deletes the object of the specified key |
Db Info Data Jobs
Data of the info fields belongs to Jobs
| API | Description |
|---|---|
| POST api/DbInfoDataJobs/Save |
Saves the object that belongs to category Jobs |
| GET api/DbInfoDataJobs |
Retrieves all objects db_info_data that belongs to category Jobs |
| GET api/DbInfoDataJobs(id) |
Retrieves an object of the specified key if belongs to category Jobs |
| POST api/DbInfoDataJobs |
Creates a new object that belongs to category Jobs |
| PUT api/DbInfoDataJobs(id) |
Updates the modifications done on the object that belongs to category Jobs |
Db Info Data Project
Data of the info fields belongs to Project
| API | Description |
|---|---|
| POST api/DbInfoDataProject/Save |
Saves the object that belongs to category Project |
| GET api/DbInfoDataProject |
Retrieves all objects db_info_data that belongs to category Project |
| GET api/DbInfoDataProject(id) |
Retrieves an object of the specified key if belongs to category Project |
| POST api/DbInfoDataProject |
Creates a new object that belongs to category Project |
| PUT api/DbInfoDataProject(id) |
Updates the modifications done on the object that belongs to category Project |
Db Info Data Task
Data of the info fields belongs to Task
| API | Description |
|---|---|
| POST api/DbInfoDataTask/Save |
Saves the object that belongs to category Task |
| GET api/DbInfoDataTask |
Retrieves all objects db_info_data that belongs to category Task |
| GET api/DbInfoDataTask(id) |
Retrieves an object of the specified key if belongs to category Task |
| POST api/DbInfoDataTask |
Creates a new object that belongs to category Task |
| PUT api/DbInfoDataTask(id) |
Updates the modifications done on the object that belongs to category Task |
Db Info Data User
Data of the info fields belongs to User
| API | Description |
|---|---|
| POST api/DbInfoDataUser/Save |
Saves the object that belongs to category User |
| GET api/DbInfoDataUser |
Retrieves all objects db_info_data that belongs to category User |
| GET api/DbInfoDataUser(id) |
Retrieves an object of the specified key if belongs to category User |
| POST api/DbInfoDataUser |
Creates a new object that belongs to category User |
| PUT api/DbInfoDataUser(id) |
Updates the modifications done on the object that belongs to category User |
Db Info Field
Info fields (See "Info Fields" help guide for more information)
| API | Description |
|---|---|
| GET api/DbInfoField |
Retrieves all items |
| GET api/DbInfoField(id) |
Retrieves the item with the specified key |
Db Info Field Property
Items for certain types of info fields (like ComboBox,SelectBox or RadioButton - See "Info Fields" help guide for more information)
| API | Description |
|---|---|
| GET api/DbInfoFieldProperty |
Retrieves all items |
| GET api/DbInfoFieldProperty(id) |
Retrieves the item with the specified key |
Db Notes
| API | Description |
|---|---|
| POST api/DbNotes/Save |
Add/update db_notes |
| GET api/DbNotes |
No documentation available. |
| GET api/DbNotes(id) |
No documentation available. |
| POST api/DbNotes |
No documentation available. |
| PUT api/DbNotes(id) |
No documentation available. |
| DELETE api/DbNotes(id) |
No documentation available. |
Db Payment Methods
| API | Description |
|---|---|
| GET api/DbPaymentMethods |
No documentation available. |
| GET api/DbPaymentMethods(id) |
No documentation available. |
Db Report
Reports (based on InfoField system) used on WorkOrderReport and Visit Report (See "Db Report" help guide for more information)
| API | Description |
|---|---|
| POST api/DbReport/Save |
Add/update db_report |
| GET api/DbReport |
Retrieves all db Reports |
| GET api/DbReport(id) |
Retrieves the db report with the specified key |
| POST api/DbReport |
Creates a new db report |
| PUT api/DbReport(id) |
Updates the db report with the specified key |
| DELETE api/DbReport(id) |
Deletes the db report with the specified key |
Db Report Type
| API | Description |
|---|---|
| GET api/DbReportType |
Retrieves all db Reports type |
| GET api/DbReportType(id) |
Retrieves the db report type with the specified key |
Db Signature
| API | Description |
|---|---|
| POST api/DbSignature/Save |
No documentation available. |
| GET api/DbSignature |
No documentation available. |
| GET api/DbSignature(id) |
No documentation available. |
| POST api/DbSignature |
No documentation available. |
| PUT api/DbSignature(id) |
No documentation available. |
| DELETE api/DbSignature(id) |
No documentation available. |
Db Status List
Db Status: describe the link between two statues of a master table (job, task, order,...etc)
| API | Description |
|---|---|
| GET api/DbStatusList |
No documentation available. |
| GET api/DbStatusList(id) |
No documentation available. |
Db Title
| API | Description |
|---|---|
| GET api/DbTitle |
No documentation available. |
| GET api/DbTitle(id) |
No documentation available. |
Db Translate
Countries using ISO 3166
| API | Description |
|---|---|
| GET api/DbTranslate |
Retrieves all db_translate |
| GET api/DbTranslate(id) |
Retrieves the db_translate with the specified key |
Db Unit Of Measure
| API | Description |
|---|---|
| GET api/DbUnitOfMeasure |
Retrieves all db_unit_of_measure |
| GET api/DbUnitOfMeasure(id) |
Retrieves the db_unit_of_measure with the specified key |
Deleted Items
| API | Description |
|---|---|
| GET api/DeletedItems |
No documentation available. |
Device
| API | Description |
|---|---|
| POST api/Device/SaveDeviceInfo |
No documentation available. |
| POST api/Device/UpdateArchivedDevice |
Updating archived device via id or device_id of device table |
| POST api/Device/GetArchivedStatus |
Updating archived device via id or device_id of device table |
| POST api/Device/Save |
No documentation available. |
Email Notification
| API | Description |
|---|---|
| POST api/EmailNotification/Save |
No documentation available. |
| POST api/EmailNotification |
No documentation available. |
Equipment Brand
Equipment Brand
| API | Description |
|---|---|
| GET api/EquipmentBrand |
Retrieves all the equipment_brand objects |
| GET api/EquipmentBrand(id) |
Retrieves the equipment_brand object with the specified key |
Equipment Family
Equipment Family
| API | Description |
|---|---|
| GET api/EquipmentFamily |
Retrieves all the equipment_family objects |
| GET api/EquipmentFamily(id) |
Retrieves the equipment_family object with the specified key |
Equipment Family Skill List
| API | Description |
|---|---|
| GET api/EquipmentFamilySkillList |
Retrieves all equipment_family_skill_list |
| GET api/EquipmentFamilySkillList(id) |
Retrieves the equipment_family_skill_list with the specified key |
Equipment Model
Equipment Model
| API | Description |
|---|---|
| GET api/EquipmentModel |
Retrieves all the equipment_model objects |
| GET api/EquipmentModel(id) |
Retrieves the equipment_model object with the specified key |
Error Log
| API | Description |
|---|---|
| POST api/ErrorLog |
No documentation available. |
Fee List
FeeList (Services). Used to configure the price for invoicable timesheets
| API | Description |
|---|---|
| GET api/FeeList |
Retrieves all the fee lists |
| GET api/FeeList(id) |
Retrieves the fee list with the specified key |
Fee List Price
FeeList Price (Services). Contains the Matrix of price (rules) for invoicable timesheets
| API | Description |
|---|---|
| GET api/FeeListPrice |
Retrieves all the fee list prices |
| GET api/FeeListPrice(id) |
Retrieves the fee list price with the specified key |
Gps Log
| API | Description |
|---|---|
| POST api/GpsLog/AddMultiple |
No documentation available. |
| POST api/GpsLog |
No documentation available. |
Holiday
| API | Description |
|---|---|
| GET api/Holiday |
No documentation available. |
| GET api/Holiday(id) |
No documentation available. |
Hour Type
Hour Type. Used by CarTravel/UserTimesheet to generate the invoicable timesheets (Job Non Part Usage)
| API | Description |
|---|---|
| GET api/HourType |
Retrieves all the hour_type objects |
| GET api/HourType(id) |
Retrieves the hour_type object with the specified key |
Job Approval
Contains all information about the Dialy or full work order approvals
| API | Description |
|---|---|
| POST api/JobApproval/Save |
Add/update job_approval |
| POST api/JobApproval/SaveJobApprovalJobApprovalList |
Add/Update job_approval and its job_approval_list |
| GET api/JobApproval |
Retrieves all the job approvals |
| GET api/JobApproval(id) |
Retrieves the job approval with the specified key |
| POST api/JobApproval |
Creates a new job approval |
| PUT api/JobApproval(id) |
Updates the job approval with the specified key |
| DELETE api/JobApproval(id) |
Deletes the job approval with the specified key |
Job Approval List
| API | Description |
|---|---|
| POST api/JobApprovalList/Save |
Save job_approval_list |
| GET api/JobApprovalList(id) |
No documentation available. |
| POST api/JobApprovalList |
No documentation available. |
| PUT api/JobApprovalList(id) |
No documentation available. |
Job Contact
| API | Description |
|---|---|
| GET api/JobContact |
Retrieves all job_contact |
| GET api/JobContact(id) |
Retrieves the job_contact with the specified key |
Job Dispatch Log
| API | Description |
|---|---|
| POST api/JobDispatchLog/Save |
Add/update job_dispatch_log |
| GET api/JobDispatchLog/Accept?jobs_id={jobs_id}&user_id={user_id}&date_planned={date_planned}&estimated_time={estimated_time} |
Accept a dispatched job |
| GET api/JobDispatchLog/AcceptDispatch?jobs_id={jobs_id}&new_job_status_id={new_job_status_id}&user_id={user_id}&date_planned={date_planned}&estimated_time={estimated_time} |
No documentation available. |
| GET api/JobDispatchLog/AcceptWorkshop?jobs_id={jobs_id}&user_id={user_id} |
Accept a workshop |
| GET api/JobDispatchLog/AcceptTechnicalCompletion?jobs_id={jobs_id}&user_id={user_id} |
Accept a Technical Completion |
| GET api/JobDispatchLog |
Retrieves all the work job_dispatch_logs |
| GET api/JobDispatchLog(id) |
Retrieves the work job_dispatch_log with the specified key |
| POST api/JobDispatchLog |
Creates a new work job_dispatch_log |
| PUT api/JobDispatchLog(id) |
Updates the work job_dispatch_log with the specified key |
Job Estimated Quantity
Estimation of parts that should be used during a work order (including quantities)
| API | Description |
|---|---|
| GET api/JobEstimatedQuantity |
Retrieves all the job_estimated_quantity objects |
| GET api/JobEstimatedQuantity(id) |
Retrieves the job_estimated_quantity with the specified key |
Job Files
Files of jobs
| API | Description |
|---|---|
| GET api/JobFiles/GetFileContent/{id}?maxHeight={maxHeight}&maxWidth={maxWidth} |
Get the content of the file |
| POST api/JobFiles/Save |
Add/update db_file |
| GET api/JobFiles |
No documentation available. |
| GET api/JobFiles(id) |
No documentation available. |
| POST api/JobFiles |
No documentation available. |
| PUT api/JobFiles(id) |
No documentation available. |
| DELETE api/JobFiles(id) |
No documentation available. |
Job Measurement
| API | Description |
|---|---|
| POST api/JobMeasurement/Save |
No documentation available. |
| GET api/JobMeasurement |
No documentation available. |
| GET api/JobMeasurement(id) |
No documentation available. |
| POST api/JobMeasurement |
No documentation available. |
| PUT api/JobMeasurement(id) |
No documentation available. |
| DELETE api/JobMeasurement(id) |
No documentation available. |
Job Measurement Details
| API | Description |
|---|---|
| POST api/JobMeasurementDetails/Save |
No documentation available. |
| GET api/JobMeasurementDetails |
No documentation available. |
| GET api/JobMeasurementDetails(id) |
No documentation available. |
| POST api/JobMeasurementDetails |
No documentation available. |
| PUT api/JobMeasurementDetails(id) |
No documentation available. |
| DELETE api/JobMeasurementDetails(id) |
No documentation available. |
Job Non Part Usage
Invoicable timesheets and car travels for a work order
| API | Description |
|---|---|
| POST api/JobNonPartUsage/Save |
Save job_non_part_usage |
| GET api/JobNonPartUsage |
Retrieves all the job_non_part_usage objects |
| GET api/JobNonPartUsage(id) |
Retrieves the job_non_part_usage object with the specified key |
| POST api/JobNonPartUsage |
Creates a new job_non_part_usage object |
| PUT api/JobNonPartUsage(id) |
Updates the job_non_part_usage object with the specified key |
| DELETE api/JobNonPartUsage(id) |
Deletes the job_non_part_usage object with the specified key |
Job Part Usage
Parts (=article, materials) used to complete the work order
| API | Description |
|---|---|
| POST api/JobPartUsage/Save |
Add/update job_part_usage |
| GET api/JobPartUsage |
Retrieves all used parts |
| GET api/JobPartUsage(id) |
Retrieves the used part with the specified key |
| POST api/JobPartUsage |
Creates a new job part usage object |
| PUT api/JobPartUsage(id) |
Updates used part with the specified key |
| DELETE api/JobPartUsage(id) |
Deletes the used part with the specified key |
Job Planning
| API | Description |
|---|---|
| POST api/JobPlanning/Save |
Add/update job_planning |
| GET api/JobPlanning/FieldAccept?accept={accept}&job_planning_id={job_planning_id} |
No documentation available. |
| GET api/JobPlanning |
Retrieves all the work job_plannings |
| GET api/JobPlanning(id) |
Retrieves the work job_planning with the specified key |
| POST api/JobPlanning |
Creates a new work job_planning |
| PUT api/JobPlanning(id) |
Updates the work job_planning with the specified key |
Job Priority
Priorities (High, Critical, low) used to describe work orders
| API | Description |
|---|---|
| GET api/JobPriority |
Retrieves all the job_priority objects |
| GET api/JobPriority(id) |
Retrieves the job_priority object with the specified key |
Jobs
Work orders Main object
| API | Description |
|---|---|
| POST api/Jobs/Save |
Add/update jobs |
| GET api/Jobs/PlanAgainFromTask?task_id={task_id}&task_status_id={task_status_id}&job_status_id={job_status_id} |
No documentation available. |
| GET api/Jobs/PlanAgainWO?job_id={job_id}&job_status_id={job_status_id} |
No documentation available. |
| POST api/Jobs/GetControllerDataStatus |
No documentation available. |
| GET api/Jobs |
Retrieves all the work orders |
| GET api/Jobs(id) |
Retrieves the work order with the specified key |
| POST api/Jobs |
Creates a new work order |
| PUT api/Jobs(id) |
Updates the work order with the specified key |
Job Status
Work order Types (E.g. Maintenance, Intervention, inspection)
| API | Description |
|---|---|
| GET api/JobStatus |
Retrieves all work order types |
| GET api/JobStatus(id) |
Retrieves the work order type with the specified key |
Job Status List
Work order Status: describe the link between two statues
| API | Description |
|---|---|
| GET api/JobStatusList |
No documentation available. |
| GET api/JobStatusList(id) |
No documentation available. |
Job Type
Work order Types (E.g. Maintenance, Intervention, inspection)
| API | Description |
|---|---|
| GET api/JobType |
Retrieves all work order types |
| GET api/JobType(id) |
Retrieves the work order type with the specified key |
Job Type Skill List
| API | Description |
|---|---|
| GET api/JobTypeSkillList |
Retrieves all job_type_skill_list |
| GET api/JobTypeSkillList(id) |
Retrieves the job_type_skill_list with the specified key |
Job Work Instruction
Job work instruction
| API | Description |
|---|---|
| POST api/JobWorkInstruction/Save |
Save job_work_instruction |
| GET api/JobWorkInstruction |
Retrieves all job work instruction |
| GET api/JobWorkInstruction(id) |
Retrieves the job work instruction with the specified key |
| POST api/JobWorkInstruction |
Creates a new job work instruction |
| DELETE api/JobWorkInstruction(id) |
Deletes the job work instruction with the specified key |
Job Work Instruction Details
Job work instruction details
| API | Description |
|---|---|
| POST api/JobWorkInstructionDetails/AddUpdateMultiple |
Add/Update multiple job work instruction details |
| POST api/JobWorkInstructionDetails/SaveMultiple |
Add/Update multiple job work instruction details |
| POST api/JobWorkInstructionDetails/Save |
No documentation available. |
| GET api/JobWorkInstructionDetails |
Retrieves all job work instruction details |
| GET api/JobWorkInstructionDetails(id) |
Retrieves the job work instruction details with the specified key |
| POST api/JobWorkInstructionDetails |
Creates a new job work instruction details |
| PUT api/JobWorkInstructionDetails(id) |
Updates the job work instruction details with the specified key |
| DELETE api/JobWorkInstructionDetails(id) |
Deletes the job work instruction details with the specified key |
Job Work Instruction List
Job work instruction list
| API | Description |
|---|---|
| POST api/JobWorkInstructionList/AddMultiple |
Add/Update multiple job work instructions |
| POST api/JobWorkInstructionList/SaveMultiple |
Add/Update multiple job work instructions |
| POST api/JobWorkInstructionList/Save |
No documentation available. |
| GET api/JobWorkInstructionList |
Retrieves all job work instructions |
| GET api/JobWorkInstructionList(id) |
Retrieves the job work instruction with the specified key |
| POST api/JobWorkInstructionList |
Creates a new job work instruction |
| PUT api/JobWorkInstructionList(id) |
Updates the job work instruction with the specified key |
| DELETE api/JobWorkInstructionList(id) |
Deletes the job work instruction with the specified key |
Language
Language (used in company, contact, user) using ISO 639-1
| API | Description |
|---|---|
| GET api/Language |
Retrieves all languages |
| GET api/Language(id) |
Retrieves the language with the specified key |
Licence Group
| API | Description |
|---|---|
| GET api/LicenceGroup |
Retrieves all licence_group |
| GET api/LicenceGroup(id) |
Retrieves the licence_group with the specified key |
Licence Group User Right List
| API | Description |
|---|---|
| GET api/LicenceGroupUserRightList |
Retrieves all licence_group_user_right_list |
| GET api/LicenceGroupUserRightList(id) |
Retrieves the licence_group_user_right_list with the specified key |
Marketing Segment
| API | Description |
|---|---|
| GET api/MarketingSegment |
No documentation available. |
| GET api/MarketingSegment(id) |
No documentation available. |
Measurement Type
| API | Description |
|---|---|
| GET api/MeasurementType |
No documentation available. |
| GET api/MeasurementType(id) |
No documentation available. |
Meeting
| API | Description |
|---|---|
| POST api/Meeting/Save |
No documentation available. |
| GET api/Meeting |
No documentation available. |
| GET api/Meeting(id) |
No documentation available. |
| POST api/Meeting |
No documentation available. |
| PUT api/Meeting(id) |
No documentation available. |
Meeting Type
| API | Description |
|---|---|
| GET api/MeetingType |
No documentation available. |
Pdf Template
Pdf template
| API | Description |
|---|---|
| GET api/PdfTemplate |
Retrieves all pdf template |
| GET api/PdfTemplate(id) |
Retrieves the pdf template with the specified key |
Project
Projects (Equipments, Installation)
| API | Description |
|---|---|
| POST api/Project/Save |
Add/update project |
| GET api/Project/HasActiveJobs/{id} |
Check project has active jobs or not before closing (FSA-2796) |
| GET api/Project |
Retrieves all the projects |
| GET api/Project(id) |
Retrieves the project with the specified key |
| POST api/Project |
Creates a new project |
| PUT api/Project(id) |
Updates the project with the specified key |
Project Bill Of Material
Bill of material (BOM)
| API | Description |
|---|---|
| GET api/ProjectBillOfMaterial |
Retrieves BOM |
| GET api/ProjectBillOfMaterial(id) |
Retrieves BOM with the specified key |
Project Contact
Project contacts
| API | Description |
|---|---|
| POST api/ProjectContact/Save |
Add/update project_contact |
| GET api/ProjectContact |
Retrieves project contacts |
| GET api/ProjectContact(id) |
Retrieves the project contact with the specified key |
| POST api/ProjectContact |
Creates a new project contact |
| PUT api/ProjectContact(id) |
Updates the project contact with the specified key |
| DELETE api/ProjectContact(id) |
Deletes the project contact with the specified key |
Project Status
Project Statuses. (E.g. Set up, in production, out of order)
| API | Description |
|---|---|
| GET api/ProjectStatus |
Retrieves project statuses |
| GET api/ProjectStatus(id) |
Retrieves the project status with the specified key |
Purchase Order
Purchase Order header of articles on Work orders
| API | Description |
|---|---|
| GET api/PurchaseOrder |
Retrieves all the purchase orders |
| GET api/PurchaseOrder(id) |
Retrieves the purchase order with the specified key |
Purchase Order Details
Order lines of the Purchase orders
| API | Description |
|---|---|
| GET api/PurchaseOrderDetails |
Retrieves all the purchase order order lines |
| GET api/PurchaseOrderDetails(id) |
Retrieves the purchase order order lines with the specified key |
Recurrence
Recurrence
| API | Description |
|---|---|
| POST api/Recurrence/Save |
Saves a recurrence |
| GET api/Recurrence |
Retrieves all recurrences |
| GET api/Recurrence(id) |
Retrieves the recurrence with the specified key |
Sales Organization
Sales / Service Organizations
| API | Description |
|---|---|
| GET api/SalesOrganization |
Retrieves all organizations |
| GET api/SalesOrganization(id) |
Retrieves organization with the specified key |
Sales Territory
| API | Description |
|---|---|
| GET api/SalesTerritory |
No documentation available. |
| GET api/SalesTerritory(id) |
No documentation available. |
Service Model
Contains the information of all the service model
| API | Description |
|---|---|
| GET api/ServiceModel |
Retrieves all service_model |
| GET api/ServiceModel(id) |
Retrieves the service_model with the specified key |
Service Model Project List
Contains the information of all sla
| API | Description |
|---|---|
| GET api/ServiceModelProjectList |
Retrieves all service_model_project_list |
| GET api/ServiceModelProjectList(id) |
Retrieves the service_model_project_list with the specified key |
Service Model Sla
Contains the information of all sla
| API | Description |
|---|---|
| GET api/ServiceModelSla |
Retrieves all service_model_sla |
| GET api/ServiceModelSla(id) |
Retrieves the service_model_sla with the specified key |
Settings
| API | Description |
|---|---|
| POST api/Settings/GetSettingByCode |
No documentation available. |
| POST api/Settings/Save |
No documentation available. |
| GET api/Settings |
No documentation available. |
| GET api/Settings(id) |
No documentation available. |
| POST api/Settings |
No documentation available. |
| PUT api/Settings(id) |
No documentation available. |
Skill
Skills, can be required to perform a Work order. Users can have 0 to N skills.
| API | Description |
|---|---|
| GET api/Skill |
Retrieves all skills |
| GET api/Skill(id) |
Retrieves the skill with the specified key |
Stat Cockpit
| API | Description |
|---|---|
| GET api/StatCockpit |
Retrieves all stat_cockpit |
| GET api/StatCockpit(id) |
Retrieves the stat_cockpit with the specified key |
Sync Log
| API | Description |
|---|---|
| POST api/SyncLog |
No documentation available. |
Sync Logs
| API | Description |
|---|---|
| POST api/SyncLogs/AddSyncLogs |
No documentation available. |
| POST api/SyncLogs/Save |
No documentation available. |
| GET api/SyncLogs |
No documentation available. |
| GET api/SyncLogs(id) |
No documentation available. |
| POST api/SyncLogs |
No documentation available. |
| PUT api/SyncLogs(id) |
No documentation available. |
| DELETE api/SyncLogs(id) |
No documentation available. |
Sys Debugdata
| API | Description |
|---|---|
| GET api/SysDebugdata/GetSysDebugdataUncompleted?device_id={device_id} |
No documentation available. |
| GET api/SysDebugdata/GetSysDebugdataCompleted?device_id={device_id} |
No documentation available. |
| POST api/SysDebugdata/SetSysDebugDataCompleted |
No documentation available. |
| GET api/SysDebugdata/GetQueries?sys_debugdata_id={sys_debugdata_id} |
No documentation available. |
| POST api/SysDebugdata/SetQueryCompleted |
No documentation available. |
| GET api/SysDebugdata/GetResults?sys_debugdata_query_id={sys_debugdata_query_id}&modified_dateutc={modified_dateutc}&top={top} |
No documentation available. |
| POST api/SysDebugdata/AddResult |
No documentation available. |
| POST api/SysDebugdata/AddResultsMultiple |
No documentation available. |
System
Task
Task. Used for Sales and Services
| API | Description |
|---|---|
| POST api/Task/Save |
Add/update task |
| GET api/Task |
Retrieves all the tasks |
| GET api/Task(id) |
Retrieves the task with the specified key |
| POST api/Task |
Creates a new task |
| PUT api/Task(id) |
Updates the task with the specified key |
Task Activity
Task Activity. Used for Sales and Services
| API | Description |
|---|---|
| GET api/TaskActivity |
Retrieves all the task_activities |
| GET api/TaskActivity(id) |
Retrieves the task_activity with the specified key |
Task Activity Log
Task Activity Log. Used for Sales and Services
| API | Description |
|---|---|
| POST api/TaskActivityLog/Save |
Add/update task_activity_log |
| GET api/TaskActivityLog |
Retrieves all the task_activity_logs |
| GET api/TaskActivityLog(id) |
Retrieves the task_activity_log with the specified key |
| POST api/TaskActivityLog |
Creates a new task_activity_log |
| PUT api/TaskActivityLog(id) |
Updates the task_activity_log with the specified key |
Task Files
Files of tasks
| API | Description |
|---|---|
| GET api/TaskFiles/GetFileContent/{id}?maxHeight={maxHeight}&maxWidth={maxWidth} |
Get the content of the file |
| POST api/TaskFiles/Save |
Add/update db_file |
| GET api/TaskFiles |
No documentation available. |
| GET api/TaskFiles(id) |
No documentation available. |
| POST api/TaskFiles |
No documentation available. |
| PUT api/TaskFiles(id) |
No documentation available. |
| DELETE api/TaskFiles(id) |
No documentation available. |
Task Priority
Task Priorities (E.g. Low,Medium,High,Urgent)
| API | Description |
|---|---|
| GET api/TaskPriority |
Retrieves all task priorities |
| GET api/TaskPriority(id) |
Retrieves the task priority with the specified key |
Task Status
Task Status (E.g. InProgress,Closed)
| API | Description |
|---|---|
| GET api/TaskStatus |
Retrieves all task status |
| GET api/TaskStatus(id) |
Retrieves the task status with the specified key |
Task Type
Task Types (E.g. Call, Prepare Document)
| API | Description |
|---|---|
| GET api/TaskType |
Retrieves all task types |
| GET api/TaskType(id) |
Retrieves the task type with the specified key |
Usage Tracking
| API | Description |
|---|---|
| POST api/UsageTracking/AddMultiple |
No documentation available. |
User
| API | Description |
|---|---|
| GET api/User |
No documentation available. |
| GET api/User(id) |
No documentation available. |
| PUT api/User(id) |
No documentation available. |
User Group
User Group
| API | Description |
|---|---|
| GET api/UserGroup |
Retrieves all user_group |
| GET api/UserGroup(id) |
Retrieves the user_group with the specified key |
User Planning Slot
User Planning Slot
| API | Description |
|---|---|
| GET api/UserPlanningSlot |
Retrieves all user planning slot |
| GET api/UserPlanningSlot(id) |
Retrieves the user planning slot with the specified key |
User Planning Slot Type
User Planning Slot Type
| API | Description |
|---|---|
| GET api/UserPlanningSlotType |
Retrieves all user planning slot type |
| GET api/UserPlanningSlotType(id) |
Retrieves the user planning slot type with the specified key |
User Right List
| API | Description |
|---|---|
| POST api/UserRightList/SaveUserRightList |
No documentation available. |
| GET api/UserRightList |
No documentation available. |
| GET api/UserRightList(id) |
No documentation available. |
User Sales Organization List
Used to link users to Organization
| API | Description |
|---|---|
| GET api/UserSalesOrganizationList |
Retrieves all the user_sales_organization_list objects |
| GET api/UserSalesOrganizationList(id) |
Retrieves the user_sales_organization_list object with the specified key |
User Sales Territory List
| API | Description |
|---|---|
| GET api/UserSalesTerritoryList |
No documentation available. |
| GET api/UserSalesTerritoryList(id) |
No documentation available. |
User Skill List
Used to link users to skills
| API | Description |
|---|---|
| GET api/UserSkillList |
Retrieves all the user_skill_list objects |
| GET api/UserSkillList(id) |
Retrieves the user_skill_list object with the specified key |
User Team
| API | Description |
|---|---|
| GET api/UserTeam |
Retrieves all user_team |
| GET api/UserTeam(id) |
Retrieves the user_team with the specified key |
User Timesheet
User timesheet
| API | Description |
|---|---|
| POST api/UserTimesheet/Save |
Save user timesheet |
| GET api/UserTimesheet |
Retrieves all the user timesheet |
| GET api/UserTimesheet(id) |
Retrieves a user timesheet with the specified key |
| POST api/UserTimesheet |
Creates a new user timesheet |
User Timesheet V2
User timesheet
| API | Description |
|---|---|
| POST api/UserTimesheetV2/Save |
Save user timesheet |
| GET api/UserTimesheetV2 |
Retrieves all the user timesheet |
| GET api/UserTimesheetV2(id) |
Retrieves a user timesheet with the specified key |
| POST api/UserTimesheetV2 |
Creates a new user timesheet |
| PUT api/UserTimesheetV2(id) |
Updates the user timesheet with the specified key |
| DELETE api/UserTimesheetV2(id) |
Deletes the user timesheet object with the specified key |
User Unavailability
User Unavailabilities (ill, holidays,...)
| API | Description |
|---|---|
| POST api/UserUnavailability/Save |
Saves a unavailability |
| GET api/UserUnavailability |
Retrieves all unavailabilities |
| GET api/UserUnavailability(id) |
Retrieves the unavailability with the specified key |
User Unavailability Type
Types of user unavailabilities
| API | Description |
|---|---|
| GET api/UserUnavailabilityType |
Retrieves all unavailability types |
| GET api/UserUnavailabilityType(id) |
Retrieves the unavailability type with the specified key |
Work Instruction
Work order Types (E.g. Maintenance, Intervention, inspection)
| API | Description |
|---|---|
| GET api/WorkInstruction |
Retrieves all work instruction |
| GET api/WorkInstruction(id) |
Retrieves the work instruction with the specified key |
Work Instruction Action Type
Work instruction action type
| API | Description |
|---|---|
| GET api/WorkInstructionActionType |
Retrieves all work instruction action type |
| GET api/WorkInstructionActionType(id) |
Retrieves the work instruction action type with the specified key |
Work Instruction Details
Work instruction details
| API | Description |
|---|---|
| GET api/WorkInstructionDetails |
Retrieves all work instruction details |
| GET api/WorkInstructionDetails(id) |
Retrieves the work instruction details with the specified key |
Work Instruction Skill List
| API | Description |
|---|---|
| GET api/WorkInstructionSkillList |
Retrieves all work_instruction_skill_list |
| GET api/WorkInstructionSkillList(id) |
Retrieves the work_instruction_skill_list with the specified key |
Work Instruction Type
Work instruction type
| API | Description |
|---|---|
| GET api/WorkInstructionType |
Retrieves all work instruction type |
| GET api/WorkInstructionType(id) |
Retrieves the work instruction type with the specified key |
Work Instruction Type Options
work instruction type options
| API | Description |
|---|---|
| GET api/WorkInstructionTypeOptions |
Retrieves all work instruction type options |
| GET api/WorkInstructionTypeOptions(id) |
Retrieves the work instruction type options with the specified key |