NEW API Management Portal

October 25,2021

Karmak has a new and improved APIM Portal with easier to use authentication and real time documentation to reduce errors.

All new APIs will be published within APIM.

If you are new to Unity and Karmak APIs, please head to portal.karmak.io to learn more.

Branch Departments

A GET API to query branch department details.

Field Definition Type
“BranchDepartmentID” Unique database identifier for the Branch/Department. int
“Name” Branch name. varchar(100)
“BranchID” Unique database identifier for the Branch. int
“BranchCode” Branch code identifier. varchar(10)
“DepartmentID” Unique database identifier for the Department. int
“Department” Department name. varchar(10)

METHOD GET

/frw/BranchDepartment

Sample Branch Department Response

{
	"BranchDepartmentID": 1083,
	"Name": "JBE8",
	"BranchID": 237,
	"BranchCode": "JBE8_11111",
	"DepartmentID": 3,
	"Department": "Parts"
}

Department API

A GET API to query department details.

Field Definition Type
“Department” Department identifier. varchar(10)
“Name” Department name. varchar(100)
“Department Type” Type of department; Account, Body Shop, L/R, Parts, Sales, or Service. varchar(50)
“Inactive” When set to TRUE, this field indicates that the department record is inactive (ie, no longer used or valid for entry); inactive departments will not appear in a selection list in applications. bit
“Add User” Username associated with the user who added the department record. varchar(20)
“Add Date” Date/time the department record was added. datetime
“Last Update User” Username associated with the user who last updated the department record. varchar(20)
“Last Update Date” Date/time the department record was last updated. datetime

METHOD GET

/frw/Department

 

Sample Department API Response

{
	"Department": "45",
	"Name": "parts",
	"Department Type": "Parts",
	"Inactive": false,
	"Add User": "Morgan",
	"Add Date": "2017-05-25T15:36:23.637",
	"Last Update User": "Morgan",
	"Last Update Date": "2017-05-25T15:36:23.637"
}