AdminCourse

GetCoursesAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

CreateCourseAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

companyUids	Array of strings <uuid>
name required	string
type	integer <int32> Enum: 1 2 3 4 5 6 7
locationLatitude	number <double>
locationLongitude	number <double>
address	string [ 0 .. 120 ] characters
teacher	string
targetGroup	string
contactPerson required	string [ 0 .. 120 ] characters
contactMail required	string [ 0 .. 120 ] characters
contactPhone	string [ 0 .. 50 ] characters
attachmentUids	Array of strings <uuid>
isNumberOfParticipantsUnlimited	boolean
maximumNumberOfParticipants	integer <int32>
description	string
isSingleCourse	boolean
required	Array of objects (Zalary.Courses.Contracts.EmployeeInCourse.Models.EmployeeInCourseRequest)
required	Array of objects (Zalary.Courses.Contracts.EmployeeInCourse.Models.EmployeeInCourseRequest)
autoApproveRequests	boolean
participationOnlyByInvitation	boolean
activateInviteLink	boolean
invitationLink	string [ 0 .. 2000 ] characters
required	Array of objects (Zalary.Courses.Contracts.CourseDate.Models.CourseDateRequest)

Responses

200

OK

post/api/administrators/{companyUid}/courses

Request samples

{"companyUids": ["00000000-0000-0000-0000-000000000000"
],
"name": "string",
"type": 1,
"locationLatitude": 0,
"locationLongitude": 0,
"address": "string",
"teacher": "string",
"targetGroup": "string",
"contactPerson": "string",
"contactMail": "string",
"contactPhone": "string",
"attachmentUids": ["00000000-0000-0000-0000-000000000000"
],
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"description": "string",
"isSingleCourse": true,
"employees": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"employeeGroups": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"autoApproveRequests": true,
"participationOnlyByInvitation": true,
"activateInviteLink": true,
"invitationLink": "string",
"courseDates": [{"publishDate": "2019-08-24T14:15:22Z",
"registrationDeadline": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
]
}

Response samples

200

[{"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]

GetEmployeeGroupsPerCompany

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/groups

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"name": "string",
"numberOfEmployeesInGroup": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

InsertEmployeeGroup

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

name required	string [ 0 .. 120 ] characters
employees required	Array of strings <uuid>

Responses

204

No Content

post/api/administrators/{companyUid}/courses/groups

Request samples

{"name": "string",
"employees": ["00000000-0000-0000-0000-000000000000"
]
}

GetCoursesRequestsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/requests

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"course": {"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"status": 0,
"department": {"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"companyName": "string",
"employee": {"contactPhone": "string",
"contactEmail": "string",
"imageUrl": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"canChangeStatus": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetCourseDetailsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/{courseUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"attachmentDocuments": [{"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"description": "string",
"courseDates": [{"date": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
],
"address": "string",
"locationLatitude": 0,
"locationLongitude": 0,
"teacher": "string",
"targetGroup": "string",
"contactPerson": "string",
"contactEmail": "string",
"contactPhone": "string",
"publishDate": "2019-08-24T14:15:22Z",
"registrationDeadline": "2019-08-24T14:15:22Z",
"employees": [{"role": 1,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"employeeGroup": [{"role": 1,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"autoAprove": true,
"onlyByInvitation": true,
"courseInCompanies": [{"companyUid": "00000000-0000-0000-0000-000000000000",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

UpdateCourseAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

companyUids	Array of strings <uuid>
name required	string
type	integer <int32> Enum: 1 2 3 4 5 6 7
locationLatitude	number <double>
locationLongitude	number <double>
address	string [ 0 .. 120 ] characters
teacher	string
targetGroup	string
contactPerson required	string [ 0 .. 120 ] characters
contactMail required	string [ 0 .. 120 ] characters
contactPhone	string [ 0 .. 50 ] characters
attachmentUids	Array of strings <uuid>
isNumberOfParticipantsUnlimited	boolean
maximumNumberOfParticipants	integer <int32>
description	string
isSingleCourse	boolean
required	Array of objects (Zalary.Courses.Contracts.EmployeeInCourse.Models.EmployeeInCourseRequest)
required	Array of objects (Zalary.Courses.Contracts.EmployeeInCourse.Models.EmployeeInCourseRequest)
autoApproveRequests	boolean
participationOnlyByInvitation	boolean
activateInviteLink	boolean
invitationLink	string [ 0 .. 2000 ] characters
required	Array of objects (Zalary.Courses.Contracts.CourseDate.Models.CourseDateRequest)

Responses

204

No Content

put/api/administrators/{companyUid}/courses/{courseUid}

Request samples

{"companyUids": ["00000000-0000-0000-0000-000000000000"
],
"name": "string",
"type": 1,
"locationLatitude": 0,
"locationLongitude": 0,
"address": "string",
"teacher": "string",
"targetGroup": "string",
"contactPerson": "string",
"contactMail": "string",
"contactPhone": "string",
"attachmentUids": ["00000000-0000-0000-0000-000000000000"
],
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"description": "string",
"isSingleCourse": true,
"employees": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"employeeGroups": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"autoApproveRequests": true,
"participationOnlyByInvitation": true,
"activateInviteLink": true,
"invitationLink": "string",
"courseDates": [{"publishDate": "2019-08-24T14:15:22Z",
"registrationDeadline": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
]
}

GetCourseRequestsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/{courseUid}/requests

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"course": {"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"status": 0,
"department": {"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"companyName": "string",
"employee": {"contactPhone": "string",
"contactEmail": "string",
"imageUrl": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"canChangeStatus": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetCourseInvitationsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/{courseUid}/invitations

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"course": {"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"status": 0,
"department": {"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"companyName": "string",
"employee": {"contactPhone": "string",
"contactEmail": "string",
"imageUrl": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"canChangeStatus": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetCourseParticipantsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/{courseUid}/participants

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"course": {"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"days": 0,
"status": 1,
"type": 1,
"isNumberOfParticipantsUnlimited": true,
"maximumNumberOfParticipants": 0,
"numberOfParticipants": 0,
"participationStatus": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"status": 0,
"department": {"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"companyName": "string",
"employee": {"contactPhone": "string",
"contactEmail": "string",
"imageUrl": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"canChangeStatus": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetEmployeesGroup

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeGroupUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/groups/{employeeGroupUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"name": "string",
"employees": [{"cpr": "string",
"title": "string",
"department": {"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

DeleteEmployeeGroup

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeGroupUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/administrators/{companyUid}/courses/groups/{employeeGroupUid}

Request samples

C#
Java
Python
JavaScript
curl

UpdateEmployeeGroup

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeGroupUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

name required	string [ 0 .. 120 ] characters
employees required	Array of strings <uuid>

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/groups/{employeeGroupUid}

Request samples

{"name": "string",
"employees": ["00000000-0000-0000-0000-000000000000"
]
}

GetManagedCompanyEmployees

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
managedCompanyUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/companies/{managedCompanyUid}/employees

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"companyDepartment": {"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"title": "string",
"isResigned": true,
"contactPhone": "string",
"contactEmail": "string",
"imageUrl": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetCourseAttachmentAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>
attachmentUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/administrators/{companyUid}/courses/{courseUid}/attachments/{attachmentUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

"string"

PostCourseAttachmentAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

OK

post/api/administrators/{companyUid}/courses/attachments

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

[{"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]

InviteEmployeesInCourseAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

Array

string <uuid>

Responses

204

No Content

post/api/administrators/{companyUid}/courses/{courseUid}/invite

Request samples

["00000000-0000-0000-0000-000000000000"
]

SendMessageToAllParticipants

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

subject	string
message	string

Responses

204

No Content

post/api/administrators/{companyUid}/courses/{courseUid}/send-message

Request samples

{"subject": "string",
"message": "string"
}

CancelCourseAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/cancel

Request samples

C#
Java
Python
JavaScript
curl

ArchiveCourseAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/archive

Request samples

C#
Java
Python
JavaScript
curl

RejectRequestsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/requests/reject

Request samples

C#
Java
Python
JavaScript
curl

ApproveRequestsAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/requests/approve

Request samples

C#
Java
Python
JavaScript
curl

CopyCourseAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

patch/api/administrators/{companyUid}/courses/{courseUid}/copy

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

"00000000-0000-0000-0000-000000000000"

RejectCourseRequestsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/{courseUid}/requests/reject

Request samples

C#
Java
Python
JavaScript
curl

ApproveCourseRequestsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/{courseUid}/requests/approve

Request samples

C#
Java
Python
JavaScript
curl

PendingCourseRequestsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/{courseUid}/requests/pending

Request samples

C#
Java
Python
JavaScript
curl

CancelCourseInvitationsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/{courseUid}/invitations/cancel

Request samples

C#
Java
Python
JavaScript
curl

RemoveCourseParticipantsAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
courseUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/administrators/{companyUid}/courses/{courseUid}/participants/remove

Request samples

C#
Java
Python
JavaScript
curl

AdminCourse

GetCoursesAsync

path Parameters

query Parameters

CreateCourseAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetEmployeeGroupsPerCompany

path Parameters

query Parameters

InsertEmployeeGroup

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetCoursesRequestsAsync

path Parameters

query Parameters

GetCourseDetailsAsync

path Parameters

query Parameters

UpdateCourseAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetCourseRequestsAsync

path Parameters

query Parameters

GetCourseInvitationsAsync

path Parameters

query Parameters

GetCourseParticipantsAsync

path Parameters

query Parameters

GetEmployeesGroup

path Parameters

query Parameters

DeleteEmployeeGroup

path Parameters

query Parameters

UpdateEmployeeGroup

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetManagedCompanyEmployees

path Parameters

query Parameters

GetCourseAttachmentAsync

path Parameters

query Parameters

PostCourseAttachmentAsync

path Parameters

query Parameters

InviteEmployeesInCourseAsync

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

SendMessageToAllParticipants

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

CancelCourseAsync

path Parameters

query Parameters

ArchiveCourseAsync

path Parameters

query Parameters

RejectRequestsAsync

path Parameters

query Parameters

ApproveRequestsAsync

path Parameters

query Parameters

CopyCourseAsync

path Parameters

query Parameters

RejectCourseRequestsAsync

path Parameters

query Parameters

ApproveCourseRequestsAsync

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json