GET /api/credtran/transfer

Query String
  • <limit=int> [optional] exclude for all
  • <offset=int> [optional] default is 0
  • <s=string> [optional] performs a lowercase like `%string%` search on "KU Title|KU Subject Description|KU_Subject KU_CourseNumber".
  • <st=string,...> [optional] include multiple state abbreviations comma separated. use "null" to include courses with no state.
  • <ctry=string,...> [optional] include multiple country abbreviations comma separated. use "null" to include courses with no country.
  • <sch=string,...> [optional] include multiple school codes comma separated.
Multiple query options can be used together. Combining options will AND them together.
Perform a "not in" search by prepending a ! in front. ex. !usa or !ks
Response 200 (streamed response)
{
  "total": int,
  "data": [
    {
      "hash" => string,
      "recKey" => string,
      "transferSchoolCode" => ?string,
      "transferSchoolName" => ?string,
      "transferSchoolState" => ?string,
      "transferSchoolStateDescription" => ?string,
      "transferSchoolCountry" => ?string,
      "transferSchoolCountryDescription" => ?string,
      "transferSchoolSubject" => ?string,
      "transferSchoolCourseNumber" => ?string,
      "transferCourseHours" => ?string,
      "kuCourseTitle" => ?string,
      "kuCourseSubject" => ?string,
      "kuCourseSubjectDescription" => ?string,
      "kuCourseNumber" => ?string,
      "kuCourseHours" => ?string,
      "kuCore" => ?string,
      "kborCore" => ?string,
      "geogroup" => ?string,
      "notes" => ?string,
      "fromDate" => ?string,
      "toDate" => ?string,
      "transferSchoolCourseTitle" => ?string,
    },
    ...
  ]
}

GET /api/credtran/schools

Query String
  • <limit=int> [optional] use 0 for all
  • <st=string,...> [optional] include multiple state abbreviations comma separated. use "null" to include courses with no state.
  • <ctry=string,...> [optional] include multiple country abbreviations comma separated. use "null" to include courses with no country.
Multiple query options can be used together. Combining options will AND them together.
Perform a "not in" search by prepending a ! in front. ex. !usa or !ks
Response 200
{
  "data": [
    {
      "transferSchoolCode" => ?string,
      "transferSchoolName" => ?string,
      "transferSchoolState" => ?string,
      "transferSchoolStateDescription" => ?string,
      "transferSchoolCountry" => ?string,
      "transferSchoolCountryDescription" => ?string,
    },
    ...
  ]
}

GET /api/credtran/states

Response 200
{
  "data": [
    [abbreviation, name]
  ]
}

GET /api/credtran/countries

Response 200
{
  "data": [
    [abbreviation, name]
  ]
}

GET /api/credtran/kbor

Response 200
{
  "data": [
    {
      "hash" => string,
      "subject" => ?string,
      "catalogNumber" => ?string,
      "validDate" => ?string,
      "attributeGroup" => ?string,
      "attribute" => ?string,
      "title" => ?string,
      "attributeDescription" => ?string,
      "academicGroup" => ?string,
    },
    ...
  ]
}

GET /api/credtran/kbor/attributes

Response 200
{
  "data": [
    [abbreviation, name]
  ]
}

GET /api/credtran/kbor/academic-groups

Response 200
{
  "data": [
    string,
    ...
  ]
}

GET /api/credtran/ku

Response 200
{
  "data": [
    {
      "hash" => string,
      "subject" => ?string,
      "catalogNumber" => ?string,
      "validDate" => ?string,
      "attributeGroup" => ?string,
      "attribute" => ?string,
      "title" => ?string,
      "attributeDescription" => ?string,
      "academicGroup" => ?string,
    },
    ...
  ]
}

GET /api/credtran/ku/attributes

Response 200
{
  "data": [
    [abbreviation, name]
  ]
}

GET /api/credtran/ku/academic-groups

Response 200
{
  "data": [
    string,
    ...
  ]
}

GET /api/my-saved/{id}

Request
Headers: [Authorization: Bearer <token-value>]
Response 200
{
  "data": {
    "id" => ulid,
    "emailedAt" => "Y-m-d H:i:s",
    "loadedTimes" => ["Y-m-d H:i:s", ...],
    "courses" => [Credtran, ...]
  }
}

POST /api/my-saved

This route saves the content to be loaded later. After saving an email is sent to the provided email address with a link to view the selected courses.
Request
Headers: [Authorization: Bearer <token-value>]
POST fields or JSON Body
{
  "name" => string, // not blank
  "email" => string, // not blank and email
  "courses" => [Credtran.hash, ...] // 1-100
}
OK Response 200
{
  "data": {
    "id" => string,
  },
  "messages" => [
    {"level": "success", "message": "ok"},
  ],
}
Error Response 422
{
  "data" => {},
  "messages" => [
    {"level": "error", "message": string},
  ],
}