POST papi/v1/integration/vta/coursestatus

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

CourseStatusRequest

Name	Description	Type	Additional information
CourseStatus		CourseStatus	None.

Request Formats

application/json, text/json

Sample:

{
  "CourseStatus": {
    "Course": [
      {
        "CourseCode": "sample string 1",
        "UserId": "sample string 2",
        "CourseStatus": "sample string 3",
        "CourseScore": 4.0,
        "PrimeKey": "sample string 5",
        "DateTimeStamp": "2025-07-04T14:04:21.8Z",
        "CompletionDate": "2025-07-04T14:04:21.8Z"
      },
      {
        "CourseCode": "sample string 1",
        "UserId": "sample string 2",
        "CourseStatus": "sample string 3",
        "CourseScore": 4.0,
        "PrimeKey": "sample string 5",
        "DateTimeStamp": "2025-07-04T14:04:21.8Z",
        "CompletionDate": "2025-07-04T14:04:21.8Z"
      }
    ],
    "BatchGUID": "3805089c-8b62-411f-a2a3-7efa5bb0b580"
  }
}

application/xml, text/xml

Sample:

<CourseStatusRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CourseStatus>
    <Course>
      <Course>
        <CourseCode>sample string 1</CourseCode>
        <UserId>sample string 2</UserId>
        <CourseStatus>sample string 3</CourseStatus>
        <CourseScore>4</CourseScore>
        <PrimeKey>sample string 5</PrimeKey>
        <DateTimeStamp>2025-07-04T10:04:21.8000153-04:00</DateTimeStamp>
        <CompletionDate>2025-07-04T10:04:21.8000153-04:00</CompletionDate>
      </Course>
      <Course>
        <CourseCode>sample string 1</CourseCode>
        <UserId>sample string 2</UserId>
        <CourseStatus>sample string 3</CourseStatus>
        <CourseScore>4</CourseScore>
        <PrimeKey>sample string 5</PrimeKey>
        <DateTimeStamp>2025-07-04T10:04:21.8000153-04:00</DateTimeStamp>
        <CompletionDate>2025-07-04T10:04:21.8000153-04:00</CompletionDate>
      </Course>
    </Course>
    <BatchGUID>3805089c-8b62-411f-a2a3-7efa5bb0b580</BatchGUID>
  </CourseStatus>
</CourseStatusRequest>

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 'CourseStatusRequest'.

Response Information

Resource Description

CourseStatusResponses

Name	Description	Type	Additional information
BatchGUID		globally unique identifier	None.
CourseScoreItemResponses		Collection of CourseStatusItemResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchGUID": "6577e677-1489-4862-bff3-763a9a0f50fd",
  "CourseScoreItemResponses": [
    {
      "CourseCode": "sample string 1",
      "UserId": "sample string 2",
      "IsSucceeded": true,
      "FailureMessage": "sample string 4"
    },
    {
      "CourseCode": "sample string 1",
      "UserId": "sample string 2",
      "IsSucceeded": true,
      "FailureMessage": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<CourseStatusResponses xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BatchGUID>6577e677-1489-4862-bff3-763a9a0f50fd</BatchGUID>
  <CourseScoreItemResponses>
    <CourseStatusItemResponse>
      <CourseCode>sample string 1</CourseCode>
      <UserId>sample string 2</UserId>
      <IsSucceeded>true</IsSucceeded>
      <FailureMessage>sample string 4</FailureMessage>
    </CourseStatusItemResponse>
    <CourseStatusItemResponse>
      <CourseCode>sample string 1</CourseCode>
      <UserId>sample string 2</UserId>
      <IsSucceeded>true</IsSucceeded>
      <FailureMessage>sample string 4</FailureMessage>
    </CourseStatusItemResponse>
  </CourseScoreItemResponses>
</CourseStatusResponses>