Reference

Courselesson

The courselesson object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this courselesson
Active: bool optional
CompletionType: Nexudus.Coworking.Core.Enums.eLessonCompletionType optional
CourseId: Id required
DisplayOrder: int required
InstructorId: Id optional
LessonContents: string optional
SectionId: Id optional
SummaryText: string optional
Title: string required
UnlockAfterDays: int required
UnlockType: Nexudus.Coworking.Core.Enums.eLessonUnlockType optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this courselesson
SystemId: string optional api-only
User defined data about this courselesson. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "CompletionType": 1,
  "CourseId": 12345678,
  "DisplayOrder": ,
  "InstructorId": 12345678,
  "LessonContents": "Lesson Contents",
  "SectionId": 12345678,
  "SummaryText": "ShortText",
  "Title": "Title",
  "UnlockAfterDays": ,
  "UnlockType": 1,
  "UniqueId": "b98795bb-73a2-4753-a27b-6e7ccb5afd71",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CourseLesson

This endpoint allows you to GET a list of courselessons based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/content/courselessons?...

πŸ”’ Requires role "CourseLesson-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search courselesson records based on their different properties.
Id number
?Id=12345678
CourseLesson_Active bool
?CourseLesson_Active=...
CourseLesson_CompletionType Nexudus.Coworking.Core.Enums.eLessonCompletionType
?CourseLesson_CompletionType=...
CourseLesson_Course Course
?CourseLesson_Course=...
CourseLesson_DisplayOrder int
?CourseLesson_DisplayOrder=...
CourseLesson_Instructor Coworker
?CourseLesson_Instructor=...
CourseLesson_LessonContents string
?CourseLesson_LessonContents=...
CourseLesson_Section CourseSection
?CourseLesson_Section=...
CourseLesson_SummaryText string
?CourseLesson_SummaryText=...
CourseLesson_Title string
?CourseLesson_Title=...
CourseLesson_UnlockAfterDays int
?CourseLesson_UnlockAfterDays=...
CourseLesson_UnlockType Nexudus.Coworking.Core.Enums.eLessonUnlockType
?CourseLesson_UnlockType=...
CourseLesson_Course_Title string
?CourseLesson_Course_Title=...
CourseLesson_Section_Title string
?CourseLesson_Section_Title=...
CourseLesson_Instructor_FullName string
?CourseLesson_Instructor_FullName=...
CourseLesson_Instructor_CompanyName string
?CourseLesson_Instructor_CompanyName=...
CourseLesson_Instructor_TeamNames string
?CourseLesson_Instructor_TeamNames=...

Range search querystring parameters
Lets you search courselesson records based on a range of date or numeric values.
To_CourseLesson_CreatedOn date
?To_CourseLesson_CreatedOn=2010-01-01T20:32
From_CourseLesson_CreatedOn date
?From_CourseLesson_CreatedOn=2010-01-01T20:32
To_CourseLesson_UpdatedOn date
?To_CourseLesson_UpdatedOn=2010-01-01T20:32
From_CourseLesson_UpdatedOn date
?From_CourseLesson_UpdatedOn=2010-01-01T20:32
To_CourseLesson_DisplayOrder number
?To_CourseLesson_DisplayOrder=0
From_CourseLesson_DisplayOrder number
?From_CourseLesson_DisplayOrder=10
To_CourseLesson_UnlockAfterDays number
?To_CourseLesson_UnlockAfterDays=0
From_CourseLesson_UnlockAfterDays number
?From_CourseLesson_UnlockAfterDays=10

Example request

GET https://spaces.nexudus.com/api/content/courselessons?CourseLesson_Text=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Course": ,
        "Section": ,
        "Instructor": ,
        "Title": "Title",
        "SummaryText": "ShortText",
        "LessonContents": "Lesson Contents",
        "Active": false,
        "DisplayOrder": ,
        "UnlockType": 1,
        "UnlockAfterDays": ,
        "CompletionType": 1,
        "CourseLessonCourseTitle": "...",
        "CourseLessonSectionTitle": "...",
        "CourseLessonInstructorFullName": "...",
        "CourseLessonInstructorCompanyName": "...",
        "CourseLessonInstructorTeamNames": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "76beb0f4-89e5-439d-bded-5bf2f2ec847b",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find CourseLessons by IDs

Gets one or more courselesson records based on their Id.
GET https://spaces.nexudus.com/api/content/courselessons?CourseLesson_Id=[:id1,:id2,...]

πŸ”’ Requires role "CourseLesson-List"

Querystring parameters
CourseLesson_Id: array requried
?CourseLesson_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/content/courselessons?CourseLesson_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Course": ,
        "Section": ,
        "Instructor": ,
        "Title": "Title",
        "SummaryText": "ShortText",
        "LessonContents": "Lesson Contents",
        "Active": false,
        "DisplayOrder": ,
        "UnlockType": 1,
        "UnlockAfterDays": ,
        "CompletionType": 1,
        "CourseLessonCourseTitle": "...",
        "CourseLessonSectionTitle": "...",
        "CourseLessonInstructorFullName": "...",
        "CourseLessonInstructorCompanyName": "...",
        "CourseLessonInstructorTeamNames": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b6820871-e346-4839-9dc3-cbb71e114e1b",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CourseLesson by Id

Gets one courselesson record by its Id.
GET https://spaces.nexudus.com/api/content/courselessons/:Id

πŸ”’ Requires role "CourseLesson-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/content/courselessons/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Active": false,
  "CompletionType": 1,
  "CourseId": 12345678,
  "DisplayOrder": ,
  "InstructorId": 12345678,
  "LessonContents": "Lesson Contents",
  "SectionId": 12345678,
  "SummaryText": "ShortText",
  "Title": "Title",
  "UnlockAfterDays": ,
  "UnlockType": 1,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "748f7172-dd79-4e56-81f7-57d560d508e0",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CourseLesson

Creates a new courselesson.
POST https://spaces.nexudus.com/api/content/courselessons

πŸ”’ Requires role "CourseLesson-Create"

Body parameters
CourseId: number required
SectionId: number optional
InstructorId: number optional
Title: string required
SummaryText: string optional
LessonContents: string optional
Active: bool optional
DisplayOrder: int required
UnlockType: Nexudus.Coworking.Core.Enums.eLessonUnlockType optional
UnlockAfterDays: int required
CompletionType: Nexudus.Coworking.Core.Enums.eLessonCompletionType optional

Example request

POST https://spaces.nexudus.com/api/content/courselessons
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "CourseId": 12345678,
    "SectionId": 12345678,
    "InstructorId": 12345678,
    "Title": "Title",
    "SummaryText": "ShortText",
    "LessonContents": "Lesson Contents",
    "Active": false,
    "DisplayOrder": ,
    "UnlockType": 1, //(check Enumerated values section below)
    "UnlockAfterDays": ,
    "CompletionType": 1, //(check Enumerated values section below)
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update CourseLesson

Updates an existing courselesson.
PUT https://spaces.nexudus.com/api/content/courselessons

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "CourseLesson-Edit"

Body parameters
Id: number required
The unique Id of the courselesson to update.
CourseId: number cleared if missing
SectionId: number cleared if missing
InstructorId: number cleared if missing
Title: string cleared if missing
SummaryText: string cleared if missing
LessonContents: string cleared if missing
Active: bool cleared if missing
DisplayOrder: int cleared if missing
UnlockType: Nexudus.Coworking.Core.Enums.eLessonUnlockType cleared if missing
UnlockAfterDays: int cleared if missing
CompletionType: Nexudus.Coworking.Core.Enums.eLessonCompletionType cleared if missing

Example request

PUT https://spaces.nexudus.com/api/content/courselessons
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "CourseId": 12345678,
    "SectionId": 12345678,
    "InstructorId": 12345678,
    "Title": "Title",
    "SummaryText": "ShortText",
    "LessonContents": "Lesson Contents",
    "Active": false,
    "DisplayOrder": ,
    "UnlockType": 1, //(check Enumerated values section below)
    "UnlockAfterDays": ,
    "CompletionType": 1, //(check Enumerated values section below)
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete CourseLesson

Deletes an existing courselesson by its Id.
DELETE https://spaces.nexudus.com/api/content/courselessons/:Id

πŸ”’ Requires role "CourseLesson-Delete"

URL parameters
Id: number required
The unique Id of the courselesson to update.

Example request

DELETE https://spaces.nexudus.com/api/content/courselessons/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more courselesson records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for courselesson records.
GET https://spaces.nexudus.com/api/content/courselessons/commands

Example request

GET https://spaces.nexudus.com/api/content/courselessons/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more courselesson record IDs.
POST https://spaces.nexudus.com/api/content/courselessons/runacommand
πŸ”’ Requires role "CourseLesson-Edit"

Example request

POST https://spaces.nexudus.com/api/content/courselessons/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Enumerated values

UnlockType

GET /api/utils/enums?name=eLessonUnlockType

CompletionType

GET /api/utils/enums?name=eLessonCompletionType

Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

Image

GET https://spaces.nexudus.com/api/content/courselessons/getimage/:id
URL parameters
Id: number required
The id of the CourseLesson to get the image for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.