Info

Created 15-11-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /jobenrollmentgrouptypes?nJobEnrollmentGroupID=XXX


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
 sPageName
 Page Name
 String
 nRefID
 RefID
 Integer
 nJobEnrollmentGroupID
 Job Enrollment Group ID
 Integer

Curl example

curl -X GET "https://smartapi.smarttid.dk/jobenrollmentgrouptypes?nJobEnrollmentGroupID=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 enrollment group types

Response body


[
{
    "ID": 1,
    "JobEnrollmentGroupID": 1,
    "JobEnrollmentTypeCode": "MATR",
    "Description": "Materials"
  }
]

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} : /jobenrollmentgrouptypes/{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 group type
 Integer
Curl example

curl -X GET "https://smartapi.smarttid.dk/jobenrollmentgrouptypes/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 group type
Response Body
[ 
{
    "ID": 1,
    "JobEnrollmentGroupID": 1,
    "JobEnrollmentTypeCode": "MATR",
    "Description": "Materials"
  }
]

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


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

{
"nJobEnrollmentGroupID": 0,
  "sJobEnrollmentTypeCode": "string",
  "sDescription": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/jobenrollmentgrouptypes" -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 "{\"nJobEnrollmentGroupID\": 0,  \"sJobEnrollmentTypeCode\": \"string\",  \"sDescription\": \"string\"}"

Response

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

Response Body
[
 {
  "ID": 3  
 }
]
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}: /jobenrollmentgrouptypes/{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 group type
 Integer

Request body

{
"nJobEnrollmentGroupID": 0,
  "sJobEnrollmentTypeCode": "string",
  "sDescription": "string" 
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/jobenrollmentgrouptypes/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 "{\"nJobEnrollmentGroupID\": 0,  \"sJobEnrollmentTypeCode\": \"string\",  \"sDescription\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /jobenrollmentgrouptypes/{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 enrollmentgroup type
 Integer

Curl example

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


Object

Job Enrollment Group Type
 Name
 Description
 Type
 nJobEnrollmentGroupID
 Job EnrollmentGroup ID
 Integer
 sJobEnrollmentTypeCode
 Job Enrollment Type Code
 String
sDescription
 Description
 String