JobOperations - SmartTID Developer

Info

Created 26-01-2021 by Lavinia Gheghea

Revision

Description

The API allows you to create, delete, and update job operation. You can retrieve individual job operation as well as a list of all job operations.

Endpoints

GET: /joboperations?sJobCode=xxxx

Parameters

Headers and Query

Name	Description	Type
API-key - required	Authorization Token	String(64)
UID - required	UID -how can be obtained	String
DEVICEID - required	DEVICEID	String
offset	starting record	Integer
limit	how many records displayed on a page	Integer
OrderFieldName	field name to order the recordset	String
OrderDirection	ASC or DESC	String
Filter	filter the recordset	String
sJobCode	Job Code	String
sPageName	Page Name	String
nRefID	Ref ID	Integer

Curl example

curl -X GET "https://smartapi.smarttid.dk/joboperations?sJobCode=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) : array of job operations

Response body

[ 
{
    "ID": 369,
    "JobCode": "1TESTCBZQ",
    "LineNumber": 1,
    "OperationCode": "TESTCBZQ",
    "Description": "testcbzq",
    "PlannedTime": 30,
    "ERPReference": "ref1",
    "SetupCompleted": false,
    "OperationCompleted": false,
    "CostGroupCode": "costgroupcode1",
    "CostTypeCode": "costtype1",
    "PlannedStartDate": "2022-03-03",
    "PlannedQuantityPerHour": 1,
    "QuantityPerUnit": 1,
    "Length": 10,
    "Width": 1,
    "Height": 2,
    "TotalQuantity": 2,
    "Color": "color1",
    "Tolerance": "tolerance1",
    "ColorCode": "colorcode1",
    "JobReportCode": "",
    "Area": 2.25,
    "Type": "type1",
    "Quality": "quality",
    "PlannedQuantity": 2,
    "UsedTime": 30,
    "AskForRemarkWhen": "Start",
"JobEnrollmentGroupCode":"code1"
  },
]

Response headers:

content-encoding: gzip 
 content-length: 238 
 content-type: application/json; charset=utf-8 
 date: Mon, 24 Aug 2020 08:01:23 GMT 
 server: Microsoft-IIS/10.0 
 vary: Accept-Encoding 
 x-pagination: {"totalCount":4,"totalFiltered":4,"Offset":0,"Limit":4,"Returned":4} 
 x-powered-by: ASP.NET

400 (ERROR) : Error message

Response Body

Error message

GET{id} : /joboperations/{id}

Parameters

Name	Description	Type
API-key - required	Authorization Token	String(64)
UID - required	UID -how can be obtained	String
DEVICEID - required	DEVICEID	String
id- required	ID of job operation	Integer

Curl example

curl -X GET "https://smartapi.smarttid.dk/joboperations/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) : the job operation

Response Body

[ 
{
    "ID": 369,
    "JobCode": "1TESTCBZQ",
    "LineNumber": 1,
    "OperationCode": "TESTCBZQ",
    "Description": "testcbzq",
    "PlannedTime": 30,
    "ERPReference": "ref1",
    "SetupCompleted": false,
    "OperationCompleted": false,
    "CostGroupCode": "costgroupcode1",
    "CostTypeCode": "costtype1",
    "PlannedStartDate": "2022-03-03",
    "PlannedQuantityPerHour": 1,
    "QuantityPerUnit": 1,
    "Length": 10,
    "Width": 1,
    "Height": 2,
    "TotalQuantity": 2,
    "Color": "color1",
    "Tolerance": "tolerance1",
    "ColorCode": "colorcode1",
    "JobReportCode": "",
    "Area": 2.25,
    "Type": "type1",
    "Quality": "quality",
    "PlannedQuantity": 2,
    "UsedTime": 30,
    "AskForRemarkWhen": "Start",
"JobEnrollmentGroupCode":"code1"
  },

]

Response Headers

content-encoding: gzip
  content-length: 175
  content-type: application/json; charset=utf-8 
 date: Mon, 24 Aug 2020 08:39:57 GMT 
 server: Microsoft-IIS/10.0 
 vary: Accept-Encoding  x-powered-by: ASP.NET

400 (ERROR) : Error message

Response Body

Error message

POST: /joboperations?sJobCode=xxxx

Parameters

Name	Description	Type
API-key - required	Authorization Token	String(64)
UID - required	UID -how can be obtained	String
DEVICEID - required	DEVICEID	String
sJobCode- required	Job Code	String

Request body

{
"sJobCode": "string",
  "nLineNumber": 0,
  "sOperationCode": "string",
  "sDescription": "string",
  "nPlannedTime": 0
 }

Curl example

curl -X POST "https://smartapi.smarttid.dk/joboperations?sJobCode=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json-patch+json" -d "{\"sJobCode\": \"string\",  \"nLineNumber\": 0,  \"sOperationCode\": \"string\",  \"sDescription\": \"string\",  \"nPlannedTime\": 0}"

Response

200 (OK) : The ID of the new job operation

Response Body

[
 {
  "ID": 370  }
]

Response Headers

content-encoding: gzip 
 content-length: 138 
 content-type: application/json; charset=utf-8 
 date: Mon, 24 Aug 2020 09:24:44 GMT 
 server: Microsoft-IIS/10.0 
 vary: Accept-Encoding  x-powered-by: ASP.NET

400 (ERROR) : Error message

Response Body

Error message

PUT{id}: /joboperations/{id}?sJobCode=xxxx

Parameters

Name	Description	Type
API-key - required	Authorization Token	String(64)
UID - required	UID -how can be obtained	String
DEVICEID - required	DEVICEID	String
sJobCode - required	Job Code	String
id- required	ID of job operation	Integer

Request body

{
"sJobCode": "string",
 "nLineNumber": 0,
 "sOperationCode": "string",
 "sDescription": "string",
 "nPlannedTime": 0,
 "sERPReference": "string",
 "bSetupCompleted": true,
 "bOperationCompleted": true,
 "sCostGroupCode": "string",
 "sCostTypeCode": "string",
 "dtPlannedStartDate": "string",
 "nPlannedQuantityPerHour": 0,
 "nQuantityPerUnit": 0,
 "nLength": 0,
 "nWidth": 0,
 "nHeight": 0,
 "nTotalQuantity": 0,
 "sColor": "string",
 "sTolerance": "string",
 "sColorCode": "string",
 "sJobReportCode": "string",
 "nArea": 0,
 "sType": "string",
 "sQuality": "string",
 "nPlannedQuantity": 0,
 "sAskForRemarkWhen": "string",
"sJobEnrollmentGroupCode": "string"
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/joboperations/id?sJobCode=xxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json-patch+json" -d "{\"sJobCode\": \"string\",  \"nLineNumber\": 0,  \"sOperationCode\": \"string\",  \"sDescription\": \"string\",  \"nPlannedTime\": 0,  \"sERPReference\": \"string\",  \"bSetupCompleted\": true,  \"bOperationCompleted\": true,  \"sCostGroupCode\": \"string\",\"sCostTypeCode\": \"string\",  \"dtPlannedStartDate\": \"string\",  \"nPlannedQuantityPerHour\": 0,  \"nQuantityPerUnit\": 0,  \"nLength\": 0,  \"nWidth\": 0,  \"nHeight\": 0,  \"nTotalQuantity\": 0,  \"sColor\": \"string\",  \"sTolerance\": \"string\",\"sColorCode\": \"string\",  \"sJobReportCode\": \"string\",  \"nArea\": 0,  \"sType\": "string",  \"sQuality\": \"string\",  \"nPlannedQuantity\": 0,  \"sAskForRemarkWhen\": \"string\",\"sJobEnrollmentGroupCode\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body

Error message

DELETE{id}: /joboperations/{id}

Parameters

Name	Description	Type
API-key - required	Authorization Token	String(64)
UID - required	UID -how can be obtained	String
DEVICEID - required	DEVICEID	String
id- required	ID of job operation	Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/joboperations/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :Success

400 (ERROR) : Bad request

Response Body

Error message

Response headers

content-length: 84 
 content-type: text/plain; charset=utf-8 
 date: Tue, 25 Aug 2020 08:35:21 GMT 
 server: Microsoft-IIS/10.0 
 x-powered-by: ASP.NET

Object

Name	Description	Type
sJobCode	Job Code	String
nLineNumber	Line Number	Number(double)
sOperationCode	Operation Code	String
sDescription	Description	String
nPlannedTime	Planned Time	Number(double)
sERPReference	ERP Reference	String
bSetupCompleted	Setup Completed	Bool
bOperationCompleted	Operation Completed	Bool
sCostGroupCode	Cost Group Code	String
sCostTypeCode	Cost Type Code	String
dtPlannedStartDate	Planned Start Date	String
nPlannedQuantityPerHour	Planned Quantity Per Hour	Number(double)
nQuantityPerUnit	Quantity Per Unit	Number(double)
nLength	Length	Number(double)
nWidth	Width	Number(double)
nHeight	Height	Number(double)
nTotalQuantity	Total Quantity	Number(double)
sColor	Color	String
sTolerance	Tolerance	String
sColorCode	Color Code	String
sJobReportCode	Job Report Code	String
nArea	Area	Number(double)
sType	Type	String
sQuality	Quality	String
nPlannedQuantity	Planned Quantity	Number(double)
sAskForRemarkWhen	Ask For Remark When	String
sJobEnrollmentGroupCode	Job Enrollment Group Code	String

Knowledge Base

Info

Revision

Description

Endpoints

GET: /joboperations?sJobCode=xxxx

GET{id} : /joboperations/{id}

POST: /joboperations?sJobCode=xxxx

PUT{id}: /joboperations/{id}?sJobCode=xxxx

DELETE{id}: /joboperations/{id}

Object