Support

(800) 567-7401

service@atlas-sys.com

 

The Ares Web Service is a web application that enables you to transfer data to and from the Ares system using your course management web pages. By navigating to the web service on your local machine, you can view and test the data transfer operations the service provides.

Location of the Ares Web Service

The Ares Web Service (AresWebService.asmx) is located by default on your local Ares web server. It is in the Ares web folder at c:\inetpub\wwwroot\Ares\WebService\AresWebService.asmx

To override the default location for the Ares Web Service, use the WebServiceURL key in the Ares Customization Manager under Web | Settings | WebServiceURL.

Operations Available on the Ares Web Service

The Ares Web Service supports the operations shown in the list below. From within the web service, click on an operation to view the fields that Ares requires from the course management system. Basic descriptions of each operation are listed below the operation.

AddUserToCourse

Add the provided user to the course identified by the provided CourseId using the provided user type.

CourseItemTagsRetrieve a list of tags associated with items contained in the given course.

CourseItems

Retrieve a list of items associated with the given course.

Create WebSession

Create a new web session for the username provided.

GetCourseByExternalId

Return course details for a specific ExternalId.

GetCourseInfo

Return course details for a specific CourseId

GetCurrentSemester

Return the current semester.

GetItemInfo

Get item details.

GetSemesterInfo

Return the start, end and item addition dates for a given semester name.

GetSemesters

Return an array of semesters.

GetUserAgent

Determine the HTTP User Agent that is being used to connect to the Ares Web Service

InstructorPrivileges

Make a user an instructor to allow the creation of courses and new items.

NewCourse

Create a new course. The new Course ID will be returned.

NewCourseByDates

Create a new course. The new Course ID will be returned.

NewExternalCourse

Create a new course. Returns the new Course ID.

NewExternalCourse
RegistrarId

Create a new course, populated from course validation information for the provided RegistrarId. The new Course ID will be returned.

NewExternalUser

Create a new user with an ExternalId. A boolean value representing success or failure will be returned.

NewUser

Create a new user. A boolean value representing success or failure will be returned.

RemoveUserFromCourse

Remove the specified user from the course corresponding to the provided CourseId.

RetrieveCourse
MembershipType

Return the course membership type for the provided username in the course matching the provided course id.

RetrieveUsername
ForExternalUserId

Return the username for the user matching the provided ExternalId.

RetrieveUsername
ForLibraryId

Return the username for the user matching the provided LibraryId.

UpdateCourse

Update a course field.

UpdateWebSession

Update session type.

UserExists

Determine whether or not the provided user exists.

UserExistsByExternalUserId

Determine whether or not a user matching the provided ExternalId exists.

UserExistsByLibraryId

Determine whether or not a user matching the provided LibraryId exists.

VerifyCourseMembership

Check to see if a user is a course member (Instructor, User or ProxyInstructor).

Testing the Ares Web Service

Icon

In order to test the Ares Web Service, you will need access to your local web directory. Contact your Atlas Systems Customer Service Agent for assistance at service@atlas-sys.com or (800) 567-7401.

  1. Access the web service from the Ares web server: https://localhost/ares/WebService/areswebservice.asmx.
  2. Click on any operation from the list to test (AddUserToCourse is used in the screenshot).
  3. Enter test values in the required fields. Sample requests and responses are provided on the page and include placeholders that should be replaced with actual values.
  4. Click Invoke to test the operation.