Info

Created 22-01-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /journals


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
 bActive
 Active
 Bool

Curl example

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

Response

200 (OK) :  array of journals

Response body
[ 
{
    "ID": 38,
    "JournalCode": "STANDARD",
    "Description": "Standard",
    "SortOrder": 0,
    "Active": true,
    "JobJournalActive": true,
    "JobEnrollmentActive": false
  },
  {
    "ID": 42,
    "JournalCode": "TEST",
    "Description": "Testkladde",
    "SortOrder": 0,
    "Active": true,
    "JobJournalActive": false,
    "JobEnrollmentActive": false
  },
  {
    "ID": 39,
    "JournalCode": "TIME",
    "Description": "Timelønnede",
    "SortOrder": 0,
    "Active": true,
    "JobJournalActive": true,
    "JobEnrollmentActive": true
  },
  {
    "ID": 40,
    "JournalCode": "FUNK",
    "Description": "Funktionærer",
    "SortOrder": 4,
    "Active": true,
    "JobJournalActive": false,
    "JobEnrollmentActive": false
  }
]




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} : /journals/{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 journal
 Integer
Curl example

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

Response

200 (OK) : the journal

Response Body
[ 
{ 
 "ID": 38,
 "JournalCode": "STANDARD",
 "Description": "Standard",
 "SortOrder": 0, 
"Active": true, 
"JobJournalActive": true, 
"JobEnrollmentActive": false
}
]

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


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
{
"sJournalCode": "string",
  "sDescription": "string",
  "nSortOrder": 0,
  "bActive": true,
  "bJobJournalActive": true,
  "bJobEnrollmentActive": true,
  "sMailReminder": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/journals" -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 {\"sJournalCode\": \"string\",  \"sDescription\": \"string\",  \"nSortOrder\": 0,  \"bActive\": true,  \"bJobJournalActive\": true,  \"bJobEnrollmentActive\": true,  \"sMailReminder\": "string"}"

Response

200 (OK) : The ID of the new journal

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}: /journals/{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 activity
 Integer

Request body

{ 
"sJournalCode": "string",
 "sDescription": "string",
 "nSortOrder": 0,
 "bActive": true,
 "bJobJournalActive": true,
 "bJobEnrollmentActive": true,
 "sMailReminder": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/journals/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 {\"sJournalCode\": \"string\",  \"sDescription\": \"string\",  \"nSortOrder\": 0,  \"bActive\": true,  \"bJobJournalActive\": true,  \"bJobEnrollmentActive\": true,  \"sMailReminder\": "string"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /journals/{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 journal
 Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/journals/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
sJournalCode
 Code of journal
 String
sDescription
 Description
 String
 nSortOrder
 Sort Order
integer
bActive
 Active
 bool
bJobJournalActive
 Job Journal Active
 bool
 bJobEnrollmentActive
 Job Enrollment Active
 bool
 sMailReminder
 Mail Reminder
 string