Vector Solutions Web Service

Table of Contents

Introduction to VLMS Web Services

Overview

Required Knowledge

• XML (for an overview, go to the W3 Schools XML Tutorial) and/or JSON (for an overview, go to the W3 Schools JSON Tutorial)
• Web Services (for an overview, go to the W3 Schools Web Services Tutorial)
• HTTP Requests
• Data Transfer Objects (for an overview, go here)
• One or more programming languages capable of making the appropriate calls utilizing technologies specified.

How to access the VLMS Web Service API

Structure of an API HTTPS Request

Handling HTTP Errors from the API

XML WebServiceError Example

JSON WebService Error Example

HTML Test Harness for testing API Requests

Available API Resources

Get Listing of Users

Resource URI

Resource Query String Parameters

                
                {
                    "PageNumber":1,
                    "Results" : [],
                    "TotalPages" : 1
                    "TotalRecords":1
                }
                

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

        When ReturnPagingSearchWrapper=true
        {
            "PageNumber": 1,
            "Results": [
                {
                    "APIRecordStatus": 0,
                    "APIRecordStatusMessage": null,
                    "EmailAddress": "",
                    "FirstName": "",
                    "LastName": "",
                    "SelfAssessmentCompleted": false,
                    "Status": "Active",
                    "Uniqueid_ClientSpecified": "1",
                    "UserCompanyNodes": null,
                    "UserCourseRegistrations": null,
                    "UserCredentialSubmissions": null,
                    "UserCredentialSummaries": null,
                    "UserCredentials": null,
                    "UserProfileFields": [
                        {
                            "APIRecordStatus": 0,
                            "APIRecordStatusMessage": null,
                            "FieldName": "PQR ID",
                            "FieldValue": "",
                            "UserProfileFieldId": "9E609928-6E1A-4207-B3DF-6CA0B3DC4EA6"
                        }
                    ],
                    "UserUUID": "F20ADB3E-4A47-4617-8117-F8869B7D453C",
                    "UserWorkExperiences": null,
                    "UserYearsWorkExperience": null,
                    "isActiveIPDP": false
                }
            ],
            "TotalPages": 56260,
            "TotalRecords": 56260
        }

        When ReturnPagingSearchWrapper=false
        [
            {
                "APIRecordStatus": 0,
                "APIRecordStatusMessage": null,
                "EmailAddress": "",
                "FirstName": "",
                "LastName": "",
                "SelfAssessmentCompleted": false,
                "Status": "Active",
                "Uniqueid_ClientSpecified": "1",
                "UserCompanyNodes": null,
                "UserCourseRegistrations": null,
                "UserCredentialSubmissions": null,
                "UserCredentialSummaries": null,
                "UserCredentials": null,
                "UserProfileFields": [
                    {
                        "APIRecordStatus": 0,
                        "APIRecordStatusMessage": null,
                        "FieldName": "XYZ",
                        "FieldValue": "",
                        "UserProfileFieldId": "9E609928-6E1A-4207-B3DF-6CA0B3DC4EA6"
                    }
                ],
                "UserUUID": "F20ADB3E-4A47-4617-8117-F8869B7D453C",
                "UserWorkExperiences": null,
                "UserYearsWorkExperience": null,
                "isActiveIPDP": false
            }
        ]
    

Required Permission(s)

• Users: Management - Enabled

Get a Specific User

Resource URI

• {user_identifier} - Represents the identifier of the user to retrieve. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• Users: Management - Enabled

Create a User

Resource URI

Resource Query String Parameters

Http Method(s)

• POST

Http Header Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Result

Required Permission(s)

• Users: Management - Enabled

Update a User

Resource URI

• {user_identifier} - Represents the identifier of the user to retrieve. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID

Resource Query String Parameters

Http Method(s)

• POST

Http Header Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Result

Required Permission(s)

• Users: Management - Enabled

Merge Users

Resource URI

• {useridfrom} - Represents the identifier of the user being merged FROM. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID
• {useridto} - Represents the identifier of the user being merged TO. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID

Resource Query String Parameters

Http Method(s)

• GET, POST

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Results

Required Permission(s)

• Users: Merge User Records

Reset Seamless Sign-On Key

Resource URI

• {userid} - Represents the identifier of the user who's seamless sign-on key will be reset.

Resource Query String Parameters

Http Method(s)

• POST

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Required Permission(s)

• Users: Management - Enabled

Get Listing of User Course Registrations

Resource URI

• {user_identifier} - Represents the identifier of the user to retrieve. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• Gradebook

Get a Specific User Course Registration

Resource URI

• {user_identifier} - Represents the identifier of the user to retrieve. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID
• {registration_identifier} - Represents the identifier of the user's course registration to retrieve. This is the CourseRegistrationID value of the CourseRegistrationDTO object.

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• Gradebook

Create a User Course Registration

Resource URI

• {user_identifier} - Represents the identifier of the user to retrieve. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID

Resource Query String Parameters

Http Method(s)

• POST

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Results

Required Permission(s)

• Gradebook

Update a User Course Registration

Resource URI

• {user_identifier} - Represents the identifier of the user to retrieve. Can be one of the following values of the UserDTO object:
  1. UniqueID_ClientSpecified
  2. UserUUID
• {registration_identifier} - Represents the identifier of the user's course registration to retrieve. This is the CourseRegistrationID value of the CourseRegistrationDTO object.

Resource Query String Parameters

Http Method(s)

• POST

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Results

Required Permission(s)

• Gradebook

Get Listing of Instructor Profiles

Resource URI

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• Manage Instructors Is Visible

Get Listing of Course Registrations

Resource URI

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• Gradebook

Get Listing of Published Courses

Resource URI

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• Manage Instructors Is Visible

Authentication

Resource URI

Resource Query String Parameters

Http Method(s)

• Post

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Results

Required Permission(s)

• N/A

Gets a list of Course Registration of the authenticated user

Resource URI

Resource Query String Parameters

Http Method(s)

• GET

Http Header: Authorization

Http Header: Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Results

Required Permission(s)

• My Courses: Enabled For Students

Get External App Module Data for Student Registrations

Resource URI

Resource Query String Parameters

Http Method(s)

• Get

Http Header Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

Http POST Data Requirements

Resource Result

Required Permission(s)

• My Courses: Enabled For Students

Update an External App Module for a Student Registration

Resource URI

Resource Query String Parameters

Http Method(s)

• POST

Http Header Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Http POST Data Requirements

Resource Result

Required Permission(s)

• Payments Processing

Receive External Payment Status Change

Resource URI

Resource Query String Parameters

Http Method(s)

• POST
• GET

Http Header Accept

• application/xml will return XML to you in the response
• application/json will return JSON to you in the response

Http Header: Content-Type

• application/xml indicates the post data is an XML structure
• application/json indicates the post data is a JSON structure

Resource Result

Required Permission(s)

• Store Front: API Payment Status Listener Enabled

Data Transfer Objects (DTOs)

User List Item Data Transfer Object (UserListItemDTO)

Data Structure

XML Example

JSON Example

User Company Node Transfer Object (UserCompanyNodeDTO)

Data Structure

XML Example

JSON Example

User Company Node MetaData Data Transfer Object (UserCompanyNodeMetaDataDTO)

Data Structure

XML Example

JSON Example

User Data Transfer Object (UserDTO)

Data Structure

XML Example

JSON Example

Course Registration Data Transfer Object (CourseRegistrationDTO)

Data Structure

XML Example

JSON Example

Course Completion Data Transfer Object (CourseCompletionDTO)

Data Structure

XML Example

JSON Example

Course List Item Data Transfer Object (CourseListItemDTO)

Data Structure

XML Example

JSON Example

Article Data Transfer Object (ArticleDTO)

Data Structure

XML Example

JSON Example

User Profile Field Transfer Object (UserProfileFieldDTO)

Data Structure

XML Example

JSON Example

User Credential Summary Data Transfer Object (UserCredentialSummaryDTO)

Data Structure

XML Example

JSON Example

User Credential Data Transfer Object (UserCredentialDTO)

Data Structure

XML Example

JSON Example

User Credential Submissions Data Transfer Object (UserCredentialSubmissionsDTO)

Data Structure

XML Example

JSON Example

User Work Experience Data Transfer Object (UserWorkExperienceDTO)

Data Structure

XML Example

JSON Example

User Years Work Experience Data Transfer Object (WorkYearsExperienceDTO)

Data Structure

XML Example

JSON Example

Instructor Profile Data Transfer Object (InstructorProfileDTO)

Data Structure

XML Example

JSON Example

Login Credentials DTO (LoginCredentialsDTO)

Data Structure

XML Example

JSON Example

Authentication Data Transfer Object (AuthenticationDTO)

Data Structure

XML Example

JSON Example

ExternalAppModuleDTO

Data Structure

XML Example

JSON Example