BlueLMSWS Web Service

BlueLMSWS

Click here for a complete list of operations.

GetCourseCatalog

Retrieves the course catalog of a client organization given the client organization’s administrator login name

Test

No test form is available as this service or method does not support the HTTP GET protocol.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /IsophBlueWS/IsophBlueWS.asmx HTTP/1.1
Host: blue.isoph.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://blue.isoph.com/GetCourseCatalog"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCourseCatalog xmlns="http://blue.isoph.com">
      <clientAdminName>string</clientAdminName>
      <catalogID>int</catalogID>
    </GetCourseCatalog>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCourseCatalogResponse xmlns="http://blue.isoph.com">
      <GetCourseCatalogResult>
        <errorCode>int</errorCode>
        <errorDescription>string</errorDescription>
        <exceptionType>string</exceptionType>
      </GetCourseCatalogResult>
      <courseCatalog>
        <CatalogInfo>
          <courseCollectionID>int</courseCollectionID>
          <courseID>int</courseID>
          <courseCollectionName>string</courseCollectionName>
          <courseCollectionDescription>string</courseCollectionDescription>
          <courseGroupName>string</courseGroupName>
          <courseGroupDescription>string</courseGroupDescription>
          <courseName>string</courseName>
          <courseDescriptionUrl>string</courseDescriptionUrl>
          <courseDescription>string</courseDescription>
          <courseGroupID>int</courseGroupID>
          <coursePrice>double</coursePrice>
          <courseCost>double</courseCost>
        </CatalogInfo>
        <CatalogInfo>
          <courseCollectionID>int</courseCollectionID>
          <courseID>int</courseID>
          <courseCollectionName>string</courseCollectionName>
          <courseCollectionDescription>string</courseCollectionDescription>
          <courseGroupName>string</courseGroupName>
          <courseGroupDescription>string</courseGroupDescription>
          <courseName>string</courseName>
          <courseDescriptionUrl>string</courseDescriptionUrl>
          <courseDescription>string</courseDescription>
          <courseGroupID>int</courseGroupID>
          <coursePrice>double</coursePrice>
          <courseCost>double</courseCost>
        </CatalogInfo>
      </courseCatalog>
      <courseCatalogShortInfo>
        <catalogID>int</catalogID>
        <catalogName>string</catalogName>
        <enrollmentMethod>ByCourse or ByCourseGroup or ByCourseCollection</enrollmentMethod>
        <purchaseEnrollmentAllowed>boolean</purchaseEnrollmentAllowed>
        <enrollmentRequestAllowed>boolean</enrollmentRequestAllowed>
        <selfEnrollmentAllowed>boolean</selfEnrollmentAllowed>
        <redeemTokenAllowed>boolean</redeemTokenAllowed>
        <tokenThreshold>double</tokenThreshold>
        <redeemedTokens>double</redeemedTokens>
        <ShowPriceLabel>boolean</ShowPriceLabel>
        <ShowCostLabel>boolean</ShowCostLabel>
      </courseCatalogShortInfo>
      <catalogPackages>
        <CatalogPackage>
          <courseCollectionID>int</courseCollectionID>
          <courseGroupID>int</courseGroupID>
          <packagePrice>double</packagePrice>
        </CatalogPackage>
        <CatalogPackage>
          <courseCollectionID>int</courseCollectionID>
          <courseGroupID>int</courseGroupID>
          <packagePrice>double</packagePrice>
        </CatalogPackage>
      </catalogPackages>
    </GetCourseCatalogResponse>
  </soap:Body>
</soap:Envelope>