Pearson
Always Learning

Overview

This SOAP service creates a term in LearningStudio. The term will be created immediately, and the service will return the LearningStudio Term ID.

Accessing the Service

LearningStudio requires a username and password to access the API web services. Your Strategic Customer Operations (SCO) team should have provided you with the necessary credentials. These credentials are included in the SOAP header.

Element Description
Operation Name CreateStandardTerm
End-point URL https://ccws-services.ecollege.com/EnterpriseServices/v2.2/EnterpriseTerm.svc
WSDL Compressed zip file of WSDL files
WS-Address

http://ccws-services.ecollege.com/EnterpriseServices/v2.2/EnterpriseTerm.svc
Learn more about WS-Addressing in Terms & Courses APIs

Tip: If you are programming in .NET, use WCF 4.0 for communicating with Terms & Courses services.

Request Header

All requests must include a WS-Security SOAP Header with the username and password for your LearningStudio campus. Your SOAP library is likely capable of creating this header for you. For more information on the requirements, see SOAP API Security.

Below is a sample header for CreateStandardTerm.

<header xmlns:wsa="http://www.w3.org/2005/08/addressing"><security soap:mustunderstand="true" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><usernametoken wsu:id="UsernameToken-1" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><username>{USERNAME}</username><password type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-usernametoken-profile-1.0#PasswordText">{PLAINTEXT_PASSWORD}</password><nonce encodingtype="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soapmessage-security-1.0#Base64Binary">{RANDOM_VALUE}</nonce><created>{UTC_TIMESTAMP}</created></usernametoken></security><action>{ACTION_DEFINED_BY_WSDL}</action><to>{ADDRESSING_URL}</to></header>

Request Body

The elements of the CreateStandardTerm request XML request body are detailed in the following table. The top level element is always CreateStandardTerm, and all these elements are children of the top node.

Element Description Required?
standardTermRequest Container for term detail. Required
standardTermRequest
    ↳AssociatedEPOrganization
Container for an array of LearningStudio node sort strings the new term is associated with. Required
standardTermRequest
    ↳AssociatedEPOrganization
            ↳arr:string
An array of LearningStudio node sort strings the new term is associated with. Repeat this element for each node string. If you want to associate a term with all Nodes, use a value of All. Required
standardTermRequest
    ↳BillingClassificationType

The billing type for the term based on the type of courses associated with the term. That is, 100% online, 50/50 online/on-ground, less than 50% online, and so on. Consult your Strategic Customer Operations consultant for what values apply to your situation. Possible values are:

  • eCourse (default if no value is specified in the request, and the most common)
  • eCourseLicense
  • eCompanion
  • eCompanionLicense
  • Hybrid
  • LicenseHybrid
  • Mixed
  • NonRevenue
  • Evaluation
Required
standardTermRequest
    ↳ClientString
LearningStudio Client String for the campus / Education Partner (client). Required
standardTermRequest
    ↳Name
Name for the new term. Required
standardTermRequest
    ↳Description
Text that describes the new term. Optional
standardTermRequest
    ↳ID
A container element for your system's identifiers for a term. Required
standardTermRequest
    ↳ID
            ↳ID
Your system's identifiers for a term. The best practice is to prepend this with your client string, and ensure the value is always unique (otherwise an error can occur if you need to recreate the term). Required
standardTermRequest
    ↳ID
            ↳MappingType
The only valid value for this element is SourcedID. Required
standardTermRequest
    ↳TermTypeCode
The only valid value for this element is Standard. Required
standardTermRequest
    ↳TermTimeFrame
Child elements identify user access period for new term. Required
standardTermRequest
    ↳TermTimeFrame
            ↳StartDate
The date students can start accessing courses in this term. Required
standardTermRequest
    ↳TermTimeFrame
            ↳EndDate
The date students will no longer be allowed to access courses in this term. Required
standardTermRequest
    ↳CourseActualTimeFrame
A container for the start and end dates that will be used for courses in this term. Required
standardTermRequest
    ↳CourseActualTimeFrame
            ↳StartDate
The official start date of courses in this term (this is used for billing, census, and reporting). Required
standardTermRequest
    ↳CourseActualTimeFrame
            ↳EndDate
The official end date of courses in this term (this is used for billing, census, and reporting). Required
standardTermRequest
    ↳DropAddPeriodTimeFrame
A container for the start and end dates of when a student may drop from the course. Required
standardTermRequest
    ↳DropAddPeriodTimeFrame
            ↳StartDate
This is a legacy element from a retired workflow; it implies when students can no longer be added to the course. The modern best practice is to set this to one day before the Course End Date, i.e. (Course End Date - 1). Required
standardTermRequest
    ↳DropAddPeriodTimeFrame
            ↳EndDate
This is a legacy element from a retired workflow; it implies when students can no longer drop the course. The modern best practice is to set this to the Course End Date. Required
standardTermRequest
    ↳RegistrationTimeFrame
A container for elements that identify registration period for new term. As of version 2.2 of this service, this element is no longer required and should be left out. Optional
standardTermRequest
    ↳RegistrationTimeFrame
            ↳StartDate
This is a legacy element from a retired workflow. The modern best practice is to set this to Term Start Date. As of version 2.2 of this service, this element is no longer required and should be left out. Optional
standardTermRequest
    ↳RegistrationTimeFrame
            ↳EndDate
This is a legacy element from a retired workflow. The modern best practice is to set this to Term End Date. As of version 2.2 of this service, this element is no longer required and should be left out. Optional
standardTermRequest
    ↳WithdrawPeriodEndsOn
This is a legacy element from a retired workflow. The modern best practice is to set this to Term End Date. As of version 2.2 of this service, this element is no longer required and should be left out. Optional

Request Body Sample

Here is a text view of the body from a sample CreateStandardTerm request message:

<createstandardterm><standardtermrequest><associatedeporganization><string>gbtestc.two.</string></associatedeporganization><billingclassificationtype>eCourse</billingclassificationtype><clientstring>gbtestc</clientstring><courseactualtimeframe><enddate>2014-12-31</enddate><startdate>2014-07-10</startdate></courseactualtimeframe><description>via Term Service v2.2</description><dropaddperiodtimeframe><enddate>2014-12-31</enddate><startdate>2014-12-30</startdate></dropaddperiodtimeframe><id><id>gbtestc:CCWSv2.2Doc</id><mappingtype>SourcedID</mappingtype></id><name>CCWS v2.2 Documentation</name><termtimeframe><enddate>2014-12-31</enddate><startdate>2014-07-10</startdate></termtimeframe><termtypecode>Standard</termtypecode></standardtermrequest></createstandardterm>

Response

The CreateStandardTermResult elements

Element Description
CreateStandardTermResponse Top Level Element
CreateStandardTermResponse
    ↳CreateStandardTermResult
Container for response
Attribute:

xmlns
namespce

Attribute:

xmlns
namespce
CreateStandardTermResponse
    ↳CreateStandardTermResult
            ↳ID
LearningStudio's Term ID for the new term.
CreateStandardTermResponse
    ↳CreateStandardTermResult
            ↳MappingType
How the term is identified. This is always set to TermID


Response Body Example

Here is a text view of the body from a sample CreateStandardTermResult message:

<createstandardtermresponse xmlns="urn:eclg:coursecopy:enterpriseterm"><createstandardtermresult xmlns:b="http://CCWSServices.eCollege.com/EnterpriseServices/Types/v2.1/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><id>91042</id><mappingtype>TermID</mappingtype></createstandardtermresult></createstandardtermresponse>

Error Messages

For detailed information concerning possible error messages, see Common Error Messages.

2818 reads
Always Learning
Pearson