Info

Created 29-07-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /jobenrollments


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

Curl example

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

Response

200 (OK) :  array of job enrollments

Response body


[ 
{
    "ID": 5,
    "JobEnrollmentCode": "SVEJSTJEKKET",
    "Description": "Er svejsning tjekket",
    "JobEnrollmentTypeCode": "KVALITET",
    "Active": true,
    "ERPReference": null,
    "SortOrder": 0,
    "JobReportType": "YesNo",
    "SelectList": null
  },
  {
    "ID": 6,
    "JobEnrollmentCode": "TRYKMÅLT",
    "Description": "Hvad er trykket",
    "JobEnrollmentTypeCode": "KVALITET",
    "Active": true,
    "ERPReference": null,
    "SortOrder": 0,
    "JobReportType": "Decimal",
    "SelectList": null
  },
  {
    "ID": 1,
    "JobEnrollmentCode": "01",
    "Description": "Item 01",
    "JobEnrollmentTypeCode": "MATR",
    "Active": true,
    "ERPReference": null,
    "SortOrder": 0,
    "JobReportType": "Decimal",
    "SelectList": null
  },
]

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} : /jobenrollments/{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 enrollment
 Integer
Curl example

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

Response

200 (OK) : the job enrollment
Response Body
[ 
 { 
"ID": 1, 
"JobEnrollmentCode": "01", 
"Description": "Item 01", 
"JobEnrollmentTypeCode": "MATR", 
"Active": true, 
"ERPReference": null, 
"SortOrder": 0, 
"JobReportType": "Decimal", 
"SelectList": null 
}
]

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: /jobenrollments


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

Request body

{
 "sJobEnrollmentCode": "string",
  "sDescription": "string",
  "sJobEnrollmentTypeCode": "string",
  "bActive": true,
  "sERPReference": "string",
  "nSortOrder": 0,
  "sJobReportType": "string",
  "sSelectList": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/jobenrollments" -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 "{ \"sJobEnrollmentCode\": \"string\",\"sDescription\": \"string\",\"sJobEnrollmentTypeCode\": \"string\",\"bActive\": true,\"sERPReference\": \"string\",\"nSortOrder\": 0,\"sJobReportType\": \"string\",\"sSelectList\": \"string\"}"

Response

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

Response Body
[
 {
  "ID": 1234
 }
]
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}: /jobenrollments/{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 enrollment
 Integer

Request body

{ 
 "sJobEnrollmentCode": "string",
 "sDescription": "string", 
"sJobEnrollmentTypeCode": "string", 
"bActive": true, 
"sERPReference": "string", 
"nSortOrder": 0, 
"sJobReportType": "string", 
"sSelectList": "string" 
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/jobenrollments/id" -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 "{ \"sJobEnrollmentCode\": \"string\",\"sDescription\": \"string\",\"sJobEnrollmentTypeCode\": \"string\",\"bActive\": true,\"sERPReference\": \"string\",\"nSortOrder\": 0,\"sJobReportType\": \"string\",\"sSelectList\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /jobenrollments/{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 enrollment
 Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/jobenrollments/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


SQL Procedure 

sp_JobEnrollment

Object

Job Enrollment
 Name
 Description
 Type
 sJobEnrollmentCode
 Job Enrollment Code
 String
 sDescription
 Description
 String
 sJobEnrollmentTypeCode
JobEnrollmentTypeCode
 String
 bActive
 Active
 bool
 sERPReference
ERPReference
 String
 nSortOrder
 Sort Order
 Integer
 sJobReportType
JobReportType
 String
 sSelectList
Select List
 String