openapi: 3.0.3 info: title: HE Common Login & Registration description: HE Common Login & Registration project provides APIs for the heclr-ui license: name: MHE Proprietary API url: http://www.mheducation.com/terms-use.html version: 2.15.1 contact: name: Heclr Team email: dpg.DeltaForce@mheducation.com servers: - url: https://accounts-api-dev.mheducation.com - url: https://accounts-api-qastg.mheducation.com - url: https://accounts-api-qalv.mheducation.com - url: https://accounts-api-pqa.mheducation.com - url: https://accounts-api-demo.mheducation.com - url: https://accounts-api.mheducation.com tags: - name: Authentication description: Authentication Endpoints - name: User description: User Endpoints - name: Section description: Section Endpoint - name: Purchase description: Purchase Endpoint - name: Lti description: Lti Endpoints - name: Product description: Product Endpoints - name: External description: External Endpoints - name: Search description: Search Endpoints - name: Grader description: Grader Endpoints - name: Resource description: Resource Endpoints - name: Cart description: Cart Endpoints - name: Access description: Access Endpoints - name: Redemption description: Redemption Endpoints - name: List description: List Endpoints - name: Dev description: Dev Endpoints - name: OptInOut description: OptInOut Endpoints paths: /api/v1/access-options: get: deprecated: true security: - user-token: [] tags: - Access summary: Get access options for the given resourceId and countryCode description: |- This endpoint first checks for existing actives license for the given resource id. If no licenses, then return available offers. operationId: AccessOptionsRequest parameters: - name: resourceId in: query description: Resource Id of the section required: true schema: type: string x-go-name: ResourceID x-go-name: ResourceID - name: countryCode in: query description: Country code eg. US, CA required: true schema: type: string x-go-name: CountryCode x-go-name: CountryCode responses: '200': description: AccessOptionsResponse200 Access Response content: application/json: schema: $ref: '#/components/schemas/OptionsResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/authn/magic-link: post: tags: - Authentication summary: Magic link authentication description: '`This endpoint will validate the magic link request and create cookies`' operationId: VerifyMagicLinkRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyMagicLinkRequest' required: false responses: '200': description: DealResponse200 ok content: application/json: schema: $ref: '#/components/schemas/DealResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/license: post: tags: - License summary: Licensing for magic lick users description: '`This endpoint will check the deals and adopt the deal if only one deal available, return deals details if more then one deal present, or returns marketing page url in case of no deal`' operationId: MagicLinkUserLicenseRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/MagicLinkUserLicenseRequest' required: false responses: '200': description: DealResponse200 ok content: application/json: schema: $ref: '#/components/schemas/DealResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/authn/recovery/password: post: tags: - Authentication summary: Forgot password call description: '`This endpoint makes the resetcode call to IDM and sends email with link`' operationId: ForgotPasswordRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ForgotPasswordRequest' required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status x-codegen-request-body-name: Body /api/v1/authn/reset/password: post: tags: - Authentication summary: Reset password call for the user description: '`This endpoint will validate resetcode and then update user password in IDM`' operationId: ResetPasswordRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetPasswordRequest' required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/authn/reset/verify: post: tags: - Authentication summary: Verify reset password token description: '`This endpoint will validate the reset password token`' operationId: VerifyResetPasswordTokenRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyResetPasswordTokenRequest' required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/authn/verify/account: post: tags: - Authentication summary: Validate email verification code description: '`This endpoint will validate verification code and then update emailVerified in IDM`' operationId: VerifyEmailRequest requestBody: content: application/json: schema: required: - code type: object properties: code: type: string description: verification code x-go-name: Code required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/external/aleks: post: security: - aleks-custom-token: [] tags: - External summary: ALEKS Custom claims description: The endpoint expects a http header 'Custom-Token' with custom jwt value operationId: externalAleksCustomClaimsRequest parameters: - name: Custom-Token in: header schema: type: string x-go-name: Header x-go-name: Header responses: '200': description: ExternalCustomResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations application: type: string x-go-name: Application cancelUrl: type: string x-go-name: CancelURL email: type: string x-go-name: Email hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms product: $ref: '#/components/schemas/ProductResponse' returnUrl: type: string x-go-name: ReturnURL '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/external/aleks/users: post: security: - aleks-custom-token: [] tags: - External summary: ALEKS register User description: The endpoint expects a http header 'Custom-Token' with custom jwt value and 'userRequest' as form data. operationId: externalAleksUserRegisterRequest parameters: - name: Custom-Token in: header schema: type: string x-go-name: Header x-go-name: Header requestBody: content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms required: false responses: '200': description: ExternalUserResponse200 ok content: application/json: schema: $ref: '#/components/schemas/ExternalResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/external/simnet: post: security: - simnet-custom-token: [] tags: - External summary: SIMNET Custom claims description: The endpoint expects a http header 'Custom-Token' with custom jwt value operationId: externalSimnetCustomClaimsRequest parameters: - name: Custom-Token in: header schema: type: string x-go-name: Header x-go-name: Header responses: '200': description: ExternalCustomResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations application: type: string x-go-name: Application authenticate: type: boolean x-go-name: Authenticate cancelUrl: type: string x-go-name: CancelURL email: type: string x-go-name: Email hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms product: $ref: '#/components/schemas/ProductResponse' returnUrl: type: string x-go-name: ReturnURL '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/external/simnet/users: post: security: - simnet-custom-token: [] tags: - External summary: SIMNET register user description: The endpoint expects a http header 'Custom-Token' with custom jwt value and 'userRequest' as form data. operationId: externalSimnetUserRegisterRequest parameters: - name: Custom-Token in: header schema: type: string x-go-name: Header x-go-name: Header requestBody: content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email password: type: string x-go-name: Password required: false responses: '200': description: ExternalCustomResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations application: type: string x-go-name: Application authenticate: type: boolean x-go-name: Authenticate cancelUrl: type: string x-go-name: CancelURL email: type: string x-go-name: Email hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms product: $ref: '#/components/schemas/ProductResponse' returnUrl: type: string x-go-name: ReturnURL '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/lists/departments: get: tags: - List summary: Get department list description: '`This endpoint returns Departments list with name and id from RMS`' operationId: departmentListRequest parameters: - name: countryCode in: query schema: type: string x-go-name: CountryCode x-go-name: CountryCode responses: '200': description: DepartmentListResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/Department' '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/lists/disciplines: get: tags: - List summary: Get discipline list description: '`This endpoint returns discipline list with name and id from RMS`' operationId: GetDisciplines responses: '200': description: DisciplinesListResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/Discipline' '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/lists/languages: get: tags: - List summary: Get language list description: '`This endpoint returns language list with language code and name from RMS`' operationId: GetLanguages responses: '200': description: LanguagesListResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/Language' '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/login: post: tags: - User summary: Login User and obtain access token description: '`This endpoint returns the user login information by making call to IDM.`' operationId: UserLoginRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: false responses: '200': description: TokenResponse200 ok content: application/json: schema: $ref: '#/components/schemas/TokenResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '403': description: ErrorResponse403 Forbidden content: application/json: schema: type: object properties: code: type: string description: The error code example: forbidden x-go-name: Code message: type: string description: The error message example: invalid system token, forbidden, or locked x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 403 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/logout: delete: security: - user-token: [] tags: - User summary: Revokes the user jwt description: The endpoint will call the token service revoke API operationId: LogoutUserCookie responses: '200': description: ResponseOK ok content: {} /api/v1/lti: post: tags: - Lti summary: LTI Custom claims description: The endpoint expects a custom jwt value as a post request attribute operationId: customClaimsRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomClaimRequest' required: false responses: '200': description: CustomLtiResponse200 ok content: application/json: schema: $ref: '#/components/schemas/LTIResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/lti/launch: post: tags: - Lti summary: Launch Heclr-Lure workflow description: The endpoint expects 'jwt' as form data and returns Heclr's LTI workflow page operationId: customClaimsLaunchRequest requestBody: content: application/x-www-form-urlencoded: schema: properties: jwt: type: string x-go-name: JWT responses: '200': description: ResponseOK ok content: {} /api/v1/lti/login: post: tags: - Lti summary: LTI login with credentials description: The endpoint expects a custom jwt value as a post request attribute operationId: ltiLoginRequest requestBody: content: application/json: schema: required: - password - username type: object properties: jwt: type: string description: |- Custom JWT required x-go-name: JWT password: type: string description: password of the user example: ssssssshhh x-go-name: Password username: type: string description: username of the user example: user@email.com x-go-name: Username required: false responses: '200': description: CustomLtiResponse200 ok content: application/json: schema: $ref: '#/components/schemas/LTIResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/lti/users: post: tags: - Lti summary: LTI Create User description: The endpoint expects a custom jwt value as a post request attribute operationId: ltiUserCreateRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomClaimRequest' required: false responses: '200': description: CustomLtiResponse200 ok content: application/json: schema: $ref: '#/components/schemas/LTIResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/lti/users/{personXid}: put: tags: - Lti summary: LTI User update with values pulled from the custom jwt after password validation description: The endpoint expects a custom jwt value as a post request attribute operationId: ltiUserUpdateRequest parameters: - name: personXid in: path required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid requestBody: content: application/json: schema: $ref: '#/components/schemas/UserUpdateRequest' required: false responses: '200': description: CustomLtiResponse200 ok content: application/json: schema: $ref: '#/components/schemas/LTIResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/minicart/{cartId}: get: tags: - Cart summary: Get minicart details for cartId description: This endpoint returns minicart items for the given cartId operationId: getMiniCartItemsforK12Stores deprecated: true parameters: - name: cartId in: path description: CartId required: true schema: type: string x-go-name: CartId x-go-name: CartId responses: '200': description: MinicartResponse200 Minicart Response content: application/json: schema: $ref: '#/components/schemas/Minicart' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/{storeCode}/minicart/{cartId}: get: tags: - Cart summary: Get minicart details for cartId and Store Code description: This endpoint returns minicart items for the given cartId and Store Code operationId: getMiniCartItems parameters: - name: cartId in: path description: CartId required: true schema: type: string x-go-name: CartId x-go-name: CartId - name: storeCode in: path description: storeCode e.g. us (for national), k12stores (for custom Stor front) required: true schema: type: string x-go-name: storeCode x-go-name: storeCode responses: '200': description: MinicartResponse200 Minicart Response content: application/json: schema: $ref: '#/components/schemas/Minicart' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/cart: post: security: - user-token: [ ] tags: - Cart summary: Create cart description: This endpoint creates cart in magento and returns the cart id operationId: CartCreateRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/CartCreateRequest' required: false responses: '200': description: CartResponse200 Cart Response content: application/json: schema: $ref: '#/components/schemas/CartCreateResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/guest-cart: post: security: - user-token: [ ] tags: - Cart summary: Create guest cart description: This endpoint creates guest cart in magento and returns the cart id and product type operationId: GuestCartCreateRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/CartCreateRequest' required: false responses: '200': description: CartResponse200 Cart Response content: application/json: schema: $ref: '#/components/schemas/GuestCartCreateResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/products/{id}/license/{person-xid}: get: security: - user-token: [] tags: - Product summary: Get product license for a user description: This endpoint returns product license for the given product id and user id operationId: ProductLicenseRequest parameters: - name: id in: path description: Product id required: true schema: type: string x-go-name: ProductId x-go-name: ProductId - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid responses: '200': description: ProductLicenseResponse200 Product Response content: application/json: schema: $ref: '#/components/schemas/ProductLicenseResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/products/{id}/purchase-options/{person-xid}: post: security: - user-token: [] tags: - Product summary: Get product purchase options for the user description: '`This endpoint returns product purchase options for the given product id`' operationId: ProductPurchaseOptionsRequest parameters: - name: id in: path description: Product id required: true schema: type: string x-go-name: ProductId x-go-name: ProductId - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductPurchaseOptionsRequest' required: false responses: '200': description: ProductPurchaseOptionsResponse200 Product Response content: application/json: schema: $ref: '#/components/schemas/ProductPurchaseOptionsResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/products/{productId}: get: tags: - Product summary: Get product details for productId description: This endpoint returns section metadata for the given productId operationId: ProductIdRequest parameters: - name: productId in: path description: ProductId required: true schema: type: string x-go-name: ProductId x-go-name: ProductId responses: '200': description: ProductResponse200 Product Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/products/search: post: security: - system-token: [ ] tags: - Product summary: Search IA for the given productId and organization xid description: '`This endpoint returns product details along with boolean attributes for Inclusive access and ebook available.`' operationId: ProductIASearchRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductIASearchRequest' required: false responses: '200': description: ProductIASearchResponse200 ProductIASearch Response content: application/json: schema: $ref: '#/components/schemas/ProductIASearchResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/purchase/access-code/adopt: post: security: - user-token: [] tags: - Purchase summary: Adopt access code description: This endpoint adopts access code and returns the status operationId: adoptAccessCodeRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/AdoptAccessCodeRequest' required: false responses: '200': description: AdoptAccessCodeResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/purchase/access-code/validate: post: security: - user-token: [] tags: - Purchase summary: Validate access code description: This endpoint returns access code validation details operationId: validateAccessCodeRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateAccessCodeRequest' required: false responses: '200': description: ValidateAccessCodeResponse200 ok content: application/json: schema: $ref: '#/components/schemas/ValidateAccessCodeResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/purchase/ia/adopt: post: security: - user-token: [] tags: - Purchase summary: Adopt inclusive access description: This endpoint adopts inclusive access and returns the status operationId: adoptInclusiveAccessRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/AdoptInstitutionalDealRequest' required: false responses: '200': description: AdoptInclusiveAccessResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/purchase/temp-access/adopt: post: security: - user-token: [] tags: - Purchase summary: Adopt temp access offer description: This endpoint adopts temp access and returns the status operationId: adoptTempAccessRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/AdoptTempAccessRequest' required: false responses: '200': description: AdoptTempAccessResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/purchase/temp-access/validate: post: security: - user-token: [] tags: - Purchase summary: Validate temp access description: This endpoint validates temp access operationId: validateTempAccessRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateTempAccessRequest' required: false responses: '200': description: ValidateTempAccessResponse200 ok content: application/json: schema: $ref: '#/components/schemas/ValidateTempAccessResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/resources/{id}/license/{person-xid}: get: deprecated: true security: - user-token: [] tags: - Resource summary: Get resource license for a user description: This endpoint returns resource license for the given resource id and user id from ENT operationId: ResourceLicenseRequest parameters: - name: id in: path description: Resource id required: true schema: type: string x-go-name: ResourceId x-go-name: ResourceId - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid - name: redirectUrl in: query description: Redirect Url schema: type: string x-go-name: RedirectUrl x-go-name: RedirectUrl responses: '200': description: ResourceLicenseResponse200 Resource License Response content: application/json: schema: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/resource/ia/adopt: post: tags: - Resource summary: Adopt IA deal for given resource for a user description: '`This endpoint will adopt the resource IA deal`' operationId: ResourceIAAdoptionRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceIAAdoptionRequest' required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/person/{person-xid}/license: get: security: - user-token: [] tags: - Resource summary: Get resource license for a user description: This endpoint returns license for the given person xid and optional resource id from ENT operationId: PersonLicenseRequest parameters: - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid - name: resourceId in: query description: Resource id schema: type: string x-go-name: ResourceId x-go-name: ResourceId - name: redirectUrl in: query description: Redirect Url schema: type: string x-go-name: RedirectUrl x-go-name: RedirectUrl - name: flow in: query description: Flow schema: type: string x-go-name: Flow x-go-name: Flow responses: '200': description: ResourceLicenseResponse200 Resource License Response content: application/json: schema: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus redirectUrl: type: string x-go-name: RedirectUrl resourceId: type: string x-go-name: ResourceId '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/search/school: get: tags: - Search description: '`This endpoint returns the school results for the given search criteria.`' operationId: SearchOrgRequest parameters: - name: page in: query description: Page number of the requested page schema: type: integer format: int64 x-go-name: Page x-go-name: Page - name: size in: query description: Size of a page schema: type: integer format: int64 x-go-name: Size x-go-name: Size - name: segment in: query description: Segment schema: type: string x-go-name: Segment x-go-name: Segment - name: country in: query description: Country code eg. US, CA schema: type: string x-go-name: Country x-go-name: Country - name: term in: query description: term schema: type: string x-go-name: Organizationname x-go-name: Organizationname - name: sortBy in: query description: Sort By eg. name schema: type: string x-go-name: SortBy x-go-name: SortBy - name: sortOrder in: query description: Sort Order eg. asc or desc schema: type: string x-go-name: SortOrder x-go-name: SortOrder responses: '200': description: SearchOrgResponse200 Access Response content: application/json: schema: $ref: '#/components/schemas/SearchOrgResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status post: tags: - Search description: '`This endpoint returns the organization search results`' operationId: OrganizationSearchRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationSearchRequest' required: false responses: '200': description: OrganizationSearchResponse200 Organization Search Response content: application/json: schema: $ref: '#/components/schemas/OrganizationSearchResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/search/school/{org-xid}/hierarchy: get: tags: - Search summary: Get organization hierarchy details for org xid description: This endpoint returns organization hierarchy for the given organization xid operationId: OrganizationHierarchyRequest parameters: - name: org-xid in: path description: Organization xid required: true schema: type: string x-go-name: XID x-go-name: XID responses: '200': description: organizationHierarchyResponse200 Organization Hierarchy Response content: application/json: schema: type: array items: $ref: '#/components/schemas/OrganizationHierarchyResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/code/{code}: get: tags: - Section summary: Get section details for code description: This endpoint returns section metadata for the given section code operationId: SectionCodeRequest parameters: - name: code in: path required: true schema: type: string x-go-name: Code x-go-name: Code responses: '200': description: SectionResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/{section-xid}: get: tags: - Section summary: Get section details for section xid description: This endpoint returns section metadata for the given section xid operationId: SectionXIDRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: XID x-go-name: XID responses: '200': description: SectionResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/{section-xid}/enrollment/{person-xid}: get: security: - user-token: [] tags: - Section summary: Get section enrollment description: This endpoint returns user's enrollment for the given section xid operationId: sectionEnrollmentRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: SectionXid x-go-name: SectionXid - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid responses: '200': description: SectionEnrollmentResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionEnrollmentResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/{section-xid}/license/{person-xid}: get: security: - user-token: [] tags: - Section summary: Get section license description: This endpoint returns section license for the given section xid operationId: SectionLicenseRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: SectionXid x-go-name: SectionXid - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid - name: ebookId in: query description: ebookId schema: type: string x-go-name: EBookId x-go-name: EBookId - name: checkEnrollment in: query description: Check enrollment flag (true|false) schema: type: string x-go-name: CheckEnrollment x-go-name: CheckEnrollment responses: '200': description: SectionLicenseResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionLicenseResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/{section-xid}/purchase-options/ia/{person-xid}: get: security: - user-token: [] tags: - Section summary: Get section ia purchase options for the user description: This endpoint returns section purchase options for inclusive access operationId: SectionIAPurchaseOptionsRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: SectionXid x-go-name: SectionXid - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid responses: '200': description: SectionPurchaseOptionsResponse Section Purchase Options Response content: application/json: schema: $ref: '#/components/schemas/SectionPurchaseOptionsResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/{section-xid}/purchase-options/upsell/{person-xid}: get: security: - user-token: [] tags: - Section summary: Get section upsell purchase options for the user description: 1This endpoint returns section purchase options for upsell operationId: SectionUpsellPurchaseOptionsRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: SectionXid x-go-name: SectionXid - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid responses: '200': description: SectionPurchaseOptionsResponse Section Purchase Options Response content: application/json: schema: $ref: '#/components/schemas/SectionPurchaseOptionsResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/sections/{section-xid}/purchase-options/{person-xid}: get: security: - user-token: [] tags: - Section summary: Get section purchase options for the user description: '`This endpoint returns section purchase options for the given section xid`' operationId: SectionPurchaseOptionsRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: SectionXid x-go-name: SectionXid - name: person-xid in: path description: Person xid required: true schema: type: string x-go-name: PersonXid x-go-name: PersonXid responses: '200': description: SectionPurchaseOptionsResponse Section Purchase Options Response content: application/json: schema: $ref: '#/components/schemas/SectionPurchaseOptionsResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/users: put: security: - user-token: [] - profile-cookie: [] tags: - User summary: Update user description: The endpoint will call the IDM User update method operationId: UserUpdateRequest requestBody: content: application/json: schema: required: - affiliations - email - familyName - givenName - password type: object properties: affiliations: type: array description: User school details items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations confirmNewPassword: type: string description: confirm new password of the user example: PassW0rd x-go-name: ConfirmNewPassword email: type: string description: email of the user example: user@email.com x-go-name: Email familyName: type: string description: Last Name of the user example: Doe x-go-name: FamilyName givenName: type: string description: First Name of the user example: John x-go-name: GivenName hasAgreedTerms: type: boolean description: Boolean to agree terms for profile update flow x-go-name: HasAgreedTerms isLMSFlow: type: boolean description: Boolean to process LMS flow update x-go-name: IsLMSFlow newPassword: type: string description: new password of the user example: PassW0rd x-go-name: NewPassword password: type: string description: current password of the user example: PassW0rd x-go-name: Password phone: type: string description: Phone number of the user example: 1-800-565-5758 x-go-name: Phone question: type: string description: Security question x-go-name: Question response: type: string description: Security answer x-go-name: Response userType: type: string description: User type example: learner x-go-name: UserType verifyPassword: type: boolean description: VerifyPassword will be true when user tries to edit the account from ECOMM-UI x-go-name: VerifyPassword required: false responses: '200': description: UserResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body post: tags: - User summary: Create User and obtain access token description: '`This endpoint creates a User via a call to IDM.`' operationId: UserCreateRequest requestBody: content: application/json: schema: required: - affiliations - email - familyName - givenName - password - userType type: object properties: affiliations: type: array description: User school details items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string description: email of the user example: user@email.com x-go-name: Email familyName: type: string description: Last Name of the user example: Doe x-go-name: FamilyName givenName: type: string description: First Name of the user example: John x-go-name: GivenName locale: type: string description: Locale only for CREATE flow x-go-name: Locale password: type: string description: password of the user example: Abc12345 x-go-name: Password phone: type: string description: Phone number of the user example: 1-800-565-5758 x-go-name: Phone question: type: string description: Security question x-go-name: Question response: type: string description: Security answer x-go-name: Response userType: type: string description: User type example: learner x-go-name: UserType required: false responses: '200': description: UserResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '409': description: ErrorResponse409 Conflict content: application/json: schema: type: object properties: code: type: string description: The error code example: conflict x-go-name: Code message: type: string description: The error message example: Non Unique Email x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 409 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body patch: security: - user-token: [] tags: - User summary: Patch user description: The endpoint will call the IDM User Affiliation update method operationId: UserPatchRequest requestBody: content: application/json: schema: required: - affiliations type: object properties: affiliations: type: array description: User school details items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations required: false responses: '200': description: UserResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/users/details: get: security: - user-token: [] tags: - User summary: Get current user's detailed information from the user jwt description: |- ` This endpoint returns the user information plus persona details.` operationId: GetUserDetails responses: '200': description: UserDetailsResponse200 User details Response content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName persona: $ref: '#/components/schemas/Persona' phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/users/find/{email}: get: tags: - User summary: Check if user exists for given email description: '`This endpoint checks if user exists in IDM for the given email`' operationId: FindUserRequest parameters: - name: email in: path description: email of the user required: true schema: type: string x-go-name: Email x-go-name: Email - name: allow in: query description: comma separated values of identifiers allowed to make the call schema: type: string x-go-name: Allow x-go-name: Allow - name: app in: query description: app parameter schema: type: string x-go-name: App x-go-name: App responses: '200': description: Response200 ok content: application/json: schema: type: object properties: givenName: type: string description: Given name of the user x-go-name: GivenName valid: type: string description: Is result valid example: 'true' enum: - 'true' x-go-name: Result '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '403': description: ErrorResponse403 Forbidden content: application/json: schema: type: object properties: code: type: string description: The error code example: forbidden x-go-name: Code message: type: string description: The error message example: invalid system token, forbidden, or locked x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 403 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/users/grader: post: security: - grader-custom-token: [] tags: - Grader summary: Create User and obtain access token description: '`This endpoint creates a User via a call to IDM.`' operationId: GraderUserCreateRequest parameters: - name: Custom-Token in: header schema: type: string x-go-name: Header x-go-name: Header requestBody: content: application/json: schema: required: - affiliations - email - familyName - givenName - password - userType type: object properties: affiliations: type: array description: User school details items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string description: email of the user example: user@email.com x-go-name: Email familyName: type: string description: Last Name of the user example: Doe x-go-name: FamilyName givenName: type: string description: First Name of the user example: John x-go-name: GivenName password: type: string description: password of the user example: Abc12345 x-go-name: Password phone: type: string description: Phone number of the user example: 1-800-565-5758 x-go-name: Phone question: type: string description: Security question x-go-name: Question response: type: string description: Security answer x-go-name: Response userType: type: string description: User type example: staff x-go-name: UserType required: false responses: '200': description: UserResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '409': description: ErrorResponse409 Conflict content: application/json: schema: type: object properties: code: type: string description: The error code example: conflict x-go-name: Code message: type: string description: The error message example: Non Unique Email x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 409 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/users/grader/invitation-status: get: security: - grader-custom-token: [] tags: - Grader summary: Check invitation status description: |- This endpoint first check user existance in IDM for the given email. If user doesn't exist, then check the invitation status and return the response. operationId: checkInvitationStatus parameters: - name: Custom-Token in: header schema: type: string x-go-name: Header x-go-name: Header responses: '200': description: invitationResponse200 ok content: application/json: schema: $ref: '#/components/schemas/InvitationResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/users/grader/invitations: post: security: - system-token: [] tags: - Grader summary: Validate and send invitation description: This endpoint validate and send the grader invitation emails operationId: graderInvitationRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/InvitationRequest' required: false responses: '200': description: invitationResponse200 ok content: application/json: schema: $ref: '#/components/schemas/InvitationResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '401': description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/users/magic-link: post: tags: - User summary: Send magic link for the given email address description: '`This endpoint checks for existing user and sends out magic link email`' operationId: SendMagicLinkRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/SendMagicLinkRequest' required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '403': description: ErrorResponse403 Forbidden content: application/json: schema: type: object properties: code: type: string description: The error code example: forbidden x-go-name: Code message: type: string description: The error message example: invalid system token, forbidden, or locked x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 403 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/users/admin-magic-link: post: tags: - User summary: Send magic link for the given email address for creation or update of an admin user description: '`This endpoint checks for existing user and sends out magic link email`' operationId: SendAdminMagicLinkRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/SendAdminMagicLinkRequest' required: false responses: '200': description: ResponseOK ok content: {} '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '403': description: ErrorResponse403 Forbidden content: application/json: schema: type: object properties: code: type: string description: The error code example: forbidden x-go-name: Code message: type: string description: The error message example: invalid system token, forbidden, or locked x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 403 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status x-codegen-request-body-name: Body /api/v1/users/profile: get: security: - profile-cookie: [] tags: - User summary: Get current user information from the user profile cookie description: '`This endpoint returns the user information by making call to IDM.`' operationId: GetUserProfile responses: '200': description: UserProfileResponse200 User profile Response content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName phone: type: string x-go-name: Phone question: type: string x-go-name: Question sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/users/questions: get: tags: - User summary: Get security questions description: The endpoint will get security questions from RMS operationId: GetSecurityQuestions responses: '200': description: SecurityQuestionsResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityQuestion' /api/v1/users/self: get: security: - user-token: [] tags: - User summary: Get current user information from the user jwt description: '`This endpoint returns the user information by making call to IDM.`' operationId: GetUser responses: '200': description: UserResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v2/users/self: get: security: - user-token: [] tags: - User summary: Get current user's basic information from the user jwt description: '`This endpoint returns the user information by making call to IDM.`' operationId: GetUserV2 responses: '200': description: UserResponseBasic200 ok content: application/json: schema: type: object properties: email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName userName: type: string x-go-name: UserName xid: type: string x-go-name: XID '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/optinout/{section-xid}: get: tags: - OptInOut summary: Get section details for section xid description: This endpoint returns opt in/out details for the given section xid operationId: GetOptInOutDetailsRequest parameters: - name: section-xid in: path description: Section xid required: true schema: type: string x-go-name: XID x-go-name: XID responses: '200': description: SectionOptInOutResponse200 OptInOut Response content: application/json: schema: $ref: '#/components/schemas/SectionOptInOutResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/user/optinout/details: get: tags: - OptInOut summary: Get user opt in/out details description: This endpoint returns user opt in/out details operationId: GetUserOptInOutDetailsRequest responses: '200': description: UserOptInOutDetailsResponse200 OptInOut Response content: application/json: schema: $ref: '#/components/schemas/UserOptInOutDetailsResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/optinout: post: tags: - OptInOut summary: Save user opt in/out details description: This endpoint save user opt in/out details (If action is optin then adopt the deal else save the data in rms) operationId: SaveOptInOutDetailsRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveUserOptInOutDataRequest' required: false responses: '200': description: SaveUserOptInOutDataResponse200 OptInOut Response content: application/json: schema: $ref: '#/components/schemas/SaveUserOptInOutDataResponse' '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /deployment: get: tags: - Dev summary: Get the deployment information description: '`This endpoint returns deployment details`' operationId: getBuildInfo responses: '200': description: DeploymentResponse200 ok content: application/json: schema: $ref: '#/components/schemas/Build' /api/v1/config: get: tags: - Dev summary: Get the feature flag description: '`This endpoint returns deployment details`' operationId: getConfig responses: '200': description: DeploymentResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AppConfig' /api/v1/accesscode/{accessCode}: get: security: - user-token: [ ] tags: - Redemption summary: Get access code details for the given code description: '`This endpoint returns the access code details for the given code.`' operationId: GetAccessCodeMetaData parameters: - name: accessCode in: path description: Access code required: true schema: type: string x-go-name: AccessCode x-go-name: AccessCode responses: '200': description: EBook200 ok content: application/json: schema: type: object properties: xid: type: string x-go-name: XID mheid: type: string x-go-name: MHEID isbn10: type: string x-go-name: ISBN10 isbn13: type: string x-go-name: ISBN resource: type: string x-go-name: Resource accesscode: type: string x-go-name: Accesscode resourceName: type: string x-go-name: ResourceName authors: x-go-name: Authors type: array items: type: string edition: type: string x-go-name: Edition copyright: type: string x-go-name: Copyright endTime: type: string x-go-name: EndTime StartTime: type: string x-go-name: StartTime policyType: type: string x-go-name: PolicyType imageUrl: type: string x-go-name: ImageUrl imageId: type: string x-go-name: ImageId '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status /api/v1/redeem: post: security: - user-token: [ ] tags: - Redemption summary: Redeem access code description: '`This endpoint redeems the access code for the user.`' operationId: RedeemAccessCode requestBody: content: application/json: schema: required: - accesscode type: object properties: accesscode: type: string description: Access Code x-go-name: Accesscode resourceId: type: string x-go-name: ResourceId required: false responses: '200': description: RedeemAccessCodeResponse200 ok content: application/json: schema: type: object properties: success: type: boolean x-go-name: Success '400': description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status '404': description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status '500': description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status components: schemas: AccessCode: type: object properties: description: type: string x-go-name: Description expiresOn: type: string x-go-name: ExpiresOn name: type: string x-go-name: Name offerId: type: integer format: int64 x-go-name: ID status: type: string x-go-name: Status description: AccessCode contains claim offer information x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models AccessOffer: type: object properties: eBook: type: boolean x-go-name: EBook expiryDate: type: string x-go-name: ExpiryDate id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name product: $ref: '#/components/schemas/SectionProduct' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models AccessProduct: type: object properties: isbn: type: string x-go-name: Isbn resources: type: array items: $ref: '#/components/schemas/AccessResource' x-go-name: Resources x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models AccessResource: type: object properties: id: type: string x-go-name: ID x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Address: title: Address is a data struct for an organization's address. type: object properties: city: type: string x-go-name: City country: type: string x-go-name: Country line1: type: string x-go-name: Line1 line2: type: string x-go-name: Line2 postalCode: type: string x-go-name: PostalCode state: type: string x-go-name: State x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search AdoptAccessCodeRequest: type: object properties: accessCode: type: string x-go-name: AccessCode app: type: string x-go-name: App expiryDate: type: string x-go-name: ExpiryDate instructorXid: type: string x-go-name: InstructorXid isLti: type: boolean x-go-name: IsLtia organizationXid: type: string x-go-name: OrganizationXid product: $ref: '#/components/schemas/AccessProduct' sectionXid: type: string x-go-name: SectionXID x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models AdoptInstitutionalDealRequest: required: - dealId - dealTransactionId - expiryDate - instructorXid - isbn - offerId - organizationXid - sectionId type: object properties: dealId: type: string x-go-name: DealID dealTransactionId: type: string x-go-name: DealTransactionID expiryDate: type: string x-go-name: ExpiryDate flow: type: string x-go-name: Flow instructorXid: type: string x-go-name: InstructorXid isLtia: type: boolean x-go-name: IsLtia isbn: type: string x-go-name: Isbn offerId: type: integer format: int64 x-go-name: OfferID organizationXid: type: string x-go-name: OrganizationXid sectionId: type: integer format: int64 x-go-name: SectionID sectionUuid: type: string x-go-name: SectionUUID sectionXid: type: string x-go-name: SectionXID customJwt: type: string description: Required for lti_ebook workflow x-go-name: CustomJwt x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models AdoptTempAccessRequest: type: object properties: flow: type: string x-go-name: Flow instructorXid: type: string x-go-name: InstructorXid isLti: type: boolean x-go-name: IsLtia organizationXid: type: string x-go-name: OrganizationXid product: $ref: '#/components/schemas/AccessProduct' sectionXid: type: string x-go-name: SectionXID x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models AdoptionResponse: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/purchase Affiliation: required: - role type: object properties: department: type: string x-go-name: Department discipline: type: string description: Required for K12 District|Teacher example: '37' x-go-name: Discipline jobTitle: type: string description: Required for K12 District|Teacher) example: Supervisor x-go-name: JobTitle orgCity: type: string description: Required for K12 Homeschooler|Individual example: New York x-go-name: OrgCity orgCountry: type: string description: Organization country is mandatory when orgXid is empty example: US x-go-name: OrgCountry orgName: type: string description: Organization name is mandatory when orgXid is empty x-go-name: OrgName orgState: type: string description: Required for K12 Homeschooler|Individual example: NY x-go-name: OrgState orgXid: type: string description: Organization xid of the school example: urn:com.mheducation.openlearning:enterprise.identity.organization:qastg.global:organization:0c17bc12-7a76-4490-89ee-c20a51f0054c x-go-name: OrgXID role: type: string example: learner x-go-name: Role segment: type: string description: Segment of the org example: HE x-go-name: Segment description: Affiliation for representing a user's relationship to an org x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Deal: required: - productTitle - resourceId - orgXid type: object properties: name: type: string description: Name of the deal x-go-name: Name productTitle: type: string description: Title of the product x-go-name: ProductTitle resourceId: type: string description: Resoirce Id x-go-name: ResourceId orgXid: type: string description: Organization xid of the school example: urn:com.mheducation.openlearning:enterprise.identity.organization:qastg.global:organization:0c17bc12-7a76-4490-89ee-c20a51f0054c x-go-name: OrgXID description: Deal for representing a IA deal for a user x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models DealResponse: required: - personXid type: object properties: personXid: type: string description: Xid of user x-go-name: PersonXid resourceId: type: string description: Resoirce Id x-go-name: ResourceId redirectUrl: type: string description: Marketing page url x-go-name: RedirectUrl deals: type: array items: $ref: '#/components/schemas/Deal' x-go-name: Deals description: DealResponse for representing available IA deals for a user x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Build: type: object properties: app: type: string description: name of the application example: 'heclr-api' commit: type: string description: GIT Short commit id (SHA) that ie deployed example: '31efab2' buildDate: type: string description: When the container was build example: '05-16-2023 10:20:50 AM' env: type: string description: Current Environment x-go-name: Env example: 'qalv' apiVersion: type: string description: Version of api spec running. this matches with apicurio registry example: '1.0.0' activeColor: type: string description: which color active service is running example: 'blue' deployDate: type: string description: When the application is deployed example: '05-18-2023 12:43:13 PM' deployedBy: type: string description: Who triggered the deployment example: 'firstname-lastname' gitRef: type: string description: Branch Or Tag that triggered the deployment example: 'qalv-23.05.18-1-31efab2' description: Build time information x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/config AppConfig: type: object properties: isRecaptcha: type: boolean description: Captcha is enabled for this service env: type: string description: Current Environment x-go-name: Env example: 'qalv' orgXid: type: string description: Default Organization xid for this environment example: 'urn:com.mheducation.openlearning:enterprise.identity.organization:qalv.global:organization:66253529-3d91-41ec-894e-7cc6704a8862' description: Build time information # x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/config CartCreateRequest: required: - currencyCode - countryCode - sectionId - sectionName - courseName - instructorId - isbn - offerId - orgXid - exitUrl - backUrl - successUrl - sectionXid type: object properties: countryCode: type: string x-go-name: CountryCode currencyCode: type: string x-go-name: CurrencyCode sectionId: type: string x-go-name: SectionId sectionName: type: string x-go-name: SectionName courseName: type: string x-go-name: CourseName instructorId: type: string x-go-name: InstructorId isbn: type: string x-go-name: Isbn offerId: type: integer x-go-name: OfferId orgXid: type: string x-go-name: OrgXid exitUrl: type: string x-go-name: ExitUrl backUrl: type: string x-go-name: BackUrl successUrl: type: string x-go-name: SuccessUrl application: type: string x-go-name: Application sectionXid: type: string x-go-name: SectionXid installationId: type: string x-go-name: InstallationId upgradeType: type: string x-go-name: UpgradeType looseLeafAvailable: type: boolean x-go-name: LooseLeafAvailable rentalAvailable: type: boolean x-go-name: RentalAvailable isLtia: type: boolean x-go-name: IsLtia customJwt: type: string x-go-name: CustomJwt featuredProducts: type: array x-go-name: FeaturedProducts items: type: string x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/cart CartCreateResponse: type : object properties: cartId: type: integer x-go-name: CartId GuestCartCreateResponse: type : object properties: cartId: type: integer x-go-name: CartId productType: type: string x-go-name: ProductType Component: title: Component of a URN. type: string x-go-package: github.mheducation.com/MHEducation/dle-common-urn-lib-go/urn CourtesyAccess: type: object properties: description: type: string x-go-name: Description expiresOn: type: string x-go-name: ExpiresOn name: type: string x-go-name: Name offerId: type: integer format: int64 x-go-name: ID status: type: string x-go-name: Status description: CourtesyAccess contains trial offer information x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models CustomClaimRequest: type: object properties: jwt: type: string description: |- Custom JWT required x-go-name: JWT description: CustomClaimRequest holds the custom jwt x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/lti Department: type: object properties: id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name description: Department holds the name and id of department from RMS x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Discipline: type: object properties: id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name description: Discipline holds the name and id of discipline from RMS x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models EBook: required: - authors - copyright - edition - imageUrl - resourceName - xid type: object properties: accesscode: type: string description: The access code used to get the book x-go-name: AccessCode authors: type: array description: The authors of the book items: type: string x-go-name: Authors copyright: type: string description: The copyright x-go-name: Copyright edition: type: string description: The edition of the book x-go-name: Edition endTime: type: string description: The when the licence expires x-go-name: ExperationDate imageId: type: string description: ImageId The master isbn from EPS x-go-name: ImageID imageUrl: type: string description: The URL of the book image x-go-name: ImageURL isbn10: type: string description: The isbn10 of the book x-go-name: ISBN10 isbn13: type: string description: The isbn of the book x-go-name: ISBN mheid: type: string description: The MHEID of the book x-go-name: MHEID policyType: type: string description: The length of licence x-go-name: LicenseLength resource: type: string description: The ebookid used to launch the book in reader x-go-name: EBookID resourceName: type: string description: The title of the book x-go-name: Title startTime: type: string description: The when the licence starts x-go-name: RedemptionDate xid: type: string description: The xid of the book x-go-name: XID description: EBook is the metadata of the ebooks x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/redemption ExternalResponse: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations application: type: string x-go-name: Application authenticate: type: boolean x-go-name: Authenticate cancelUrl: type: string x-go-name: CancelURL email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms locale: type: string x-go-name: Locale persona: $ref: '#/components/schemas/Persona' phone: type: string x-go-name: Phone product: $ref: '#/components/schemas/ProductResponse' question: type: string x-go-name: Question returnUrl: type: string x-go-name: ReturnURL rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID description: ExternalResponse holds the response x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ForgotPasswordRequest: required: - email type: object properties: app: type: string description: app name example: newconnectdev.mheducation.com x-go-name: App cancelUrl: type: string description: cancelUrl to be appended to forgot password link x-go-name: CancelURL email: type: string description: email of the user example: user@email.com x-go-name: Email flow: type: string description: flow name x-go-name: Flow lmsDisplayName: type: string description: LMS name to be appended to forgot password link example: Blackboard x-go-name: LMSDisplayName loginUrl: type: string description: loginUrl to be appended to forgot password link x-go-name: LoginURL redirectUrl: type: string description: redirectUrl to be appended to forgot password link x-go-name: RedirectURL description: ForgotPasswordRequest holds the request parameters for forgot password x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models InstitutionalDealOption: type: object properties: dealId: type: string x-go-name: DealID dealTransactionId: type: string x-go-name: DealTransactionID expiryDate: type: string x-go-name: ExpiryDate instructorXid: type: string x-go-name: InstructorXid isbn: type: string x-go-name: Isbn offerId: type: integer format: int64 x-go-name: OfferID organizationXid: type: string x-go-name: OrganizationXid sectionId: type: integer format: int64 x-go-name: SectionID sectionUuid: type: string x-go-name: SectionUUID x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models InvitationRequest: type: object properties: app: type: string x-go-name: App emails: type: array items: type: string x-go-name: Emails returnUrl: type: string x-go-name: ReturnURL sectionXid: type: string x-go-name: SectionXid x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/grader InvitationResponse: type: object properties: status: type: string x-go-name: Status x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/grader LTIResponse: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations app: type: string x-go-name: App autoPairAccount: type: boolean x-go-name: AutoPairAccount cancelUrl: type: string x-go-name: CancelURL customJwt: type: string x-go-name: CustomJWT displayName: type: string x-go-name: DisplayName email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms identifier: type: string x-go-name: Identifier isUpsell: type: boolean x-go-name: IsUpsell lmsUserStatus: type: string x-go-name: LMSUserStatus locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question returnUrl: type: string x-go-name: ReturnURL rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status unpair: type: boolean x-go-name: Unpair userType: type: string x-go-name: UserType xid: type: string x-go-name: XID isLMSMatchFound: type: boolean x-go-name: IsLMSMatchFound description: LTIResponse holds the response for the custom LTI x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/lti Language: type: object properties: language: type: string x-go-name: LanguageName languageCode: type: string x-go-name: LanguageCode description: Language holds the code and name of language from RMS x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models LoginRequest: required: - password - username type: object properties: app: type: string description: app name example: newconnectdev.mheducation.com x-go-name: App cancelUrl: type: string description: cancelUrl to be appended to forgot password link x-go-name: CancelURL loginUrl: type: string description: loginUrl to be appended to forgot password link x-go-name: LoginURL password: type: string description: Password x-go-name: Password productId: type: string description: Product id x-go-name: ProductId redirectUrl: type: string description: redirectUrl to be appended to forgot password link x-go-name: RedirectURL username: type: string description: Username x-go-name: Username description: LoginRequest body to authenticate User x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Minicart: type: object properties: cart: type: array items: $ref: '#/components/schemas/MinicartItem' x-go-name: Items cartCount: type: integer format: int64 x-go-name: CartCount count: type: integer format: int64 x-go-name: Count redirectFlow: type: string x-go-name: RedirectFlow x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/cart MinicartItem: type: object properties: businessUnit: type: string x-go-name: BusinessUnit editionNo: type: string x-go-name: EditionNo imageUrl: type: string x-go-name: ImageUrl name: type: string x-go-name: Name productIsbn: type: string x-go-name: ProductISBN productType: type: string x-go-name: ProductType quantity: type: integer format: int64 x-go-name: Quantity x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/cart OptionsResponse: type: object properties: accessCode: $ref: '#/components/schemas/AccessCode' courtesyAccess: $ref: '#/components/schemas/CourtesyAccess' hasLicense: type: boolean description: This is true for active licenses x-go-name: HasLicense purchase: $ref: '#/components/schemas/Purchase' description: OptionsResponse contains the data required for the Access options page x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Organization: type: object properties: active: type: string x-go-name: Active city: type: string x-go-name: City country: type: string x-go-name: Country id: type: string x-go-name: ID managed: type: boolean x-go-name: Managed name: type: string x-go-name: Name segment: type: string x-go-name: Segment state: type: string x-go-name: State type: type: string x-go-name: Type xid: $ref: '#/components/schemas/URN' description: |- Organization is a data struct representative of the data provided by the ORG service on an individual organization. x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationSearchCriteria: type: object properties: name: $ref: '#/components/schemas/OrganizationSearchTerm' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationSearchFilter: type: object properties: country: type: string example: US x-go-name: CountryCode segment: type: string example: HE x-go-name: SegmentCode state: type: string example: NY x-go-name: RegionCode x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationSearchRequest: type: object properties: filter: $ref: '#/components/schemas/OrganizationSearchFilter' search: $ref: '#/components/schemas/OrganizationSearchCriteria' size: type: integer format: int64 example: 10 x-go-name: Size sortBy: type: string example: name x-go-name: SortBy sortOrder: type: string example: ASC x-go-name: SortOrder start: type: integer format: int64 x-go-name: Start description: OrganizationSearchRequest is a struct for the org search request x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationSearchResponse: type: object properties: content: type: array items: $ref: '#/components/schemas/OrganizationSearchResult' x-go-name: Content size: type: integer format: int64 x-go-name: Size start: type: integer format: int64 x-go-name: Start totalElements: type: integer format: int64 x-go-name: TotalElements description: OrganizationSearchResponse is a struct for the org search response x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationSearchResult: type: object properties: active: type: boolean x-go-name: Active address: $ref: '#/components/schemas/Address' managed: type: boolean x-go-name: Managed name: type: string x-go-name: Name segment: type: string x-go-name: Segment type: type: string x-go-name: Type xid: type: string x-go-name: XID x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationSearchTerm: type: object properties: term: type: string example: University x-go-name: Term x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search OrganizationHierarchyResponse: type: object properties: id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name xid: type: string x-go-name: XID parentXid: type: string x-go-name: ParentXid x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search Pageable: type: object properties: offset: type: integer format: int64 x-go-name: OffSet pageNumber: type: integer format: int64 x-go-name: PageNumber pageSize: type: integer format: int64 x-go-name: PageSize paged: type: boolean x-go-name: Paged sort: type: array items: $ref: '#/components/schemas/Sort' x-go-name: Sort unpaged: type: boolean x-go-name: Unpaged description: Pageable provides paging information x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search Persona: type: object properties: role: type: string x-go-name: Role segment: type: string x-go-name: Segment x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductIASearchRequest: required: - isbn - organizationXid - segment type: object properties: isbn: type: string x-go-name: Isbn segment: type: string enum: - HE x-go-name: Segment organizationXid: type: string x-go-name: OrganizationXid x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductIASearchResponse: type: object properties: isInclusiveAccessAvailable: type: boolean x-go-name: IsInclusiveAccessAvailable isEBookAvailable: type: boolean x-go-name: IsEBookAvailable isEverGreen: type: boolean x-go-name: IsEverGreen isbn: type: string x-go-name: Isbn title: type: string x-go-name: Title edition: type: string x-go-name: Edition copyright: type: string x-go-name: Copyright authors: type: array items: type: string x-go-name: Authors x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductLicenseResponse: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus description: Product license details x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductPurchaseOption: type: object properties: isPayPalAvailable: type: boolean x-go-name: IsPayPalAvailable offers: type: array items: $ref: '#/components/schemas/PurchaseOffer' x-go-name: Offers x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductPurchaseOptionsRequest: required: - organizationXid type: object properties: app: type: string x-go-name: App organizationXid: type: string x-go-name: OrganizationXid x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductPurchaseOptionsResponse: type: object properties: isAccessCodeAvailable: type: boolean x-go-name: IsAccessCodeAvailable isPurchaseAvailable: type: boolean x-go-name: IsPurchaseAvailable purchase: $ref: '#/components/schemas/ProductPurchaseOption' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ProductResponse: type: object properties: author: type: array items: type: string x-go-name: Author bigCoverImage: type: string x-go-name: BigCoverImage copyrightYear: type: string x-go-name: CopyrightYear currencyCode: type: string x-go-name: CurrencyCode edition: type: string x-go-name: Edition id: type: string x-go-name: Id price: type: number format: double x-go-name: Price productHomePage: type: string x-go-name: ProductHomePage smallCoverImage: type: string x-go-name: SmallCoverImage title: type: string x-go-name: Title userHomePage: type: string x-go-name: UserHomePage description: ProductResponse product details x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Purchase: type: object properties: currencyCode: type: string x-go-name: CurrencyCode description: type: string x-go-name: Description expiresOn: type: string x-go-name: ExpiresOn name: type: string x-go-name: Name offerId: type: integer format: int64 x-go-name: ID price: type: number format: float x-go-name: Price status: type: string x-go-name: Status description: Purchase contains purchase offer information x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models PurchaseOffer: type: object properties: accessUntil: type: string x-go-name: AccessUntil currencyCode: type: string x-go-name: CurrencyCode description: type: string x-go-name: Description ebook: type: boolean x-go-name: EBook ecommIsbn: type: string x-go-name: EcommIsbn id: type: integer format: int64 x-go-name: ID isbn: type: string x-go-name: Isbn pdpPrice: type: string x-go-name: PDPPrice price: type: string x-go-name: Price termsInDays: type: integer format: int64 x-go-name: TermsInDays title: type: string x-go-name: Title type: type: string x-go-name: Type x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models PurchaseOption: type: object properties: isPayPalAvailable: type: boolean x-go-name: IsPayPalAvailable offers: type: array items: $ref: '#/components/schemas/PurchaseOffer' x-go-name: Offers product: $ref: '#/components/schemas/SectionProduct' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models RedeemAccessCodeRequest: required: - accesscode type: object properties: accesscode: type: string description: The access code to redeem x-go-name: AccessCode description: RedeemAccessCodeRequest is the body of the request to redeem an access code x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/redemption RentalOption: type: object properties: authors: type: array items: type: string x-go-name: Authors bundleIsbn10: type: string x-go-name: BundleIsbn10 bundleIsbn13: type: string x-go-name: BundleIsbn13 edition: type: integer format: int64 x-go-name: Edition imageUrl: type: string x-go-name: ImageURL isbn10: type: string x-go-name: Isbn10 isbn13: type: string x-go-name: Isbn13 price: type: string x-go-name: Price term: type: string x-go-name: Term title: type: string x-go-name: Title url: type: string x-go-name: URL x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ResetPasswordRequest: required: - password - resetCode type: object properties: email: type: string description: email of the user for the sampling flow only example: user@email.com x-go-name: Email app: type: string description: app name example: newconnectdev.mheducation.com x-go-name: App cancelUrl: type: string description: cancelUrl to be appended to forgot password link x-go-name: CancelURL hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms loginUrl: type: string description: loginUrl to be appended to forgot password link x-go-name: LoginURL password: type: string description: new password of the user example: Abc12345 x-go-name: Password redirectUrl: type: string description: redirectUrl to be appended to forgot password link x-go-name: RedirectURL resetCode: type: string description: reset code from the email x-go-name: ResetCode description: ResetPasswordRequest holds the request for reset password x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SearchOrgResponse: type: object properties: content: type: array items: $ref: '#/components/schemas/Organization' x-go-name: Content first: type: boolean x-go-name: First last: type: boolean x-go-name: Last number: type: integer format: int64 x-go-name: Number numberOfElements: type: integer format: int64 x-go-name: NumberOfElements pageable: $ref: '#/components/schemas/Pageable' size: type: integer format: int64 x-go-name: Size totalElements: type: integer format: int64 x-go-name: TotalElements totalPages: type: integer format: int64 x-go-name: TotalPages description: SearchOrgResponse is a struct for the org search response x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search SectionEnrollmentResponse: type: object properties: isEnrolled: type: boolean x-go-name: IsEnrolled x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionExternalIdentifier: type: object properties: externalId: type: string x-go-name: ExternalID sourceId: type: string x-go-name: SourceID sourceName: type: string x-go-name: SourceName x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionInstructor: type: object properties: firstName: type: string x-go-name: FirstName lastName: type: string x-go-name: LastName rmsUserId: type: string x-go-name: RMSUserID xid: type: string x-go-name: XID x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionLicenseResponse: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus licenseType: type: string x-go-name: LicenseType personXid: type: string x-go-name: PersonXid x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionProduct: type: object properties: authors: type: array items: type: string x-go-name: Authors bigImageUrl: type: string x-go-name: BigImageURL edition: type: integer format: int64 x-go-name: Edition imageUrl: type: string x-go-name: ImageURL isbn: type: string x-go-name: Isbn resources: type: array items: $ref: '#/components/schemas/SectionProductResource' x-go-name: Resources title: type: string x-go-name: Title description: SectionProduct is product response x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionProductResource: type: object properties: category: type: string x-go-name: Category id: type: string x-go-name: ID name: type: string x-go-name: Name x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionPurchaseOptionsResponse: type: object properties: institutionalDeal: $ref: '#/components/schemas/InstitutionalDealOption' isAccessCodeAvailable: type: boolean x-go-name: IsAccessCodeAvailable isInstitutionalDealAvailable: type: boolean x-go-name: IsInstitutionalDealAvailable isLooseLeafAvailable: type: boolean x-go-name: IsLooseLeafAvailable isPurchaseAvailable: type: boolean x-go-name: IsPurchaseAvailable isRentalAvailable: type: boolean x-go-name: IsRentalAvailable isTemporaryAccessAvailable: type: boolean x-go-name: IsTemporaryAccessAvailable isUpsellAvailable: type: boolean x-go-name: IsUpsellAvailable purchase: $ref: '#/components/schemas/PurchaseOption' rental: type: array items: $ref: '#/components/schemas/RentalOption' x-go-name: RentalOption upsell: $ref: '#/components/schemas/PurchaseOption' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionResponse: type: object properties: code: type: string x-go-name: Code courseName: type: string x-go-name: CourseName externalIdentifiers: type: array items: $ref: '#/components/schemas/SectionExternalIdentifier' x-go-name: ExternalIdentifiers instructor: $ref: '#/components/schemas/SectionInstructor' name: type: string x-go-name: Name organizationCountry: type: string x-go-name: OrganizationCountry organizationXid: type: string x-go-name: OrganizationXID product: $ref: '#/components/schemas/SectionProduct' regStatus: type: string x-go-name: RegistrationStatus startDate: type: string description: StartDate is only set when registration status == "not_opened" for UI to display x-go-name: StartDate status: type: string x-go-name: Status studentFriendlyName: type: string x-go-name: StudentFriendlyName xid: type: string x-go-name: XID description: SectionResponse section details x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SecurityQuestion: type: object properties: questionText: type: string x-go-name: QuestionText description: SecurityQuestion holds the RMS security questions x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SendMagicLinkRequest: required: - email - resourceId type: object properties: app: type: string x-go-name: App email: type: string description: email of the user x-go-name: Email redirectUrl: type: string x-go-name: RedirectUrl resourceId: type: string x-go-name: ResourceId description: SendMagicLinkRequest holds the request to send magic link x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SendAdminMagicLinkRequest: required: - email - givenName - familyName - role type: object properties: email: type: string description: email of the user x-go-name: Email givenName: type: string x-go-name: first name of the user familyName: type: string x-go-name: last name of the user role: type: string x-go-name: role that will be assigned to the user for the org tied to the email domain description: SendAdminMagicLinkRequest holds the request to send magic link for admin users x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models Sort: type: object properties: sorted: type: boolean x-go-name: Sorted unsorted: type: boolean x-go-name: Unsorted description: Sort provides sort information x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/search Source: type: object properties: externalId: type: string x-go-name: ExternalID sourceId: type: string x-go-name: SourceID sourceName: type: string x-go-name: SourceName description: Source maps the sources in IDM x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models TokenResponse: type: object properties: access_token: type: string x-go-name: Token aud: type: string x-go-name: Audience client_id: type: string x-go-name: ClientID client_xid: type: string x-go-name: ClientXID default_role: type: string x-go-name: DefaultRole exp: type: integer format: int64 x-go-name: ExpiresAt expires_in: type: integer format: int64 x-go-name: ExpiresIn family_name: type: string x-go-name: Familyname given_name: type: string x-go-name: Givenname iat: type: integer format: int64 x-go-name: IssuedAt iss: type: string x-go-name: Issuer jti: type: string x-go-name: ID nbf: type: integer format: int64 x-go-name: NotBefore person_xid: type: string x-go-name: PersonXID redirectUrl: type: string x-go-name: RedirectURL scope: type: array items: type: string x-go-name: Scope session_id: type: string x-go-name: SessionID session_timeout: type: integer format: int64 x-go-name: SessionTimeout session_xid: type: string x-go-name: SessionXID sub: type: string x-go-name: Subject temp_auth: type: boolean x-go-name: TempAuth token_type: type: string x-go-name: TokenType user_name: type: string x-go-name: Username xid: type: string x-go-name: XID description: TokenResponse is the response back from token service x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/account URN: title: URN external identifier for DLE. type: object properties: EntityType: $ref: '#/components/schemas/Component' System: $ref: '#/components/schemas/Component' x-go-package: github.mheducation.com/MHEducation/dle-common-urn-lib-go/urn UserUpdateRequest: type: object properties: jwt: type: string description: |- Custom JWT required x-go-name: JWT password: type: string description: required x-go-name: Password description: UserUpdateRequest contains the request for LTI update x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/lti ValidateAccessCodeRequest: type: object properties: accessCode: type: string x-go-name: AccessCode organizationXid: type: string x-go-name: OrganizationXid product: $ref: '#/components/schemas/AccessProduct' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ValidateAccessCodeResponse: type: object properties: offer: $ref: '#/components/schemas/AccessOffer' product: $ref: '#/components/schemas/SectionProduct' state: type: string x-go-name: State x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ValidateTempAccessRequest: type: object properties: organizationXid: type: string x-go-name: OrganizationXid product: $ref: '#/components/schemas/AccessProduct' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ValidateTempAccessResponse: type: object properties: offer: $ref: '#/components/schemas/AccessOffer' product: $ref: '#/components/schemas/SectionProduct' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models VerifyMagicLinkRequest: required: - code type: object properties: code: type: string description: code from the email x-go-name: Code resourceId: type: string description: resource id from query param if present x-go-name: ResourceId description: VerifyMagicLinkRequest holds the request to verify magic link x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models MagicLinkUserLicenseRequest: properties: resourceId: type: string description: resource id from query param if present x-go-name: ResourceId description: MagicLinkUserLicenseRequest holds the request to adopt or get delas x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models VerifyResetPasswordTokenRequest: required: - email - resetCode type: object properties: email: type: string description: email of the user example: user@email.com x-go-name: Email resetCode: type: string description: reset code from the email x-go-name: ResetCode description: VerifyResetPasswordTokenRequest holds the request to verify the reset password token x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models ResourceIAAdoptionRequest: required: - resourceId - personXid - organizationXid type: object properties: resourceId: type: string description: resource id x-go-name: ResourceId personXid: type: string description: person xid x-go-name: PersonXid organizationXid: type: string description: organization xid x-go-name: OrganizationXid description: ResourceIAAdoptionRequest holds the request to adopt ia deal for resource x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models OptInData: type: object properties: dealId: type: string x-go-name: DealId dealTransactionId: type: string x-go-name: DealTransactionId isbn: type: string x-go-name: Isbn ecomIsbn: type: string x-go-name: EcomIsbn expiryDate: type: string x-go-name: ExpiryDate numberOfAdoptions: type: integer format: int64 x-go-name: NumberOfAdoptions previewMode: type: boolean x-go-name: PreviewMode customBillingIsbn: type: string x-go-name: CustomBillingIsbn price: type: string x-go-name: Price x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models OptOutData: type: object properties: offerId: type: integer format: int64 x-go-name: OfferId type: type: string x-go-name: Type title: type: string x-go-name: Title description: type: string x-go-name: Description isbn: type: string x-go-name: Isbn price: type: string x-go-name: Price ebook: type: boolean x-go-name: Ebook pdpPrice: type: string x-go-name: PDPPrice termsOfOffer: type: string x-go-name: TermsOfOffer ecommIsbn: type: string x-go-name: EcommIsbn expiryDate: type: string x-go-name: ExpiryDate x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionOptInOutInfo: type: object properties: optInData: $ref: '#/components/schemas/OptInData' optOutData: $ref: '#/components/schemas/OptOutData' isMultipleOfferForOptOut: type: boolean x-go-name: IsMultipleOfferForOptOut currencyCode: type: string x-go-name: CurrencyCode countryCode: type: string x-go-name: CountryCode sectionUuid: type: string x-go-name: SectionUUID sectionID: type: integer format: int64 x-go-name: SectionID instructorXid: type: string x-go-name: InstructorXid organizationXid: type: string x-go-name: OrganizationXid expiryDate: type: string x-go-name: ExpiryDate x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SectionOptInOutResponse: type: object properties: isSchool: type: string x-go-name: IsSchool showPurchaseOptions: type: boolean x-go-name: ShowPurchaseOptions ignoreIACheck: type: boolean x-go-name: IgnoreIACheck isIAAdopted: type: boolean x-go-name: IsIAAdopted showOptInOut: type: boolean x-go-name: showOptInOut instructorXid: type: string x-go-name: InstructorXid organizationXid: type: string x-go-name: OrganizationXid expiryDate: type: string x-go-name: ExpiryDate optInOutInfo: $ref: '#/components/schemas/SectionOptInOutInfo' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models userSectionOptInOutMetaData: type: object properties: sectionXid: type: string x-go-name: SectionXid expiryDate: type: string x-go-name: ExpiryDate x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models UserOptInOutDetailsResponse: type: object properties: productIsbn: type: string x-go-name: ProductIsbn productDescription: type: string x-go-name: ProductDescription edition: type: string x-go-name: Edition formatCode: type: string x-go-name: FormatCode FormatDescription: type: boolean x-go-name: FormatDescription authors: x-go-name: Authors type: array items: type: string isbn10: type: string x-go-name: Isbn10 isbn13: type: string x-go-name: Isbn13 coverImage: type: string x-go-name: CoverImage virtual: type: boolean x-go-name: Virtual mhid: type: string x-go-name: Isbn13 productSegment: type: string x-go-name: ProductSegment productBrandingCode: type: string x-go-name: ProductBrandingCode copyrightYear: type: integer format: int64 x-go-name: CopyrightYear optInStatus: type: string x-go-name: OptInStatus isUserOptedIn: type: boolean x-go-name: IsUserOptedIn lastUpdatedDate: type: string x-go-name: LastUpdatedDate expiryDate: type: string x-go-name: ExpiryDate userSectionOptInOutMetaData: $ref: '#/components/schemas/userSectionOptInOutMetaData' x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SaveUserOptInOutDataRequest: type: object properties: dealId: type: string x-go-name: DealID dealTransactionId: type: string x-go-name: DealTransactionID expiryDate: type: string x-go-name: ExpiryDate instructorXid: type: string x-go-name: InstructorXid isbn: type: string x-go-name: Isbn offerId: type: integer format: int64 x-go-name: OfferID organizationXid: type: string x-go-name: OrganizationXid sectionId: type: integer format: int64 x-go-name: SectionID sectionUuid: type: string x-go-name: SectionUUID action: type: string x-go-name: Action x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models SaveUserOptInOutDataResponse: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus x-go-package: github.mheducation.com/MHEducation/heclr-api/pkg/models responses: Ok: description: Response200 ok content: application/json: schema: type: object properties: givenName: type: string description: Given name of the user x-go-name: GivenName valid: type: string description: Is result valid example: 'true' enum: - 'true' x-go-name: Result ResourceLicenseResponse200: description: ResourceLicenseResponse200 Resource License Response content: application/json: schema: type: object properties: licenseExpiryDate: type: string x-go-name: LicenseExpiryDate licenseStatus: type: string x-go-name: LicenseStatus accessCodeResponse200: description: AccessCodeResponse200 AccessCode Response content: application/json: schema: $ref: '#/components/schemas/EBook' accessOptionsResponse200: description: AccessOptionsResponse200 Access Response content: application/json: schema: $ref: '#/components/schemas/OptionsResponse' adoptAccessCodeResponse200: description: AdoptAccessCodeResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' adoptInclusiveAccessResponse200: description: AdoptInclusiveAccessResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' adoptTempAccessResponse200: description: AdoptTempAccessResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' customLtiResponse200: description: CustomLtiResponse200 ok content: application/json: schema: $ref: '#/components/schemas/LTIResponse' departmentListResponse200: description: DepartmentListResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/Department' deploymentResponse200: description: DeploymentResponse200 ok content: application/json: schema: $ref: '#/components/schemas/Build' disciplinesListResponse200: description: DisciplinesListResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/Discipline' envInfoResponse200: description: EnvInfoResponse200 ok content: application/json: schema: type: object properties: env: type: string x-go-name: Env errorResponse400: description: ErrorResponse400 Bad request content: application/json: schema: type: object properties: code: type: string description: The error code example: bad.request x-go-name: Code message: type: string description: The error message example: Bad request x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 400 x-go-name: Status errorResponse401: description: ErrorResponse401 Not Authorized content: application/json: schema: type: object properties: code: type: string description: The error code example: GEN-UNAUTHORIZED x-go-name: Code message: type: string description: The error message example: Unauthorized x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 401 x-go-name: Status errorResponse403: description: ErrorResponse403 Forbidden content: application/json: schema: type: object properties: code: type: string description: The error code example: forbidden x-go-name: Code message: type: string description: The error message example: invalid system token, forbidden, or locked x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 403 x-go-name: Status errorResponse404: description: ErrorResponse404 Not-Found content: application/json: schema: type: object properties: code: type: string description: The error code example: not.found x-go-name: Code message: type: string description: The error message example: Not found x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 404 x-go-name: Status errorResponse409: description: ErrorResponse409 Conflict content: application/json: schema: type: object properties: code: type: string description: The error code example: conflict x-go-name: Code message: type: string description: The error message example: Non Unique Email x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 409 x-go-name: Status errorResponse500: description: ErrorResponse500 Internal-Server Error content: application/json: schema: type: object properties: code: type: string description: The error code example: internal.server.error x-go-name: Code message: type: string description: The error message example: Internal server error x-go-name: Message status: type: integer description: HTTP status code, same as on response format: int64 example: 500 x-go-name: Status externalCustomResponse200: description: ExternalCustomResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations application: type: string x-go-name: Application authenticate: type: boolean x-go-name: Authenticate cancelUrl: type: string x-go-name: CancelURL email: type: string x-go-name: Email hasAgreedTerms: type: boolean x-go-name: HasAgreedTerms product: $ref: '#/components/schemas/ProductResponse' returnUrl: type: string x-go-name: ReturnURL externalUserResponse200: description: ExternalUserResponse200 ok content: application/json: schema: $ref: '#/components/schemas/ExternalResponse' invitationResponse200: description: invitationResponse200 ok content: application/json: schema: $ref: '#/components/schemas/InvitationResponse' languagesListResponse200: description: LanguagesListResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/Language' minicartResponse200: description: MinicartResponse200 Minicart Response content: application/json: schema: $ref: '#/components/schemas/Minicart' organizationSearchResponse200: description: OrganizationSearchResponse200 Organization Search Response content: application/json: schema: $ref: '#/components/schemas/OrganizationSearchResponse' organizationHierarchyResponse200: description: OrganizationHierarchyResponse200 Organization Hierarchy Response content: application/json: schema: type: array items: $ref: '#/components/schemas/OrganizationHierarchyResponse' productLicenseResponse200: description: ProductLicenseResponse200 Product Response content: application/json: schema: $ref: '#/components/schemas/ProductLicenseResponse' productPurchaseOptionsResponse200: description: ProductPurchaseOptionsResponse200 Product Response content: application/json: schema: $ref: '#/components/schemas/ProductPurchaseOptionsResponse' productResponse200: description: ProductResponse200 Product Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' responseOK: description: ResponseOK ok content: {} searchOrgResponse200: description: SearchOrgResponse200 Access Response content: application/json: schema: $ref: '#/components/schemas/SearchOrgResponse' sectionEnrollmentResponse200: description: SectionEnrollmentResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionEnrollmentResponse' sectionLicenseResponse200: description: SectionLicenseResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionLicenseResponse' sectionPurchaseOptionsResponse200: description: SectionPurchaseOptionsResponse Section Purchase Options Response content: application/json: schema: $ref: '#/components/schemas/SectionPurchaseOptionsResponse' sectionResponse200: description: SectionResponse200 Section Response content: application/json: schema: $ref: '#/components/schemas/SectionResponse' securityQuestionsResponse200: description: SecurityQuestionsResponse200 ok content: application/json: schema: type: array items: $ref: '#/components/schemas/SecurityQuestion' tokenResponse200: description: TokenResponse200 ok content: application/json: schema: $ref: '#/components/schemas/TokenResponse' userDetailsResponse200: description: UserDetailsResponse200 User details Response content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName persona: $ref: '#/components/schemas/Persona' phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID userProfileResponse200: description: UserProfileResponse200 User profile Response content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName phone: type: string x-go-name: Phone question: type: string x-go-name: Question sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID userResponse200: description: UserResponse200 ok content: application/json: schema: type: object properties: affiliations: type: array items: $ref: '#/components/schemas/Affiliation' x-go-name: Affiliations email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName locale: type: string x-go-name: Locale phone: type: string x-go-name: Phone question: type: string x-go-name: Question rmsSessionId: type: string x-go-name: RmsSessionID sources: type: array items: $ref: '#/components/schemas/Source' x-go-name: Sources status: type: string x-go-name: Status userType: type: string x-go-name: UserType xid: type: string x-go-name: XID userResponseBasic200: description: UserResponseBasic200 ok content: application/json: schema: type: object properties: email: type: string x-go-name: Email familyName: type: string x-go-name: FamilyName givenName: type: string x-go-name: GivenName userName: type: string x-go-name: UserName xid: type: string x-go-name: XID validateAccessCodeResponse200: description: ValidateAccessCodeResponse200 ok content: application/json: schema: $ref: '#/components/schemas/ValidateAccessCodeResponse' sectionOptInOutResponse200: description: SectionOptInOutResponse200 OptInOut Response content: application/json: schema: $ref: '#/components/schemas/SectionOptInOutResponse' userOptInOutDetailsResponse200: description: UserOptInOutDetailsResponse200 OptInOut Response content: application/json: schema: type: array items: $ref: '#/components/schemas/UserOptInOutDetailsResponse' saveUserOptInOutDataResponse200: description: SaveUserOptInOutDataResponse200 ok content: application/json: schema: $ref: '#/components/schemas/AdoptionResponse' securitySchemes: user-token: type: http description: User Token (JWT) scheme: bearer bearerFormat: JWT profile-cookie: type : apiKey in: cookie name: MH_PROFILE description: Profile Cookie aleks-custom-token: type : apiKey in: header name: Custom-Token description: Custom JWT for Aleks simnet-custom-token: type : apiKey in: header name: Custom-Token description: Custom JWT for Simnet grader-custom-token: type : apiKey in: header name: Custom-Token description: Custom JWT for Grader system-token: type: http description: System Token (JWT) scheme: bearer bearerFormat: JWT