employment

Get Many Employments

Get Many Employments

Securitybearer
Request
query Parameters
select
Array of strings

Select Employment fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "employeeId" "typeId" "startDate" "endDate" "updated" "effectiveEndDate" "terminated" "rate" "note" "country"
relations
Array of strings

Select related Employment resources, comma-separated. (e.g. relations=office,department)

Items Enum: "type" "employee"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Employments. (e.g. limit=20)

offset
integer

Offset amount of received Employments. (e.g. offset=20)

object

Sort received Employments by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/employment
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": {
    }
}

Create One Employment

Create One Employment

Securitybearer
Request
Request Body schema: application/json
required
employeeId
required
string
userId
required
string
typeId
required
string
startDate
required
string <date-time>
endDate
string <date-time>
effectiveEndDate
string <date-time>
terminated
required
boolean
rate
required
number
note
string
country
required
string
Enum: "SE" "NO" "DK" "FI" "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "XK" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "CS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/employment
Request samples
application/json
{
  • "employeeId": "507f1f77bcf86cd799439011",
  • "userId": "507f1f77bcf86cd799439011",
  • "typeId": "507f1f77bcf86cd799439011",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "effectiveEndDate": "2019-08-24T14:15:22Z",
  • "terminated": true,
  • "rate": 0,
  • "note": "string",
  • "country": "SE"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Employment

Get One Employment

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Employment fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "employeeId" "typeId" "startDate" "endDate" "updated" "effectiveEndDate" "terminated" "rate" "note" "country"
relations
Array of strings

Select related Employment resources, comma-separated. (e.g. relations=office,department)

Items Enum: "type" "employee"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/employment/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": {
    }
}

Update One Employment

Update One Employment

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
employeeId
string
userId
string
typeId
string
startDate
string <date-time>
endDate
string <date-time>
effectiveEndDate
string <date-time>
terminated
boolean
rate
number
note
string
country
string
Enum: "SE" "NO" "DK" "FI" "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "XK" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "CS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/employment/{id}
Request samples
application/json
{
  • "employeeId": "507f1f77bcf86cd799439011",
  • "userId": "507f1f77bcf86cd799439011",
  • "typeId": "507f1f77bcf86cd799439011",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "effectiveEndDate": "2019-08-24T14:15:22Z",
  • "terminated": true,
  • "rate": 0,
  • "note": "string",
  • "country": "SE"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Employment

Replace One Employment

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
employeeId
string
userId
string
typeId
string
startDate
string <date-time>
endDate
string <date-time>
effectiveEndDate
string <date-time>
terminated
boolean
rate
number
note
string
country
string
Enum: "SE" "NO" "DK" "FI" "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "XK" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "CS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/employment/{id}
Request samples
application/json
{
  • "employeeId": "507f1f77bcf86cd799439011",
  • "userId": "507f1f77bcf86cd799439011",
  • "typeId": "507f1f77bcf86cd799439011",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "effectiveEndDate": "2019-08-24T14:15:22Z",
  • "terminated": true,
  • "rate": 0,
  • "note": "string",
  • "country": "SE"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Employment

Delete One Employment

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/employment/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to employment-type