Skip to content

API Documentation

Jump to bottom
Davis Tibbz edited this page Aug 13, 2023 · 5 revisions

title: WedemyServer API v1.0.0 language_tabs:

  • http: HTTP
  • javascript: JavaScript toc_footers: [] includes: [] search: true highlight_theme: darkula headingLevel: 2

WedemyServer API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

WedemyServer API

Base URLs:

Default

addNewObjectives

Code samples

POST https://WedemyServer/objectives/ HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "courseId": 0,
  "objectives": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/objectives/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /objectives/

POST objectives/

Body parameter

{
  "courseId": 0,
  "objectives": "string"
}

Parameters

Name In Type Required Description
body body ObjectivesDTO true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

getCourseObjectives

Code samples

GET https://WedemyServer/objectives/course/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/objectives/course/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /objectives/course/{courseId}

GET objectives/course/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CourseObjective] false none none
» id integer(int32) false none none
» course Course false none none
»» id integer(int32) false none none
»» title string false none none
»» subtitle string false none none
»» author string false none none
»» category string false none none
»» rating BigDecimal false none none
»» thumbUrl string false none none
»» price BigDecimal false none none
»» isFeatured boolean false none none
» objective string false none none
This operation does not require authentication

getLessonVideoLink

Code samples

POST https://WedemyServer/enroll/videolink/builder HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "courseId": 0,
  "lessonId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/enroll/videolink/builder',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /enroll/videolink/builder

POST enroll/videolink/builder

Body parameter

{
  "courseId": 0,
  "lessonId": "string"
}

Parameters

Name In Type Required Description
body body VideoRequest true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK VideoResponse
This operation does not require authentication

updateWatchStatus

Code samples

POST https://WedemyServer/enroll/watched HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "enrollId": 0,
  "currentLessonId": "string",
  "courseId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/enroll/watched',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /enroll/watched

POST enroll/watched

Body parameter

{
  "enrollId": 0,
  "currentLessonId": "string",
  "courseId": 0
}

Parameters

Name In Type Required Description
body body WatchStatus true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

checkEnrollStatus

Code samples

GET https://WedemyServer/enroll/status/c/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/enroll/status/c/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /enroll/status/c/{courseId}

GET enroll/status/c/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

getCourseProgress

Code samples

GET https://WedemyServer/enroll/progress/summary HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/enroll/progress/summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /enroll/progress/summary

GET enroll/progress/summary

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [EnrollmentDTO] false none none
» id integer(int64) false none none
» progress BigDecimal false none none
» title string false none none
» thumbUrl string false none none
» courseId integer(int32) false none none
This operation does not require authentication

getAllCourseProgress

Code samples

GET https://WedemyServer/enroll/mine HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/enroll/mine',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /enroll/mine

GET enroll/mine

Parameters

Name In Type Required Description
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [EnrollmentDTO] false none none
» id integer(int64) false none none
» progress BigDecimal false none none
» title string false none none
» thumbUrl string false none none
» courseId integer(int32) false none none
This operation does not require authentication

resumeMyCourse

Code samples

GET https://WedemyServer/enroll/resume/c/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/enroll/resume/c/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /enroll/resume/c/{courseId}

GET enroll/resume/c/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

getLessonsByCourseId

Code samples

GET https://WedemyServer/lessons/course/{id} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/lessons/course/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /lessons/course/{id}

GET lessons/course/{id}

Parameters

Name In Type Required Description
id path integer(int32) true none
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Lesson
This operation does not require authentication

getAllMyLessonsInEnrollment

Code samples

GET https://WedemyServer/lessons/c/{courseId}/e/{enrollId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/lessons/c/{courseId}/e/{enrollId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /lessons/c/{courseId}/e/{enrollId}

GET lessons/c/{courseId}/e/{enrollId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none
enrollId path integer(int64) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Map] false none none
This operation does not require authentication

getAllMyOwnedItems

Code samples

GET https://WedemyServer/sales/mine HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/sales/mine',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /sales/mine

GET sales/mine

Parameters

Name In Type Required Description
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK SalesDTO
This operation does not require authentication

getItemsbyTransactionId

Code samples

GET https://WedemyServer/sales/mine/{transactionId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/sales/mine/{transactionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /sales/mine/{transactionId}

GET sales/mine/{transactionId}

Parameters

Name In Type Required Description
transactionId path string true none
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK OrderItemDTO
This operation does not require authentication

addNewUser

Code samples

POST https://WedemyServer/auth/register HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "id": 0,
  "fullname": "string",
  "email": "string",
  "confirmPass": "string",
  "createdAt": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/auth/register',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/register

POST auth/register

Body parameter

{
  "id": 0,
  "fullname": "string",
  "email": "string",
  "confirmPass": "string",
  "createdAt": {}
}

Parameters

Name In Type Required Description
body body User true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

getStatusLogin

Code samples

GET https://WedemyServer/auth/status HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/auth/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/status

GET auth/status

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

addSingleItem

Code samples

POST https://WedemyServer/cart/course/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/cart/course/{courseId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /cart/course/{courseId}

POST cart/course/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Created MyCustomResponse
This operation does not require authentication

removeCartByCourseId

Code samples

DELETE https://WedemyServer/cart/course/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/cart/course/{courseId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /cart/course/{courseId}

DELETE cart/course/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

checkUserCartItem

Code samples

GET https://WedemyServer/cart/status/c/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/cart/status/c/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /cart/status/c/{courseId}

GET cart/status/c/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

getAllMyCartItems

Code samples

GET https://WedemyServer/cart/mine HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/cart/mine',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /cart/mine

GET cart/mine

Parameters

Name In Type Required Description
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Course
This operation does not require authentication

getMyCartBill

Code samples

GET https://WedemyServer/cart/mine/bill HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/cart/mine/bill',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /cart/mine/bill

GET cart/mine/bill

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

countMyCartItems

Code samples

GET https://WedemyServer/cart/mine/count HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/cart/mine/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /cart/mine/count

GET cart/mine/count

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

editMyProfile

Code samples

PUT https://WedemyServer/profile/mine HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "id": 0,
  "fullname": "string",
  "email": "string",
  "createdAt": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/profile/mine',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /profile/mine

PUT profile/mine

Body parameter

{
  "id": 0,
  "fullname": "string",
  "email": "string",
  "createdAt": {}
}

Parameters

Name In Type Required Description
body body UserDTO true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK UserDTO
This operation does not require authentication

getUserById

Code samples

GET https://WedemyServer/profile/mine HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/profile/mine',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /profile/mine

GET profile/mine

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK UserDTO
This operation does not require authentication

getUserSummary

Code samples

GET https://WedemyServer/profile/summary HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/profile/summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /profile/summary

GET profile/summary

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [StudentSummary] false none none
» title string false none none
» value integer(int64) false none none
» subtitle string false none none

Enumerated Values

Property Value
title JOINED
title COMPLETED
title OWNING
This operation does not require authentication

completePurchase

Code samples

POST https://WedemyServer/checkout/complete HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "nonce": "string",
  "totalAmount": {},
  "paymentMethod": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/checkout/complete',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /checkout/complete

POST checkout/complete

Body parameter

{
  "nonce": "string",
  "totalAmount": {},
  "paymentMethod": "string"
}

Parameters

Name In Type Required Description
body body CheckoutRequest true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

getClientToken

Code samples

GET https://WedemyServer/checkout/token HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/checkout/token',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /checkout/token

GET checkout/token

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

editCourseReview

Code samples

PUT https://WedemyServer/reviews/id/{id} HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "rating": 0,
  "content": "string",
  "courseId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/reviews/id/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /reviews/id/{id}

PUT reviews/id/{id}

Body parameter

{
  "rating": 0,
  "content": "string",
  "courseId": 0
}

Parameters

Name In Type Required Description
id path integer(int32) true none
body body ReviewRequest true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

addCourseReview

Code samples

POST https://WedemyServer/reviews/ HTTP/1.1
Host: wedemyserver
Content-Type: application/json
Accept: */*

const inputBody = '{
  "rating": 0,
  "content": "string",
  "courseId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://WedemyServer/reviews/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /reviews/

POST reviews/

Body parameter

{
  "rating": 0,
  "content": "string",
  "courseId": 0
}

Parameters

Name In Type Required Description
body body ReviewRequest true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

getMyReviewOnCourse

Code samples

GET https://WedemyServer/reviews/mine/c/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/reviews/mine/c/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reviews/mine/c/{courseId}

GET reviews/mine/c/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Review
This operation does not require authentication

getCourseReviews

Code samples

GET https://WedemyServer/reviews/course/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/reviews/course/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /reviews/course/{courseId}

GET reviews/course/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none
page query integer(int32) false none
sortBy query string false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ReviewDTO
This operation does not require authentication

getCourseById

Code samples

GET https://WedemyServer/courses/id/{id} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/courses/id/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /courses/id/{id}

GET courses/id/{id}

Parameters

Name In Type Required Description
id path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Course
This operation does not require authentication

getCoursesByCategory

Code samples

GET https://WedemyServer/courses/cat/{category} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/courses/cat/{category}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /courses/cat/{category}

GET courses/cat/{category}

Parameters

Name In Type Required Description
category path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Course] false none none
» id integer(int32) false none none
» title string false none none
» subtitle string false none none
» author string false none none
» category string false none none
» rating BigDecimal false none none
» thumbUrl string false none none
» price BigDecimal false none none
» isFeatured boolean false none none
This operation does not require authentication

getAllTopCourses

Code samples

GET https://WedemyServer/courses/top HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/courses/top',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /courses/top

GET courses/top

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Course] false none none
» id integer(int32) false none none
» title string false none none
» subtitle string false none none
» author string false none none
» category string false none none
» rating BigDecimal false none none
» thumbUrl string false none none
» price BigDecimal false none none
» isFeatured boolean false none none
This operation does not require authentication

getCategoryListDistinct

Code samples

GET https://WedemyServer/courses/categories HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/courses/categories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /courses/categories

GET courses/categories

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CategoryDTO] false none none
» id integer(int32) false none none
» category string false none none
This operation does not require authentication

searchForCourseByTitle

Code samples

GET https://WedemyServer/courses/search HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/courses/search',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /courses/search

GET courses/search

Parameters

Name In Type Required Description
title query string false none
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Course
This operation does not require authentication

addNewWishlist

Code samples

POST https://WedemyServer/wishlist/course/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/wishlist/course/{courseId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /wishlist/course/{courseId}

POST wishlist/course/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Created MyCustomResponse
This operation does not require authentication

removeWishlistByCourseId

Code samples

DELETE https://WedemyServer/wishlist/course/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/wishlist/course/{courseId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /wishlist/course/{courseId}

DELETE wishlist/course/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK MyCustomResponse
This operation does not require authentication

checkUserLikedCourse

Code samples

GET https://WedemyServer/wishlist/status/c/{courseId} HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/wishlist/status/c/{courseId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /wishlist/status/c/{courseId}

GET wishlist/status/c/{courseId}

Parameters

Name In Type Required Description
courseId path integer(int32) true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK string
This operation does not require authentication

getMyWishlistPaged

Code samples

GET https://WedemyServer/wishlist/mine HTTP/1.1
Host: wedemyserver
Accept: */*

const headers = {
  'Accept':'*/*'
};

fetch('https://WedemyServer/wishlist/mine',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /wishlist/mine

GET wishlist/mine

Parameters

Name In Type Required Description
page query integer(int32) false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Course
This operation does not require authentication

Schemas

ObjectivesDTO

{
  "courseId": 0,
  "objectives": "string"
}

Properties

Name Type Required Restrictions Description
courseId integer(int32) false none none
objectives string false none none

MyCustomResponse

{
  "message": "string",
  "success": true
}

Properties

Name Type Required Restrictions Description
message string false none none
success boolean false none none

BigDecimal

{}

Properties

None

Course

{
  "id": 0,
  "title": "string",
  "subtitle": "string",
  "author": "string",
  "category": "string",
  "rating": {},
  "thumbUrl": "string",
  "price": {},
  "isFeatured": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
title string false none none
subtitle string false none none
author string false none none
category string false none none
rating BigDecimal false none none
thumbUrl string false none none
price BigDecimal false none none
isFeatured boolean false none none

CourseObjective

{
  "id": 0,
  "course": {
    "id": 0,
    "title": "string",
    "subtitle": "string",
    "author": "string",
    "category": "string",
    "rating": {},
    "thumbUrl": "string",
    "price": {},
    "isFeatured": true
  },
  "objective": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
course Course false none none
objective string false none none

VideoRequest

{
  "courseId": 0,
  "lessonId": "string"
}

Properties

Name Type Required Restrictions Description
courseId integer(int32) false none none
lessonId string false none none

Lesson

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "lessonName": "string",
  "videokey": "string",
  "lengthSeconds": 0,
  "position": 0,
  "course": {
    "id": 0,
    "title": "string",
    "subtitle": "string",
    "author": "string",
    "category": "string",
    "rating": {},
    "thumbUrl": "string",
    "price": {},
    "isFeatured": true
  }
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none none
lessonName string false none none
videokey string false none none
lengthSeconds integer(int32) false none none
position integer(int32) false none none
course Course false none none

VideoResponse

{
  "enrollId": 0,
  "lesson": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "lessonName": "string",
    "videokey": "string",
    "lengthSeconds": 0,
    "position": 0,
    "course": {
      "id": 0,
      "title": "string",
      "subtitle": "string",
      "author": "string",
      "category": "string",
      "rating": {},
      "thumbUrl": "string",
      "price": {},
      "isFeatured": true
    }
  }
}

Properties

Name Type Required Restrictions Description
enrollId integer(int64) false none none
lesson Lesson false none none

WatchStatus

{
  "enrollId": 0,
  "currentLessonId": "string",
  "courseId": 0
}

Properties

Name Type Required Restrictions Description
enrollId integer(int64) false none none
currentLessonId string false none none
courseId integer(int32) false none none

EnrollmentDTO

{
  "id": 0,
  "progress": {},
  "title": "string",
  "thumbUrl": "string",
  "courseId": 0
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
progress BigDecimal false none none
title string false none none
thumbUrl string false none none
courseId integer(int32) false none none

Map

{}

Properties

None

Instant

{}

Properties

None

SalesDTO

{
  "transactionId": "string",
  "createdAt": {},
  "paymentMethod": "string",
  "totalPaid": {},
  "numOfItems": 0
}

Properties

Name Type Required Restrictions Description
transactionId string false none none
createdAt Instant false none none
paymentMethod string false none none
totalPaid BigDecimal false none none
numOfItems integer(int64) false none none

OrderItemDTO

{
  "id": 0,
  "title": "string",
  "price": {}
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
title string false none none
price BigDecimal false none none

User

{
  "id": 0,
  "fullname": "string",
  "email": "string",
  "confirmPass": "string",
  "createdAt": {}
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
fullname string false none none
email string false none none
confirmPass string false none none
createdAt Instant false none none

UserDTO

{
  "id": 0,
  "fullname": "string",
  "email": "string",
  "createdAt": {}
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
fullname string false none none
email string false none none
createdAt Instant false none none

StudentSummary

{
  "title": "JOINED",
  "value": 0,
  "subtitle": "string"
}

Properties

Name Type Required Restrictions Description
title string false none none
value integer(int64) false none none
subtitle string false none none

Enumerated Values

Property Value
title JOINED
title COMPLETED
title OWNING

CheckoutRequest

{
  "nonce": "string",
  "totalAmount": {},
  "paymentMethod": "string"
}

Properties

Name Type Required Restrictions Description
nonce string false none none
totalAmount BigDecimal false none none
paymentMethod string false none none

ReviewRequest

{
  "rating": 0,
  "content": "string",
  "courseId": 0
}

Properties

Name Type Required Restrictions Description
rating integer(int32) false none none
content string false none none
courseId integer(int32) false none none

Review

{
  "id": 0,
  "rating": 0,
  "content": "string",
  "user": {
    "id": 0,
    "fullname": "string",
    "email": "string",
    "confirmPass": "string",
    "createdAt": {}
  },
  "course": {
    "id": 0,
    "title": "string",
    "subtitle": "string",
    "author": "string",
    "category": "string",
    "rating": {},
    "thumbUrl": "string",
    "price": {},
    "isFeatured": true
  },
  "createdAt": {},
  "updatedAt": {}
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
rating integer(int32) false none none
content string false none none
user User false none none
course Course false none none
createdAt Instant false none none
updatedAt Instant false none none

ReviewDTO

{
  "id": 0,
  "content": "string",
  "rating": 0,
  "updatedAt": {},
  "fullname": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
content string false none none
rating integer(int32) false none none
updatedAt Instant false none none
fullname string false none none

CategoryDTO

{
  "id": 0,
  "category": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
category string false none none

Clone this wiki locally