POST papi/v1/integration/vta/courses

Security

Secured API

Request Information

URI Parameters

None.

Required Headers

Name	Description	Sample	Type	Default
Authorization	Represents the value of the authentication token. Allow multiple values: no.	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ...	string	None
ConsumerId	Represents the value of the consumer id. Allow multiple values: no.	2426	integer	None

Optional Headers

Name	Description	Sample	Type	Default
ApplicationType	Represents the value of the consumer's application type. Allow multiple values: no.	1	ApplicationType	None
Accept-Language	Represents the value of the desired language for translations. Allow multiple values: yes.	es	string	en

Body Parameters

CourseCatalogRequest

Name	Description	Type	Additional information
Courses		Courses	None.

Request Formats

application/json, text/json

Sample:

{
  "Courses": {
    "BatchGUID": "e41c5af8-60be-4433-9888-10ae68178454",
    "Course": [
      {
        "CourseCode": "sample string 1",
        "CourseTitle": "sample string 2",
        "CourseSource": "sample string 3",
        "Active": 4,
        "Link": "sample string 5",
        "CreditHours": 6.1,
        "Description": "sample string 7",
        "MediaType": "sample string 8",
        "ConfigurationKey": "sample string 9",
        "ConfigurationValue": "sample string 10"
      },
      {
        "CourseCode": "sample string 1",
        "CourseTitle": "sample string 2",
        "CourseSource": "sample string 3",
        "Active": 4,
        "Link": "sample string 5",
        "CreditHours": 6.1,
        "Description": "sample string 7",
        "MediaType": "sample string 8",
        "ConfigurationKey": "sample string 9",
        "ConfigurationValue": "sample string 10"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<CourseCatalogRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Courses>
    <BatchGUID>e41c5af8-60be-4433-9888-10ae68178454</BatchGUID>
    <Course>
      <CatalogCourse>
        <CourseCode>sample string 1</CourseCode>
        <CourseTitle>sample string 2</CourseTitle>
        <CourseSource>sample string 3</CourseSource>
        <Active>4</Active>
        <Link>sample string 5</Link>
        <CreditHours>6.1</CreditHours>
        <Description>sample string 7</Description>
        <MediaType>sample string 8</MediaType>
        <ConfigurationKey>sample string 9</ConfigurationKey>
        <ConfigurationValue>sample string 10</ConfigurationValue>
      </CatalogCourse>
      <CatalogCourse>
        <CourseCode>sample string 1</CourseCode>
        <CourseTitle>sample string 2</CourseTitle>
        <CourseSource>sample string 3</CourseSource>
        <Active>4</Active>
        <Link>sample string 5</Link>
        <CreditHours>6.1</CreditHours>
        <Description>sample string 7</Description>
        <MediaType>sample string 8</MediaType>
        <ConfigurationKey>sample string 9</ConfigurationKey>
        <ConfigurationValue>sample string 10</ConfigurationValue>
      </CatalogCourse>
    </Course>
  </Courses>
</CourseCatalogRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CourseCatalogRequest'.

Response Information

Resource Description

CourseCatalogResponse

Name	Type	Additional information
BatchGUID	globally unique identifier	None.
IsSucceeded	boolean	None.
ExceptionMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchGUID": "7e3906c5-caf1-4816-8e78-7fc654c17970",
  "IsSucceeded": true,
  "ExceptionMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<CourseCatalogResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BatchGUID>7e3906c5-caf1-4816-8e78-7fc654c17970</BatchGUID>
  <IsSucceeded>true</IsSucceeded>
  <ExceptionMessage>sample string 3</ExceptionMessage>
</CourseCatalogResponse>