PUT api/ascendlti/accesscode/redeem

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AccessCode	string	None.
Isbn	string	None.
UaId	string	None.
PersonId	globally unique identifier	None.
CourseId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AccessCode": "sample string 1",
  "Isbn": "sample string 2",
  "UaId": "sample string 3",
  "PersonId": "5b475025-01d1-46d3-a7da-d0ef6cb46758",
  "CourseId": "sample string 5"
}

application/xml, text/xml

Sample:

<LmsAccessCodeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/A2.Jbl.Api.Models">
  <AccessCode>sample string 1</AccessCode>
  <CourseId>sample string 5</CourseId>
  <Isbn>sample string 2</Isbn>
  <PersonId>5b475025-01d1-46d3-a7da-d0ef6cb46758</PersonId>
  <UaId>sample string 3</UaId>
</LmsAccessCodeData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfLmsAccessCodeInfo

Name	Type	Additional information
Error	boolean	None.
Ok	boolean	None.
Errors	Collection of Error	None.
Data	LmsAccessCodeInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": false,
  "Ok": true,
  "Errors": [
    {
      "Id": "sample string 1",
      "Entity": "sample string 2",
      "Message": "sample string 3"
    },
    {
      "Id": "sample string 1",
      "Entity": "sample string 2",
      "Message": "sample string 3"
    }
  ],
  "Data": {
    "UseCode": "sample string 1",
    "CourseName": "sample string 2",
    "Isbn": "sample string 3",
    "IsCodeUsed": true,
    "DateUsed": "2025-07-17T06:32:04.0230057-04:00",
    "IsCodeValid": true,
    "ExpirationInDays": 7,
    "ProductIsbns": [
      "sample string 1",
      "sample string 2"
    ],
    "UseCodeId": "ce66ae53-58cd-4985-82f6-86d463ffe1a1",
    "RedeemedBy": 1
  }
}

application/xml, text/xml

Sample:

<ResultOfLmsAccessCodeInfownekxRBL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/A2.Jbl.Api.Models">
  <Data>
    <CourseName>sample string 2</CourseName>
    <DateUsed>2025-07-17T06:32:04.0230057-04:00</DateUsed>
    <ExpirationInDays>7</ExpirationInDays>
    <IsCodeUsed>true</IsCodeUsed>
    <IsCodeValid>true</IsCodeValid>
    <Isbn>sample string 3</Isbn>
    <ProductIsbns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductIsbns>
    <RedeemedBy>MyAccount</RedeemedBy>
    <UseCode>sample string 1</UseCode>
    <UseCodeId>ce66ae53-58cd-4985-82f6-86d463ffe1a1</UseCodeId>
  </Data>
  <Error>false</Error>
  <Errors>
    <Error>
      <Entity>sample string 2</Entity>
      <Id>sample string 1</Id>
      <Message>sample string 3</Message>
    </Error>
    <Error>
      <Entity>sample string 2</Entity>
      <Id>sample string 1</Id>
      <Message>sample string 3</Message>
    </Error>
  </Errors>
  <Ok>true</Ok>
</ResultOfLmsAccessCodeInfownekxRBL>