GET api/Learners/GetByCodeOrInvoice/{codeOrinvoice}

Request Information

URI Parameters

Name	Description	Type	Additional information
codeOrinvoice		string	Required

Body Parameters

None.

Response Information

Resource Description

ResultOfIEnumerableOfLearner

Name	Type	Additional information
Error	boolean	None.
Ok	boolean	None.
Errors	Collection of Error	None.
Data	Collection of Learner	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": [
    {
      "OcpID": "sample string 1",
      "PersonId": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmailAddress": "sample string 5",
      "ProductName": "sample string 6",
      "Section": "sample string 7",
      "Course": "sample string 8",
      "AccessCodeRedemptionDate": "2026-02-03T21:44:44.427553-05:00",
      "EnrollmentCode": "sample string 10"
    },
    {
      "OcpID": "sample string 1",
      "PersonId": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmailAddress": "sample string 5",
      "ProductName": "sample string 6",
      "Section": "sample string 7",
      "Course": "sample string 8",
      "AccessCodeRedemptionDate": "2026-02-03T21:44:44.427553-05:00",
      "EnrollmentCode": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<ResultOfArrayOfLearnerwnekxRBL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/A2.Jbl.Api.Models">
  <Data>
    <Learner>
      <AccessCodeRedemptionDate>2026-02-03T21:44:44.427553-05:00</AccessCodeRedemptionDate>
      <Course>sample string 8</Course>
      <EmailAddress>sample string 5</EmailAddress>
      <EnrollmentCode>sample string 10</EnrollmentCode>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
      <OcpID>sample string 1</OcpID>
      <PersonId>sample string 2</PersonId>
      <ProductName>sample string 6</ProductName>
      <Section>sample string 7</Section>
    </Learner>
    <Learner>
      <AccessCodeRedemptionDate>2026-02-03T21:44:44.427553-05:00</AccessCodeRedemptionDate>
      <Course>sample string 8</Course>
      <EmailAddress>sample string 5</EmailAddress>
      <EnrollmentCode>sample string 10</EnrollmentCode>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
      <OcpID>sample string 1</OcpID>
      <PersonId>sample string 2</PersonId>
      <ProductName>sample string 6</ProductName>
      <Section>sample string 7</Section>
    </Learner>
  </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>
</ResultOfArrayOfLearnerwnekxRBL>