GET restapi/personal/courses/search/v1?courseSyncKey={courseSyncKey}

Gets the course by synchronization key.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
courseSyncKey

The course synchronization key.

 string

Required

Body Parameters

None.

Response Information

Resource Description

This method return the course entity

Itslearning.RestApi.Entities.Course
NameDescriptionTypeAdditional information
Code

string

None.
CourseId

integer

None.
CreatedDateTimeUtc

date

None.
Title

string

None.
OrganisationId

integer

None.
CourseColorClass

string

None.
SyncKey

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Code": "sample string 1",
  "CourseId": 2,
  "CreatedDateTimeUtc": "2025-06-23T10:22:49Z",
  "Title": "sample string 3",
  "OrganisationId": 4,
  "CourseColorClass": "sample string 5",
  "SyncKey": "sample string 6"
}

application/xml, text/xml

Sample: 
<Course xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>sample string 1</Code>
  <CourseColorClass>sample string 5</CourseColorClass>
  <CourseId>2</CourseId>
  <CreatedDateTimeUtc>2025-06-23T10:22:49Z</CreatedDateTimeUtc>
  <OrganisationId>4</OrganisationId>
  <SyncKey>sample string 6</SyncKey>
  <Title>sample string 3</Title>
</Course>