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
CourseStatusRequestName | 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-04T22:14:36.125Z", "CompletionDate": "2025-07-04T22:14:36.125Z" }, { "CourseCode": "sample string 1", "UserId": "sample string 2", "CourseStatus": "sample string 3", "CourseScore": 4.0, "PrimeKey": "sample string 5", "DateTimeStamp": "2025-07-04T22:14:36.125Z", "CompletionDate": "2025-07-04T22:14:36.125Z" } ], "BatchGUID": "3009b244-870e-402f-8cce-bfe3503a5ba3" } }
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-04T18:14:36.12528-04:00</DateTimeStamp> <CompletionDate>2025-07-04T18:14:36.12528-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-04T18:14:36.12528-04:00</DateTimeStamp> <CompletionDate>2025-07-04T18:14:36.12528-04:00</CompletionDate> </Course> </Course> <BatchGUID>3009b244-870e-402f-8cce-bfe3503a5ba3</BatchGUID> </CourseStatus> </CourseStatusRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
CourseStatusResponsesName | Description | Type | Additional information |
---|---|---|---|
BatchGUID | globally unique identifier |
None. |
|
CourseScoreItemResponses | Collection of CourseStatusItemResponse |
None. |
Response Formats
application/json, text/json
Sample:
{ "BatchGUID": "3f9a2203-6c33-4b19-b77e-85979bfe7434", "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>3f9a2203-6c33-4b19-b77e-85979bfe7434</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>