GET api/Product/GetByOcpId/{ocpId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ocpId

string

Required

Body Parameters

None.

Response Information

Resource Description

ResultOfProductDetail
NameDescriptionTypeAdditional information
Error

boolean

None.

Ok

boolean

None.

Errors

Collection of Error

None.

Data

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": {
    "LmsUrlDetail": {
      "linkType": 1,
      "ocpID": "sample string 2",
      "linkToLoginPage": "sample string 3",
      "launchLinkURL": "sample string 4",
      "launchLinkText": "sample string 5",
      "externalLink": "sample string 6",
      "navigateCourseCode": "sample string 7",
      "personTypeCode": "sample string 8",
      "bookCode": "sample string 9",
      "bundleBookCode": "sample string 10",
      "isOpenEnrollment": true,
      "needsMedical": true,
      "needsMoodleCheck": true,
      "hasFinalExam": true,
      "navigateURL": "sample string 15",
      "groupCodeID": "sample string 16",
      "InstructorResourceType": 17,
      "navigate2CourseCode": "sample string 18",
      "openEnrollmentCourseCode": "sample string 19",
      "EbookId": "sample string 20",
      "EbookPageId": "sample string 21"
    },
    "Id": "sample string 1",
    "Name": "sample string 2",
    "ISBN": "sample string 3",
    "ISBN13": "sample string 4",
    "CourseName": "sample string 5",
    "CourseId": "sample string 6",
    "Section": "sample string 7",
    "SectionComplete": "sample string 8",
    "Expiration": "2025-07-17T06:55:23.6416623-04:00",
    "Grade": "sample string 10",
    "RedemtionDate": "2025-07-17T06:55:23.6416623-04:00",
    "ProductCertificateUrl": "sample string 12",
    "ContinuingEdCertificateUrl": "sample string 13",
    "ContinuingEdDlgType": 0,
    "Type": 0,
    "LmsUrl": "sample string 14",
    "RenewalUrl": "sample string 15",
    "GroupId": "sample string 16",
    "TestPrepResultsUrl": "sample string 17",
    "InstructorEmail": "sample string 18",
    "InstructorName": "sample string 19",
    "SkillCheckComplete": true,
    "ShowSkillCheckComplete": true,
    "ShowGrade": true,
    "ShowSectionComplete": true,
    "EnrollmentType": 0,
    "ShowProductPurchaseUrl": true,
    "ProductStatus": "sample string 25",
    "ShowProductStatus": true,
    "CertificateTypes": [
      0,
      0
    ],
    "EnablePageReloadOnFocus": true,
    "SubscriptionUrl": "sample string 28",
    "EnableRequestCourseCopy": true,
    "EnableManageProductAccess": true,
    "HideProductLaunchLink": true,
    "ProductDetailPageMessage": "sample string 32",
    "ScRef": "sample string 33",
    "ProductClass": "sample string 34",
    "ProductGroup": "sample string 35",
    "HideProductExpiration": true,
    "IsProductSuspended": true,
    "ProductUserType": 0
  }
}

application/xml, text/xml

Sample:
<ResultOfProductDetail5CPvfSRI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/A2.Jbl.Api.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/JBLearning.Model.Models">
    <d2p1:CertificateTypes>
      <d2p1:CourseCertificateType>None</d2p1:CourseCertificateType>
      <d2p1:CourseCertificateType>None</d2p1:CourseCertificateType>
    </d2p1:CertificateTypes>
    <d2p1:ContinuingEdCertificateUrl>sample string 13</d2p1:ContinuingEdCertificateUrl>
    <d2p1:ContinuingEdDlgType>CECBEMS</d2p1:ContinuingEdDlgType>
    <d2p1:CourseId>sample string 6</d2p1:CourseId>
    <d2p1:CourseName>sample string 5</d2p1:CourseName>
    <d2p1:EnableManageProductAccess>true</d2p1:EnableManageProductAccess>
    <d2p1:EnablePageReloadOnFocus>true</d2p1:EnablePageReloadOnFocus>
    <d2p1:EnableRequestCourseCopy>true</d2p1:EnableRequestCourseCopy>
    <d2p1:EnrollmentType>EnterCourseId</d2p1:EnrollmentType>
    <d2p1:Expiration>2025-07-17T06:55:23.6416623-04:00</d2p1:Expiration>
    <d2p1:Grade>sample string 10</d2p1:Grade>
    <d2p1:GroupId>sample string 16</d2p1:GroupId>
    <d2p1:HideProductExpiration>true</d2p1:HideProductExpiration>
    <d2p1:HideProductLaunchLink>true</d2p1:HideProductLaunchLink>
    <d2p1:ISBN>sample string 3</d2p1:ISBN>
    <d2p1:ISBN13>sample string 4</d2p1:ISBN13>
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:InstructorEmail>sample string 18</d2p1:InstructorEmail>
    <d2p1:InstructorName>sample string 19</d2p1:InstructorName>
    <d2p1:IsProductSuspended>true</d2p1:IsProductSuspended>
    <d2p1:LmsUrl>sample string 14</d2p1:LmsUrl>
    <d2p1:LmsUrlDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/">
      <d3p1:EbookId>sample string 20</d3p1:EbookId>
      <d3p1:EbookPageId>sample string 21</d3p1:EbookPageId>
      <d3p1:InstructorResourceType>17</d3p1:InstructorResourceType>
      <d3p1:bookCode>sample string 9</d3p1:bookCode>
      <d3p1:bundleBookCode>sample string 10</d3p1:bundleBookCode>
      <d3p1:externalLink>sample string 6</d3p1:externalLink>
      <d3p1:groupCodeID>sample string 16</d3p1:groupCodeID>
      <d3p1:hasFinalExam>true</d3p1:hasFinalExam>
      <d3p1:isOpenEnrollment>true</d3p1:isOpenEnrollment>
      <d3p1:launchLinkText>sample string 5</d3p1:launchLinkText>
      <d3p1:launchLinkURL>sample string 4</d3p1:launchLinkURL>
      <d3p1:linkToLoginPage>sample string 3</d3p1:linkToLoginPage>
      <d3p1:linkType>1</d3p1:linkType>
      <d3p1:navigate2CourseCode>sample string 18</d3p1:navigate2CourseCode>
      <d3p1:navigateCourseCode>sample string 7</d3p1:navigateCourseCode>
      <d3p1:navigateURL>sample string 15</d3p1:navigateURL>
      <d3p1:needsMedical>true</d3p1:needsMedical>
      <d3p1:needsMoodleCheck>true</d3p1:needsMoodleCheck>
      <d3p1:ocpID>sample string 2</d3p1:ocpID>
      <d3p1:openEnrollmentCourseCode>sample string 19</d3p1:openEnrollmentCourseCode>
      <d3p1:personTypeCode>sample string 8</d3p1:personTypeCode>
    </d2p1:LmsUrlDetail>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:ProductCertificateUrl>sample string 12</d2p1:ProductCertificateUrl>
    <d2p1:ProductClass>sample string 34</d2p1:ProductClass>
    <d2p1:ProductDetailPageMessage>sample string 32</d2p1:ProductDetailPageMessage>
    <d2p1:ProductGroup>sample string 35</d2p1:ProductGroup>
    <d2p1:ProductStatus>sample string 25</d2p1:ProductStatus>
    <d2p1:ProductUserType>Learner</d2p1:ProductUserType>
    <d2p1:RedemtionDate>2025-07-17T06:55:23.6416623-04:00</d2p1:RedemtionDate>
    <d2p1:RenewalUrl>sample string 15</d2p1:RenewalUrl>
    <d2p1:ScRef>sample string 33</d2p1:ScRef>
    <d2p1:Section>sample string 7</d2p1:Section>
    <d2p1:SectionComplete>sample string 8</d2p1:SectionComplete>
    <d2p1:ShowGrade>true</d2p1:ShowGrade>
    <d2p1:ShowProductPurchaseUrl>true</d2p1:ShowProductPurchaseUrl>
    <d2p1:ShowProductStatus>true</d2p1:ShowProductStatus>
    <d2p1:ShowSectionComplete>true</d2p1:ShowSectionComplete>
    <d2p1:ShowSkillCheckComplete>true</d2p1:ShowSkillCheckComplete>
    <d2p1:SkillCheckComplete>true</d2p1:SkillCheckComplete>
    <d2p1:SubscriptionUrl>sample string 28</d2p1:SubscriptionUrl>
    <d2p1:TestPrepResultsUrl>sample string 17</d2p1:TestPrepResultsUrl>
    <d2p1:Type>OnlineCourse</d2p1:Type>
  </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>
</ResultOfProductDetail5CPvfSRI>