{
"openapi": "3.0.1",
"info": {
"title": "MindKey OData Connector 2.0 - Employee",
"description": "MindKey OData Connector",
"version": "2.0"
},
"servers": [
{
"url": "https://connector.mindkey.com"
}
],
"paths": {
"/odata/v2/Employee": {
"get": {
"tags": [
"Employee"
],
"summary": "Retrieve a list of employees",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "GetEmployees",
"parameters": [
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeIEnumerableODataResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/odata/v2/Employee/{key}": {
"get": {
"tags": [
"Employee"
],
"summary": "Retrieve a single employee by its employee id",
"description": "Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.",
"operationId": "GetEmployee",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "$skip",
"in": "query",
"description": "Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Employee"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"400": {
"description": "Bad request. Occurs if the request payload or querystring contains invalid data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"CurrentPosition": {
"type": "object",
"properties": {
"positionId": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"nullable": true
},
"organizationId": {
"type": "string",
"nullable": true
},
"employmentCategoryName": {
"type": "string",
"nullable": true
},
"dimension1Id": {
"type": "string",
"nullable": true
},
"dimension2Id": {
"type": "string",
"nullable": true
},
"dimension3Id": {
"type": "string",
"nullable": true
},
"dimension4Id": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Employee": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"nameFirstName": {
"type": "string",
"nullable": true
},
"nameMiddleName": {
"type": "string",
"nullable": true
},
"nameLastName": {
"type": "string",
"nullable": true
},
"nameFullName": {
"type": "string",
"nullable": true
},
"salutation": {
"type": "integer",
"format": "int32"
},
"nickName": {
"type": "string",
"nullable": true
},
"addressStreet": {
"type": "string",
"nullable": true
},
"addressCity": {
"type": "string",
"nullable": true
},
"addressStateProvince": {
"type": "string",
"nullable": true
},
"addressZipPostalCode": {
"type": "string",
"nullable": true
},
"addressCountryRegion": {
"type": "string",
"nullable": true
},
"addressAddress": {
"type": "string",
"nullable": true
},
"socialSecurityNumber": {
"type": "string",
"nullable": true
},
"nationalityId": {
"type": "string",
"nullable": true
},
"languageId": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"maritalStatus": {
"type": "integer",
"format": "int32"
},
"gender": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"seniorityDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"homePhoneNumberCountryName": {
"type": "string",
"nullable": true
},
"homePhoneNumberCityAreaCode": {
"type": "string",
"nullable": true
},
"homePhoneNumberLocalNumber": {
"type": "string",
"nullable": true
},
"homePhoneNumberExtension": {
"type": "string",
"nullable": true
},
"homePhoneNumberFullPhoneNumber": {
"type": "string",
"nullable": true
},
"workPhoneNumberCountryName": {
"type": "string",
"nullable": true
},
"workPhoneNumberCityAreaCode": {
"type": "string",
"nullable": true
},
"workPhoneNumberLocalNumber": {
"type": "string",
"nullable": true
},
"workPhoneNumberExtension": {
"type": "string",
"nullable": true
},
"workPhoneNumberFullPhoneNumber": {
"type": "string",
"nullable": true
},
"mobilePhoneNumberCountryName": {
"type": "string",
"nullable": true
},
"mobilePhoneNumberCityAreaCode": {
"type": "string",
"nullable": true
},
"mobilePhoneNumberLocalNumber": {
"type": "string",
"nullable": true
},
"mobilePhoneNumberExtension": {
"type": "string",
"nullable": true
},
"mobilePhoneNumberFullPhoneNumber": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
},
"initials": {
"type": "string",
"nullable": true
},
"jubileeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"privateEmail": {
"type": "string",
"nullable": true
},
"privateMobilePhoneNumberCountryName": {
"type": "string",
"nullable": true
},
"privateMobilePhoneNumberCityAreaCode": {
"type": "string",
"nullable": true
},
"privateMobilePhoneNumberLocalNumber": {
"type": "string",
"nullable": true
},
"privateMobilePhoneNumberExtension": {
"type": "string",
"nullable": true
},
"privateMobilePhoneNumberFullPhoneNumber": {
"type": "string",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
},
"accountRegNumber": {
"type": "string",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double"
},
"latitude": {
"type": "number",
"format": "double"
},
"externalReference": {
"type": "string",
"nullable": true
},
"rowNumber": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string",
"nullable": true
},
"modifiedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionStamp": {
"type": "integer",
"format": "int32"
},
"documentsExists": {
"type": "boolean"
},
"preventAutoEnable": {
"type": "boolean"
},
"preventAutoDisable": {
"type": "boolean"
},
"activeUser": {
"type": "boolean"
},
"languageCultureId": {
"type": "string",
"nullable": true
},
"carLicensePlate": {
"type": "string",
"nullable": true
},
"iban": {
"type": "string",
"nullable": true
},
"swift": {
"type": "string",
"nullable": true
},
"regionCultureId": {
"type": "string",
"nullable": true
},
"optionalUserId": {
"type": "string",
"nullable": true
},
"workTimeStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workTimeEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"position": {
"$ref": "#/components/schemas/CurrentPosition"
},
"employmentInformation": {
"$ref": "#/components/schemas/EmploymentInformation"
}
},
"additionalProperties": false
},
"EmployeeIEnumerableODataResponse": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
},
"nullable": true
},
"@odata.context": {
"type": "string",
"nullable": true
},
"@odata.count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"@odata.nextLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a placeholder for describing OData responses."
},
"EmploymentInformation": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"seniorityDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"hiredDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"terminatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
}
},
"securitySchemes": {
"ApiKey-v2": {
"type": "apiKey",
"description": "Prefix the value with \"ApiKey-v2\" to indicate the custom authorization type",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"ApiKey-v2": [ ]
}
]
}