Saba Learning APIs

• Certification/Curriculum

  • List Methods
  • Expand Methods

  • GETGet the meta details of a component/:name/meta:(:searchFields)
    Returns the meta details of a particular component [certification | curriculum | path | learningmodule | learningintervention].
    
    

    Parameter	Value	Type	Location	Description
    name	certificationcurriculum	enumerated	query	The name of the desired component.
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular component/:name/:id:(:searchFields)
    Returns complete information about a component [certification | curriculum | path | learningmodule | learningintervention] based on the component's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    name	certificationcurriculum	enumerated	query	The name of the desired component.
    id		string	query	Component's ID
    searchFields		string	query	Fields to search: [paths | learningModules | learningInterventions]

  • GETGet the details of a particular component by name/:componentname/name=:name:(:searchFields)
    Returns complete information about a component [certification | curriculum | path | learningmodule | learningintervention] based on the component's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    componentname	certificationcurriculum	enumerated	query	The name of the desired component.
    name		string	query	Component's name
    searchFields		string	query	Fields to search: [paths | learningModules | learningInterventions]

  • GETGet all the records of a component/:componentName?count=:count&startPage=:startPage
    Returns all the records of a component.
    
    

    Parameter	Value	Type	Location	Description
    componentName	certificationcurriculum	enumerated	query	The name of the desired component.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Certification/Curriculum/:componentName?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Certification/Curriculum along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    componentName	certificationcurriculum	enumerated	query	The name of the desired component.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new certification/certification
    Creates a certification.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the certification
    description		string	query	Description of the certification
    past_credit_days		string	query	Past credit days
    history_lookup_policy		string	query	History lookup policy of the certification
    avl_from		string	query	Certification Available from
    disc_from		string	query	Certification Discontinued from
    version		string	query	Version of the certification
    status		string	query	Status of the certification
    target_days		string	query	Target days
    notify_before		string	query	Notify before
    featured		string	query	Whether the certification is featured
    valid_till		string	query	Certification Valid till
    parent		string	query	Parent
    learningevent_id		string	query	Learning Event's ID
    vendor_id		string	query	Vendor's ID
    securityDomain		string	query	The domain for the certification
    paths		string	query	Paths
    customValues		string	query	Custom Values
    disp_learner		string	query	Display for learner
    disp_callcenter		string	query	Display for Call Center
    self_register		string	query	Allow self registration
    OneClickRegistration		string	query	One-click registration
    recertificationWindow		string	query	Recertification Window
    auto_launch		string	query	Continuously launch classes
    enforce_module_seq		string	query	Enforce Module Sequencing
    enforce_target_date		string	query	Enforce Target Date
    marked_for_compliance		string	query	Mark learning item for compliance
    grace_period		string	query	Grace Period window
    reAssignedTargetDays		string	query	Reassignment Target Days
    recertifyDays		string	query	Re-certification days
    expiryType		string	query	Expiry type (duration or dayOfMonth)
    isExpiresInMonths		string	query	Expiration duration value, either in days or months.
    expiresOnDay		string	query	Expires on day
    expiresOnMonth		string	query	Expires on month
    nextExpiryStartsOnDay		string	query	New expiry starts on day
    nextExpiryStartsOnMonth		string	query	New expiry starts on month
    expiresOnFrequency		string	query	Frequency (Yearly)
    associations		string	query	association

  • POSTCreate a new curriculum/curriculum
    Creates a curriculum
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the curriculum
    description		string	query	Description of the curriculum
    avl_from		string	query	Curriculum Available from
    disc_from		string	query	Curriculum Discontinued from
    version		string	query	Version of the curriculum
    status		string	query	Status of the curriculum
    target_days		string	query	Target days
    vendor_id		string	query	Vendor's ID
    featured		string	query	Whether the curriculum is featured
    learningevent_id		string	query	Learning Event's ID
    securityDomain		string	query	The domain for the certification
    paths		string	query	Paths
    customValues		string	query	Custom Values
    disp_learner		string	query	Display for learner
    disp_callcenter		string	query	Display for Call Center
    self_register		string	query	Allow self registration
    OneClickRegistration		string	query	One-click registration
    auto_launch		string	query	Continuously launch classes
    enforce_module_seq		string	query	Enforce Module Sequencing
    enforce_target_date		string	query	Enforce Target Date
    marked_for_compliance		string	query	Mark learning item for compliance

  • POSTCreate a new path/path
    Creates a certification path.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the certification path
    certification_id		string	query	Certification/Curriculum to which path will be added
    is_default_path		string	query	whether is a default path of certification
    is_path_recalculation_done		string	query	whether path recalculation is done or not
    isrecertification_track		string	query	whether is a recertification path
    disc_from		string	query	Discontinuation date of a path
    learningModules		string	query	Learning modules of path

  • POSTCreate a new learning module/learningmodule
    Creates learning module for certification path.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of learning module
    certification_id		string	query	Certification/Curriculum to which path, new module will be added.
    is_reqd		string	query	whether module is required for certification path
    notes		string	query	Notes for learning module
    track_id		string	query	Certification path id to which module is to be added
    reqd_no_of_items		string	query	Required number of items for learning module to complete
    learningInterventions		string	query	Learning interventions of the module, at least one learning intervention is must to create learning module.

  • POSTFind the details of Certification/Curriculum (Using POST - Range based search)/:name/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Certification/Curriculum along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    name	certificationcurriculum	enumerated	query	The name of the desired component.
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the Certification/Curriculum in the search

  • PUTUpdate the details of a certification/certification/:id
    Update the details of a certification based on the Certification's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Certification's ID
    name		string	query	Name of the certification
    description		string	query	Description of the certification
    past_credit_days		string	query	Past credit days
    history_lookup_policy		string	query	History lookup policy of the certification
    avl_from		string	query	Certification Available from
    disc_from		string	query	Certification Discontinued from
    version		string	query	Version of the certification
    status		string	query	Status of the certification
    target_days		string	query	Target days
    notify_before		string	query	Notify before
    featured		string	query	Whether the certification is featured
    learningevent_id		string	query	Learning Event's ID
    valid_till		string	query	Certification Valid till
    customValues		string	query	Custom Values
    securityDomain		string	query	The domain for the certification
    parent		string	query	Parent
    vendor_id		string	query	Vendor's ID
    disp_learner		string	query	Display for learner
    disp_callcenter		string	query	Display for Call Center
    self_register		string	query	Allow self registration
    OneClickRegistration		string	query	One-click registration
    recertificationWindow		string	query	Recertification Window
    auto_launch		string	query	Continuously launch classes
    enforce_module_seq		string	query	Enforce Module Sequencing
    enforce_target_date		string	query	Enforce Target Date
    marked_for_compliance		string	query	Mark learning item for compliance
    grace_period		string	query	Grace Period window
    reAssignedTargetDays		string	query	Reassignment Target Days
    recertifyDays		string	query	Re-certification days
    expiresOnDay		string	query	Expires on day
    expiresOnMonth		string	query	Expires on month
    nextExpiryStartsOnDay		string	query	New expiry starts on day
    nextExpiryStartsOnMonth		string	query	New expiry starts on month
    expiresOnFrequency		string	query	Frequency (Yearly)
    associations		string	query	association

  • PUTUpdate the details of a certification from name/certification/name=:name
    Update the details of a certification based on the Certification's ID.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the certification
    description		string	query	Description of the certification
    past_credit_days		string	query	Past credit days
    history_lookup_policy		string	query	History lookup policy of the certification
    avl_from		string	query	Certification Available from
    disc_from		string	query	Certification Discontinued from
    version		string	query	Version of the certification
    status		string	query	Status of the certification
    target_days		string	query	Target days
    notify_before		string	query	Notify before
    featured		string	query	Whether the certification is featured
    learningevent_id		string	query	Learning Event's ID
    valid_till		string	query	Certification Valid till
    customValues		string	query	Custom Values
    securityDomain		string	query	The domain for the certification
    parent		string	query	Parent
    vendor_id		string	query	Vendor's ID
    disp_learner		string	query	Display for learner
    disp_callcenter		string	query	Display for Call Center
    self_register		string	query	Allow self registration
    OneClickRegistration		string	query	One-click registration
    auto_launch		string	query	Continuously launch classes
    enforce_module_seq		string	query	Enforce Module Sequencing
    enforce_target_date		string	query	Enforce Target Date
    marked_for_compliance		string	query	Mark learning item for compliance
    grace_period		string	query	Grace Period window
    reAssignedTargetDays		string	query	Reassignment Target Days

  • PUTUpdate locale-specific details of certification/certification/:instanceId/locale
    Update locale-specific attributes of certification.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • PUTUpdate the details of a curriculum/curriculum/:id
    Updates the details of a curriculum based on the Curriculum's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Curriculum's ID
    name		string	query	Name of the curriculum
    description		string	query	Description of the curriculum
    avl_from		string	query	Curriculum Available from
    disc_from		string	query	Curriculum Discontinued from
    version		string	query	Version of the curriculum
    status		string	query	Status of the curriculum
    target_days		string	query	Target days
    learningevent_id		string	query	Learning Event's ID
    featured		string	query	Whether the curriculum is featured
    vendor_id		string	query	Vendor's ID
    securityDomain		string	query	The domain for the certification
    customValues		string	query	Custom Values
    disp_learner		string	query	Display for learner
    disp_callcenter		string	query	Display for Call Center
    self_register		string	query	Allow self registration
    OneClickRegistration		string	query	One-click registration
    auto_launch		string	query	Continuously launch classes
    enforce_module_seq		string	query	Enforce Module Sequencing
    enforce_target_date		string	query	Enforce Target Date
    marked_for_compliance		string	query	Mark learning item for compliance

  • PUTUpdate the details of a curriculum from name/curriculum/name=:name
    Updates the details of a curriculum based on the Curriculum's ID.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the curriculum
    description		string	query	Description of the curriculum
    avl_from		string	query	Curriculum Available from
    disc_from		string	query	Curriculum Discontinued from
    version		string	query	Version of the curriculum
    status		string	query	Status of the curriculum
    target_days		string	query	Target days
    learningevent_id		string	query	Learning Event's ID
    featured		string	query	Whether the curriculum is featured
    vendor_id		string	query	Vendor's ID
    securityDomain		string	query	The domain for the certification
    customValues		string	query	Custom Values
    disp_learner		string	query	Display for learner
    disp_callcenter		string	query	Display for Call Center
    self_register		string	query	Allow self registration
    OneClickRegistration		string	query	One-click registration
    auto_launch		string	query	Continuously launch classes
    enforce_module_seq		string	query	Enforce Module Sequencing
    enforce_target_date		string	query	Enforce Target Date

  • PUTUpdate locale-specific details of curriculum/curriculum/:instanceId/locale
    Update locale-specific attributes of curriculum.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	Locale id or displayname

  • PUTUpdate the details of a path/path/:id
    Updates the details of a path based on the Path's ID and Certification's ID passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Path's ID
    certification_id		string	query	Certification's ID
    isrecertification_track		string	query	Is it a recertification track
    name		string	query	Name of the path
    is_default_path		string	query	Is is a default path
    disc_from		string	query	Discontinuation date of path
    learningModules		string	query	Learning modules of path
    customValues		string	query	Custom Values

  • PUTUpdate the details of a learning module/learningmodule/:id
    Updates the details of a learning module based on the Module's ID and Certification's ID passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Module's ID
    certification_id		string	query	Certification's ID
    name		string	query	Name of the learning module
    waiver		string	query	Waiver of the learning module
    sequence		string	query	Sequence of the learning module
    notes		string	query	Notes for the learning module
    required		string	query	Whether the learning module is required
    learningInterventions		string	query	Learning interventions of module
    customValues		string	query	Custom Values

  • DELETEDelete Path/path/:pathId
    Delete a specific path
    
    

    Parameter	Value	Type	Location	Description
    pathId		string	query	Learning Module Id

  • DELETEDelete Learning Module/learningmodule/:learningModuleId
    Delete a specific learning module
    
    

    Parameter	Value	Type	Location	Description
    learningModuleId		string	query	Learning Module Id

• Course

  • List Methods
  • Expand Methods

  • GETGet the meta details of course/course/meta:(:searchFields)
    Returns the meta details of the course.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular course/course/:id:(:searchFields)
    Returns complete information about a course based on the course's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Course's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Courses/course?count=:count&startPage=:startPage
    Returns all Courses for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Courses/course?q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the Courses along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of course (Using POST - Range based search)/course/searchQuery?count=:count&startPage=:startPage
    Returns the details of the course along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description

  • POSTCreate a new course/course
    Creates a new course
    
    

    Parameter	Value	Type	Location	Description
    featured		string	query	Whether featured?
    validTill		string	query	Valid till
    type		string	query	Type
    description		string	query	Description
    avail_web		string	query	Available for web?
    training_units		string	query	Training Units
    notifyBefore		string	query	Notify Before
    avail_call_center		string	query	Available for Call Center?
    price		string	query	Price
    avail_from		string	query	Available From
    disc_from		string	query	Discontinued from
    min_ct		string	query	Min Count
    version		string	query	Version
    title		string	query	Title
    published		string	query	Published
    max_ct		string	query	Max Count
    abstrac		string	query	Abstract
    audienceType		string	query	Audience Type
    target_days		string	query	Target Days As Int
    course_no		string	query	Course No
    recommended_prerequisites		string	query	Recommended Prerequisites
    required_prerequisites		string	query	Required Prerequisites
    field_of_study		string	query	Field Of Study
    discontinued		string	query	Discontinued
    displayName		string	query	Display Name
    domain		string	query	Domain
    csr_id		string	query	Customer Service Representative's Id
    lr_manager_id		string	query	Learning request manager for this course
    allPrices		string	query	Price List
    language		string	query	Languages to be associated
    customValues		string	query	custom Values
    vendorImageURL		string	query	Vendor Image URL
    refreshImageFromVendorImageURL		string	query	Is image refresh needed
    ignoreImageUploadExceptions		string	query	Ignore error in updating image
    associations		string	query	course associations

  • PUTUpdate the details of a course/course/:courseid
    Update a course
    
    

    Parameter	Value	Type	Location	Description
    courseid		string	query	Course's ID
    featured		string	query	Whether featured?
    validTill		string	query	Valid till
    type		string	query	Type
    description		string	query	Description
    avail_web		string	query	Available for web?
    training_units		string	query	Training Units
    notifyBefore		string	query	Notify Before
    avail_call_center		string	query	Available for Call Center?
    price		string	query	Price
    avail_from		string	query	Available From
    disc_from		string	query	Discontinued from
    min_ct		string	query	Min Count
    version		string	query	Version
    title		string	query	Title
    published		string	query	Published?
    max_ct		string	query	Max Count
    abstrac		string	query	Abstract
    audienceType		string	query	Audience Type
    target_days		string	query	Target Days As Int
    course_no		string	query	Course No
    recommended_prerequisites		string	query	Recommended Prerequisites
    required_prerequisites		string	query	Required Prerequisites
    field_of_study		string	query	Field Of Study
    discontinued		string	query	Discontinued?
    displayName		string	query	Display Name
    domain		string	query	Domain
    csr_id		string	query	Customer Service Representative's Id
    lr_manager_id		string	query	Learning request manager for this course
    allPrices		string	query	Price List
    language		string	query	Languages to be associated
    customValues		string	query	custom Values
    vendorImageURL		string	query	Vendor Image URL
    refreshImageFromVendorImageURL		string	query	Is image refresh needed
    ignoreImageUploadExceptions		string	query	Ignore error in updating image
    associations		string	query	course associations

  • PUTUpdate locale-specific details of course/course/:instanceId/locale
    Update locale-specific attributes of course.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

• Delivery Mode

  • List Methods
  • Expand Methods

  • GETGet the meta details of Delivery Mode/deliverymode/meta:(:searchFields)
    Returns the meta details of the Delivery Mode.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned

  • GETGet the details of a particular Delivery Mode/deliverymode/:id:(:searchFields)
    Returns complete information about a Delivery Mode based on the Delivery Mode's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Delivery Mode's ID
    searchFields		string	query	Indicate what additional details needs to be returned

  • GETGet All Delivery Mode/deliverymode?count=:count&startPage=:startPage
    Returns all Delivery Mode for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Delivery Mode/deliverymode?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Delivery Mode along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Delivery Mode (Using POST - Range based search)/deliverymode/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Delivery Mode.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the Delivery Mode in the search

  • POSTCreate a new Delivery Mode/deliverymode
    Creates a new Delivery Mode
    
    

    Parameter	Value	Type	Location	Description
    description		string	query	Description
    duration		string	query	Duration
    securityDomain		string	query	Security Domain
    vendor_id		string	query	Vender
    available_from		string	query	Available from
    csr_id		string	query	Customer Service Representative
    training_units		string	query	No of Training Units
    delivery_id		string	query	Delivery Type
    acronym		string	query	Delivery Mode No
    offer_temp_id		string	query	Course
    discontinued_from		string	query	Discontinued from
    disp_call_center		string	query	Display for call center
    disp_web		string	query	Display for web
    customValues		string	query	custom Values

  • PUTUpdate the details of a Delivery Mode/deliverymode/:id
    Updates an existing Delivery Mode based on the Delivery Mode's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Delivery Mode
    description		string	query	Description
    duration		string	query	Duration
    securityDomain		string	query	Security Domain
    vendor_id		string	query	Vender
    available_from		string	query	Available from
    csr_id		string	query	Customer Service Representative
    training_units		string	query	No of Training Units
    discontinued_from		string	query	Discontinued from
    disp_call_center		string	query	Display for call center
    disp_web		string	query	Display for web
    customValues		string	query	custom Values

• Catalog Policy

  • List Methods
  • Expand Methods

  • GETGet all details of policies on Course, Delivery mode or offering/catalog/policy/:id
    Returns all details of policies on Course, Delivery mode or offering.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Course, Delivery mode or offering

  • GETGet all details of policies on Course, Delivery mode or offering/catalog/policy/:uniqueNo?type=:type
    Returns all details of policies on Course, Delivery mode or offering.
    
    

    Parameter	Value	Type	Location	Description
    uniqueNo		string	query	Course no, Delivery mode no or offering part no
    type		type	query	Type of owner - course, deliverymode, or offering delivery type

  • GETGet details of policies on Course, Delivery mode or offering/catalog/policy/:id?policyName=:policyNames
    Returns details of policies on Course, Delivery mode or offering.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Course, Delivery mode or offering
    policyNames		string	query	Policy names can be specified here in comma separated format. Names can be overrideCompletionPolicy, approvalPolicy, recurringRegistrationPolicy, certificationOfCompletion

  • PUTUpdate the details of policies on Course, Delivery mode or offering/catalog/policy/:id
    Update the details of policies on Course, Delivery mode or offering.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Course, Delivery mode or offering
    policyInfo		string	query	Policy details

  • PUTUpdate the details of policies on Course, Delivery mode or offering with user friendly attribute/catalog/policy/:uniqueNo?type=:type
    Update the details of policies on Course, Delivery mode or offering with user friendly attribute.
    
    

    Parameter	Value	Type	Location	Description
    uniqueNo		string	query	Course no, Delivery mode no or offering part no
    type		type	query	Type of owner - course, deliverymode, or offering delivery type
    policyInfo		string	query	Policy details

• Price List Entry

  • List Methods
  • Expand Methods

  • GETGet details of PriceListEntry on Course, Delivery mode, Offering, Package, Training Unit/pricelistentry/:id
    Returns details of PriceListEntry on Course, Delivery mode, Offering, Package, Training Unit.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of PriceListEntry

  • GETSearch PriceList Entry by criteria/pricelistentry?q=(:criteria)&count=:count&startPage=:startPage
    Search various pricelistentry with criteria like title, part_id, currency_id, currency_iso, currency_name, pricelist_id, pricelist_name.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTSearch PriceList Entry by criteria POST based search/pricelistentry/searchQuery?count=:count&startPage=:startPage
    Search various pricelistentry with criteria like title, part_id, currency_id, currency_iso, currency_name, pricelist_id, pricelist_name.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description

  • POSTCreate a new PriceList entry for a learning item/pricelistentry
    Allows creating a new pricelist entry for Course, Delivery mode, Offering, Package, Training Unit.
    
    

    Parameter	Value	Type	Location	Description
    pricelist		string	query	The pricelist for the Learning item
    currency		string	query	The currency for pricelist entry
    part		string	query	The id for the Learning item
    amount		string	query	Amount

  • PUTUpdate PriceList entry for a learning item/pricelistentry/:id
    Update the details pricelist entry on Course, Delivery mode, Offering, Package, Training Unit.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Pricelistentry
    pricelist		string	query	The pricelist for the Learning item
    currency		string	query	The currency for pricelist entry
    part		string	query	The id for the Learning item
    amount		string	query	Amount

  • DELETEDelete a particular PriceList entry/pricelistentry/:id
    Delete a particular PriceList entry.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Pricelistentry

  • GETSearch PriceList by criteria/pricelist?q=(:criteria)&count=:count&startPage=:startPage
    Search pricelist with criteria like owner.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet details of PriceList/pricelist/:id
    Returns details of PriceList
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of PriceList

• Enrollment

  • List Methods
  • Expand Methods

  • GETGet the details of an enrollment/enrollments/:id/sections::sections
    Returns the details of the enrollment.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Registartion's ID
    sections		string	query	Indicate what additional details needs to be returned. Acceptable values(regdetail,classdetail,actions,sessionsdetail,learningAssignments,lessondetail)

  • GETGet the evaluation detail of an enrollment/enrollments/:registrationId/evaluations?learnerId=:learnerId
    Returns the evaluation detail of an enrollment
    
    

    Parameter	Value	Type	Location	Description
    registrationId		string	query	Registartion id
    learnerId		string	query	Learner id

  • GETGet the meta details of enrollment/enrollment/meta:(:searchFields)
    Returns the meta details of the enrollment.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Enrollments/enrollment?count=:count&startPage=:startPage
    Returns all Enrollments for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the enrollments/enrollment?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the enrollments along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new enrollment (Self registration)/enrollments
    Creates a new enrollment without the payment option.
    
    

    Parameter	Value	Type	Location	Description
    learnerId		string	query	Person's ID or Person's Username or Person's No
    offeringId		string	query	Class's ID or Part No to which the learner will enroll
    deliveryId		string	query	Delivery Type's ID to which the learner will enroll(Required only if Class's Part No is provided)
    @type		string	query	Input JSON class name
    currencyId		string	query	Currency's Id
    warningsToIgnore		string	query	List

  • POSTEnroll for other users/self/enrollments
    Allows enrolling for other users/self without the payment option.
    
    

    Parameter	Value	Type	Location	Description
    orderContact		string	query	Person's ID or Person's Username or Person's No
    cartItems		string	query	Order Item [learner id and class id]
    currencyId		string	query	Currency's Id
    @type		string	query	Input JSON class name

  • POSTEnroll for other user/self with payment/learning/enroll
    Allows enrolling for other users as well as for self and paying either using a Purchase Order or Training Units.
    
    

    Parameter	Value	Type	Location	Description
    paymentRequests		string	query	Payment Requests
    cartRequest		string	query	Cart Request
    @type		string	query	Input JSON class name

  • PUTMark a task/registration module complete/learning/enroll/assignments/action/:regModuleId?action=:actionName
    Allows to mark a task/registration module complete.
    
    

    Parameter	Value	Type	Location	Description
    regModuleId		string	query	Registration module ID
    actionName	markCompletesignoff	enumerated	query	Action to be performed
    @type		string	query	Input JSON class name
    evaluatorIds		string	query	List of evaluator IDs

  • PUTMark an enrollment complete/learning/enroll/:regId/status
    Allows to mark an enrollment complete.
    
    

    Parameter	Value	Type	Location	Description
    regId		string	query	Registration's ID
    @type		string	query	Input JSON class name
    status		string	query	Accepts successful - 200, unsuccessful - 400
    score		string	query	Score
    grade		string	query	Grade
    comment		string	query	Comment

  • PUTCancel an enrollment/learning/enroll/:regId?action=cancel
    Allows canceling an enrollment. In addition to cancelling an enrollment, this API also takes care of refunding the charges, if any according to drop policy.
    
    

    Parameter	Value	Type	Location	Description
    regId		string	query	Registration's ID

  • POSTGet existing registration details or auto enroll user and get registration details/learning/enroll/:learner/:offering/autoenroll
    Returns the existing details of the registration. If the enrollment does not exist, then the learner will be enrolled to the class. If the enrollment already exists or the learner has already completed the class then the enrollment record ID will be returned.
    
    

    Parameter	Value	Type	Location	Description
    learner		string	query	Person id or username or person_no
    offering		string	query	Offering Id or unique offering number
    deliveryType		string	query	Delivery Type name in case of class no used for offering

  • GETSearch enrollments based on given criteria/learning/enroll/search?q=(:searchCriteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the enrollments based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    searchCriteria		string	query	Comma separated list of conditions
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Do you want enrollment details (true | false)

  • POSTFind learning assignments for registrations/learning/enroll/assignments/find
    Returns the existing learning assignments of the registration id provided.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	registration ids and learner condition.

  • POSTFind evaluations for registrations/learning/enroll/evaluations/search
    Returns the existing evaluations of the registration id provided.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	registration ids or learner condition.

  • PUTUpdate the custom fields of an enrollment/learning/enroll/:regId/custom
    Registrar/Catalog/People Admin can update the custom fields of an enrollment of a user
    
    

    Parameter	Value	Type	Location	Description
    regId		string	query	Registration's ID
    @type		string	query	Input JSON class name
    customValues		string	query	Custom Values

• Class

  • List Methods
  • Expand Methods

  • GETGet the meta details of an ILT class/offering/meta:(:searchFields)?type=:type
    Returns the meta details of an ILT class.
    
    

    Parameter	Value	Type	Location	Description
    type	instructor_ledweb_basedblendedvirtual_class	enumerated	query	The type of cereal desired
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of an class/offering/:offeringId
    Returns the meta details of an class.
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    context		String	query	Context

  • GETGet the details of an class by offering number/offering/:offeringType/:offeringNumber
    Returns the details of an class.
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Delivery Type, it can be ilt, wbt, vc, blended or name of custom delivery type.
    offeringNumber		string	query	Offering number

  • GETGet All classes/offering?type=:type&count=:count&startPage=:startPage
    Returns all classes for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    type		string	query	The type of class
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Classes/offering?type=:type&q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the classes along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    type		string	query	The type of desired class.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the extended details of the Classes/offering/search?type=:type&q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the classes along with the ID, class_no and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    type		string	query	The type of desired class.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the extended details of the class (Using POST - Range based search)/offering/search?type=:type&count=:count&startPage=:startPage
    Returns the details of the class along with the ID, part_no and the Deeplink URL based on the provided range based search criteria.
    
    

    Parameter	Value	Type	Location	Description
    type		string	query	The type of desired class.
    conditions		string	query	Conditions that need to be used as part of the request body.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Blended Class/offering
    Creates a new Blended class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    description		string	query	Description
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    learningAssignments		string	query	Learning Assignments
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    name		string	query	Course name
    offering_temp_id		string	query	Course's ID
    open_enroll		string	query	Open enroll
    open_enroll_for_all		string	query	Open enroll for all
    securityDomain		string	query	Security Domain
    skip_days_map		string	query	Skip days map
    start_date		string	query	Start date
    endDate		string	query	End Date
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    wbt_no		string	query	WBT No
    enforced_seq	100200300	enumerated	query	Enforce Sequencing: 100 - Suggested, 200 - Enforced & 300-Enforced with successful completion
    hide_toc		string	query	Hide toc value

  • POSTCreate a new WBT Class/offering
    Creates a new WBT Class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    microLearning		string	query	microLearning
    language_id		string	query	Language's ID
    learningAssignments		string	query	Learning Assignments
    manufacturer_id		string	query	Manufacturer's ID
    name		string	query	Course's name
    offering_temp_id		string	query	Course's ID
    securityDomain		string	query	Security Domain
    vendor_id		string	query	Vendor's ID
    class_no		string	query	Class No
    enforced_seq	100200300	enumerated	query	Enforce Sequencing: 100 - Suggested, 200 - Enforced & 300-Enforced with successful completion

  • POSTCreate a new ILT Class/offering
    Creates a new ILT Class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center
    trainingUnits		string	query	Training Units
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    start_date		string	query	Start date
    endDate		string	query	End Date
    name		string	query	Course's name
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    class_no		string	query	Class's No
    session_template		string	query	Session template
    offeringSessions		string	query	Offering Sessions

  • POSTCreate a new Virtual Class/offering
    Creates a new Virtual Class Class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    start_date		string	query	Start date
    endDate		string	query	End Date
    name		string	query	Course's name
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    class_no		string	query	Class No
    session_template		string	query	Session template
    do_not_drop_post		string	query	Do not drop post
    vleInfo		string	query	VLE info
    offeringSessions		string	query	Offering Sessions
    hide_toc		string	query	Hide toc value

  • PUTUpdate a Blended Class/offering/:offeringId?patch=:patch
    Updates a Blended class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringId		string	query	Blended class's ID
    description		string	query	Description
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    learningAssignments		string	query	Learning Assignments
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    name		string	query	Course's name
    offering_temp_id		string	query	Course ID
    open_enroll		string	query	Open enroll
    open_enroll_for_all		string	query	Open enroll for all
    securityDomain		string	query	Security Domain
    skip_days_map		string	query	Skip days map
    start_date		string	query	Start date
    endDate		string	query	End date
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    enforced_seq	100200300	enumerated	query	Enforce Sequencing: 100 - Suggested, 200 - Enforced & 300-Enforced with successful completion
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate a Blended Class by offering number/offering/blended/:offeringNumber?patch=:patch
    Updates a Blended class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringNumber		string	query	Blended class's class number
    description		string	query	Description
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    learningAssignments		string	query	Learning Assignments
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    name		string	query	Course's name
    offering_temp_id		string	query	Course ID
    open_enroll		string	query	Open enroll
    open_enroll_for_all		string	query	Open enroll for all
    securityDomain		string	query	Security Domain
    skip_days_map		string	query	Skip days map
    start_date		string	query	Start date
    endDate		string	query	End date
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    enforced_seq	100200300	enumerated	query	Enforce Sequencing: 100 - Suggested, 200 - Enforced & 300-Enforced with successful completion
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate locale-specific details of blended class/offering/:instanceId/locale
    Update locale-specific attributes of blended class.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • PUTUpdate a WBT Class/offering/:offeringId?patch=:patch
    Updates a WBT Class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringId		string	query	WBT class's ID
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    language_id		string	query	Language's ID
    microLearning		string	query	microLearning
    learningAssignments		string	query	Learning Assignments
    manufacturer_id		string	query	Manufacturer's ID
    name		string	query	Course's name
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    vendor_id		string	query	Vendor's ID
    enforced_seq	100200300	enumerated	query	Enforce Sequencing: 100 - Suggested, 200 - Enforced & 300-Enforced with successful completion
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate a WBT Class by offering number/offering/wbt/:offeringNumber?patch=:patch
    Updates a WBT Class by offering number.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringNumber		string	query	WBT class's wbt number
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    language_id		string	query	Language's ID
    microLearning		string	query	microLearning
    learningAssignments		string	query	Learning Assignments
    manufacturer_id		string	query	Manufacturer's ID
    name		string	query	Course's name
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    vendor_id		string	query	Vendor's ID
    enforced_seq	100200300	enumerated	query	Enforce Sequencing: 100 - Suggested, 200 - Enforced & 300-Enforced with successful completion
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate locale-specific details of wbt offering/offering/:instanceId/locale
    Update locale-specific attributes of wbt offering.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • PUTUpdate a ILT Class/offering/:offeringId?patch=:patch
    Updates an ILT class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringId		string	query	ILT class's ID
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enrol close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max Book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    start_date		string	query	Start date
    endDate		string	query	End Date
    name		string	query	Course's name
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    session_template		string	query	Session template
    offeringSessions		string	query	Offering Sessions
    replaceExistingSessions		string	query	Whether to replcae offering sessions with existing sesisons or not.
    resourceCancellationType		string	query	Resource cancellation type, Possible values could be cancelResources, retainResourcesFailConflict or retainResourcesIgnoreConflict
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate a ILT Class by offering number./offering/ilt/:offeringNumber?patch=:patch
    Updates an ILT class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringNumber		string	query	ILT class's offering number.
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enrol close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max Book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    start_date		string	query	Start date
    endDate		string	query	End Date
    name		string	query	Course's name
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    session_template		string	query	Session template
    offeringSessions		string	query	Offering Sessions
    replaceExistingSessions		string	query	Whether to replcae offering sessions with existing sesisons or not.
    resourceCancellationType		string	query	Resource cancellation type, Possible values could be cancelResources, retainResourcesFailConflict or retainResourcesIgnoreConflict
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate locale-specific details of ILT class/offering/:instanceId/locale
    Update locale-specific attributes of ILT class.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • PUTUpdate a Virtual Class/offering/:offeringId?patch=:patch
    Updates a Virtual Class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringId		string	query	VC class's ID
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    start_date		string	query	Start date
    endDate		string	query	End Date
    name		string	query	Course's name
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    session_template		string	query	Session Template
    do_not_drop_post		string	query	Do not drop post
    vleInfo		string	query	VLE info
    offeringSessions		string	query	Offering Sessions
    replaceExistingSessions		string	query	Whether to replcae offering sessions with existing sesisons or not.
    resourceCancellationType		string	query	Resource cancellation type, Possible values could be cancelResources, retainResourcesFailConflict or retainResourcesIgnoreConflict
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate a Virtual Class by offering number./offering/vc/:offeringNumber?patch=:patch
    Updates a Virtual Class.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    offeringNumber		string	query	VC class's offering id.
    description		string	query	Description
    duration		string	query	Duration
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    disp_for_web		string	query	Display for web?
    disp_for_call_center		string	query	Display for call center?
    trainingUnits		string	query	Training Units
    csr_id		string	query	CSR's ID
    customFields		string	query	Custom Fields
    delivery_id		string	query	Delivery's ID
    enroll_close		string	query	Enroll close
    facility		string	query	Facility
    facility_id		string	query	Facility's ID
    language_id		string	query	Language's ID
    location_id		string	query	Location's ID
    manufacturer_id		string	query	Manufacturer's ID
    max_book		string	query	Max book
    max_ct		string	query	Max CT
    min_ct		string	query	Min CT
    offering_temp_id		string	query	Course ID
    securityDomain		string	query	Security Domain
    start_date		string	query	Start date
    endDate		string	query	End Date
    name		string	query	Course's name
    stop_auto_promotion		string	query	Stop auto promotion
    vendor_id		string	query	Vendor's ID
    session_template		string	query	Session Template
    do_not_drop_post		string	query	Do not drop post
    vleInfo		string	query	VLE info
    offeringSessions		string	query	Offering Sessions
    replaceExistingSessions		string	query	Whether to replcae offering sessions with existing sesisons or not.
    resourceCancellationType		string	query	Resource cancellation type, Possible values could be cancelResources, retainResourcesFailConflict or retainResourcesIgnoreConflict
    patch		string	query	Whether to perform update using patch operation[true|false]

  • PUTUpdate locale-specific details of virtual class/offering/:instanceId/locale
    Update locale-specific attributes of virtual class.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • POSTMark Class as Delivered/Cancelled/offering/:offeringId/action
    Mark Class as Delivered/Cancelled
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	OfferingId
    @type		string	query	@type
    actionName		string	query	Action that can be Delivered or Cancelled
    deliveryDate		string	query	DeliveryDate for Action Delivered
    doCreateOfferingRequest		string	query	Whether to create new offering or not
    auditReason		string	query	Audit Reason

  • PUTMark Class registration as No_Show / Walk_In/learning/offering/:offeringId/roster/action
    Mark class registration
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    @type		string	query	@type
    registrationIds		string	query	Registration Id
    status	NO_SHOWWALK_IN	enumerated	query	Status
    reason		string	query	Reason

  • GETGet Roster detail for session based class/learning/offering/:offeringId/roster
    Returns roster detail for session based class.
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    registrationStatus	allconfirmedofferedwaitlisted	enumerated	query	Filter roster entries based on status. Acceptable values are (case-insensitive)

  • POSTAdd learner to session based class via roster/learning/offering/:offeringId/roster/:learnerId?ignoreWarnings=:ignoreWarnings
    Add learner to session based class via roster
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    learnerId		string	query	Learner's Id who needs to be enrolled for class
    ignoreWarnings		string	query	Whether to proceed with enrollment in case of enrollment warnings[true|false]

  • DELETERemove learner from session based class via roster/learning/offering/:offeringId/roster/:learnerId?applyLateCharges=:applyLateCharges&auditReason=:auditReason
    Remove learner from session based class via roster
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    learnerId		string	query	Learner's Id who needs to enrolled for class
    applyLateCharges		string	query	Whether to apply applicable cancellation charges for an enrollment[true|false]
    auditReason		string	query	Reason for dropping learner's enrollment

  • GETRetrieve all the classes of an Instructor/offering/instructor/:instructorId?q=(:q)&count=:count&startPage=:startPage
    Returns all the classes of an Instructor
    
    

    Parameter	Value	Type	Location	Description
    instructorId		string	query	Instructor's ID
    q		string	query	The search criteria i.e. the field name.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETRetrieve all the sessions of an Offering/offering/:offeringId/session
    Retrieves all the sessions of an Offering
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Id of the Scheduled Offering

  • POSTAdd drop policy to class/learning/offering/:offeringId/droppolicy
    Add drop policy to class
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    @type		string	query	@type
    currency		string	query	Specify currency reference
    daysFrom		string	query	Enter day from which policy needs to be applied
    charge		string	query	Enter charge amount
    chargeType		string	query	Enter 0 for flat charge and 1 for percentage charge

  • DELETERemove drop policy from class/learning/offering/:offeringId/droppolicy/:policyId
    Remove drop policy from class
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    policyId		string	query	Id of the drop policy to be deleted

  • DELETECancel all enrollment of a class./offering/:classId/enrollments?action=:action&applyCharge=:applyCharge
    Cancel all enrollment of a class.
    
    

    Parameter	Value	Type	Location	Description
    classId		string	query	Class Id whose enrollments will be cancelled
    action		string	query	Action for the enrollments
    applyCharge		string	query	Whether to apply charge or not

  • GETRetrieve all learning assignments of a class/offering/:offeringId/learningassignment
    Retrieves all learning assignments of a class
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID

  • GETRetrieve all learning assignments of a class by offering number/offering/:offeringType/:offeringNumber/learningassignment
    Retrieves all learning assignments of a class
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Delivery Type, it can be ilt, wbt, vc, blended or name of custom delivery type.
    offeringNumber		string	query	Offering number.

  • POSTAdd learning assignments to a class/offering/:offeringId/learningassignment
    Adds learning assignments to a class
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    learningAssignments		string	query	Details of the learning assignment

  • GETGet evaluations of offering / course / delivery mode/evaluations/:ownerId
    Get evaluations of offering / course / delivery mode
    
    

    Parameter	Value	Type	Location	Description
    ownerId		string	query	Owners Id

  • POSTAdd evaluations of offering / course / delivery mode/evaluations/:ownerId
    Add evaluations of offering / course / delivery mode
    
    

    Parameter	Value	Type	Location	Description
    ownerId		string	query	Owners id
    @type		string	query	@type
    evaluationId		string	query	Evaluation id
    evalScheduleType	100200	enumerated	query	Evaluations Schedule
    completionDays		number	query	Completion Days
    expirationDays		number	query	Expiration Days
    acquirer	LEARNERMANAGER	enumerated	query	Acquirer
    disableEval		boolean	query	Disable Evaluation
    isDraft		boolean	query	Is Evaluation a draft

  • PUTUpdate evaluations of offering / course / delivery mode/evaluations/:ownerId
    Update evaluations of offering / course / delivery mode
    
    

    Parameter	Value	Type	Location	Description
    ownerId		string	query	Owners id
    @type		string	query	@type
    evaluationId		string	query	Evaluation id
    Id		string	query	Id
    name		string	query	Name of the evaluation
    version		string	query	Version of the evaluation
    evalScheduleType	100200	enumerated	query	Evaluations Schedule
    completionDays		number	query	Completion Days
    expirationDays		number	query	Expiration Days
    acquirer	LEARNERMANAGER	enumerated	query	Acquirer
    disableEval		boolean	query	Disable Evaluation
    isDraft		boolean	query	Is Evaluation a draft

  • POSTPublish evaluations of offering/evaluations/publish/:ownerId
    Publish evaluations of offering
    
    

    Parameter	Value	Type	Location	Description
    ownerId		string	query	Owners id
    pushType	ALLNEW_REGISTRATIONSNEW_AND_INPROGRESS_REGISTRATIONSNEW_COMPLETED	enumerated	query	Push type decides which evaluations should impact with this publish activity

  • DELETEDelete evaluations of offering / course / delivery mode/evaluations/:ownerId?evaluationId=:evaluationId&id=:id
    Delete evaluations of offering / course / delivery mode
    
    

    Parameter	Value	Type	Location	Description
    ownerId		string	query	Owners Id
    evaluationId		string	query	evaluation Id
    id		string	query	id

  • POSTAdd learning assignments to a class by offering number/offering/:offeringType/:offeringNumber/learningassignment
    Adds learning assignments to a class
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Delivery Type, it can be ilt, wbt, vc, blended or name of custom delivery type.
    offeringNumber		string	query	Offering number.
    learningAssignments		string	query	Details of the learning assignment

  • PUTUpdate learning assignments of a class/offering/:offeringId/learningassignment
    Updates learning assignments of a class
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Class's ID
    learningAssignments		string	query	Details of the learning assignment

  • PUTUpdate learning assignments of a class by offering number/offering/:offeringType/:offeringNumber/learningassignment
    Updates learning assignments of a class
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Delivery Type, it can be ilt, wbt, vc, blended or name of custom delivery type.
    offeringNumber		string	query	Offering number
    learningAssignments		string	query	Details of the learning assignment

  • PUTPublish learning assignments of a class/offering/publishassignment
    Publish learning assignments of a class
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    owner		string	query	Class's ID
    pushType	ALLNEW_REGISTRATIONSNEW_AND_INPROGRESS_REGISTRATIONSNEW_COMPLETED	enumerated	query	Push type decides which registration should impact with this publish activity
    optionalElementsToComplete		string	query	Optional elements to complete
    sequenceType	SUGGESTEDENFORCEDFORANYSTATUSENFORCEDFORCOMPLETIONSTATUS	enumerated	query	Options for sequence type
    auditReason		string	query	Audit Reason

  • POSTAsign resource to an offering by offering id./learning/resourceassign/:offeringId
    Asign resource to an offering by offering id.
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Offering Id
    @type		string	query	@type
    resource		string	query	Resource
    quantity		string	query	Resource quantity.
    role		string	query	Resource role.
    selectSessions		string	query	Select Sessions.
    purpose		string	query	Purpose
    resourcetype		string	query	Type of resource. Can be person, inventory, equipment, room.
    allSessions		string	query	Whether to include all sessions of offering for resoruce or not.

  • POSTAsign resource to an offering by offering number./learning/resourceassign/:offeringType/:offeringNumber
    Asign resource to an offering by offering number.
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Type
    offeringNumber		string	query	Offering Number
    @type		string	query	@type
    resource		string	query	Resource
    quantity		string	query	Resource quantity.
    role		string	query	Resource role.
    selectSessions		string	query	Select Sessions.
    purpose		string	query	Purpose
    resourcetype		string	query	Type of resource. Can be person, inventory, equipment, room.
    allSessions		string	query	Whether to include all sessions of offering for resoruce or not.

  • GETGet particular resource by resource Id/learning/resourceassign/:resourceId
    Get particular resource by resource Id
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Resource Id.

  • GETGet all resources for offering/learning/resourceassign/:offeringId/assignedresources
    Get all resources for offering
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Offering id.

  • GETGet all resources for offering - user friendly/learning/resourceassign/:offeringType/:offeringNumber/assignedresources
    Get assigned resources to a offering by offering number
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Delivery Type, it can be ilt, wbt, vc, blended or name of custom delivery type.
    offeringNumber		string	query	Offering id.

  • PUTUpdate resource assignment/learning/resourceassign/:resourceId
    Update resource assignment
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    resourceId		string	query	Resource assignment Id
    resource		string	query	Resource
    quantity		string	query	Resource quantity.
    role		string	query	Resource role.
    selectSessions		string	query	Select Sessions.
    purpose		string	query	Purpose
    resourcetype		string	query	Type of resource. Can be person, inventory, equipment, room.
    allSessions		string	query	Whether to include all sessions of offering for resoruce or not.

  • PUTUpdate resource assignment - user friendly/learning/resourceassign/:offeringType/:offeringNumber/:typeofresource/:resourceName
    Update resource assignment - user friendly
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Type
    offeringNumber		string	query	Offering Number
    typeofresource		string	query	Resource Type, it can be room, person, equipment or inventory.
    resourceName		string	query	resource name.
    @type		string	query	@type
    resource		string	query	Resource
    quantity		string	query	Resource quantity.
    role		string	query	Resource role.
    selectSessions		string	query	Select Sessions.
    purpose		string	query	Purpose
    resourcetype		string	query	Type of resource. Can be person, inventory, equipment, room.
    allSessions		string	query	Whether to include all sessions of offering for resoruce or not.

  • DELETEDelete resource assignment./learning/resourceassign/:resourceassignmentId
    Delete resource assignment to an offering by id.
    
    

    Parameter	Value	Type	Location	Description
    resourceassignmentId		string	query	Resource Assignment Id.

  • DELETEDelete resource assignment - user friendly/learning/resourceassign/:offeringType/:offeringNumber/:resourceType/:resourceName
    Delete resource assignment - user friendly
    
    

    Parameter	Value	Type	Location	Description
    offeringType		string	query	Offering Delivery Type, it can be ilt, wbt, vc, blended or name of custom delivery type.
    offeringNumber		string	query	Offering id.
    resourceType		string	query	Resource Type, it can be room, person, equipment or inventory.
    resourceName		string	query	Offering id.

  • GETGet all External Co-Presenters of VC Offering/learning/resourceassign/:offeringId/external-co-presenter
    Get all External co-presenters of VC Offering
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	VC Offering id or offering number.

  • POSTAsign External Co-Presenters to VC offering./learning/resourceassign/:offeringId/external-co-presenter
    Asign External Co-Presenters to VC offering.
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Offering Id or offering number
    externalUsers		string	query	List of external users

  • DELETEDelete External Co-Presenters from VC offering./learning/resourceassign/:offeringId/external-co-presenter/:loginId
    Delete External Co-Presenters from VC offering.
    
    

    Parameter	Value	Type	Location	Description
    offeringId		string	query	Offering Id or offering number
    loginId		string	query	Login id of External-Co-Presenter

• PlayList

  • List Methods
  • Expand Methods

  • GETGet all playlists/playlist
    Get all playlists
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.

  • GETGet playlist detail by id/playlist/:id
    Can get playlist detail by passing it's Id
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Playlist id

  • GETGet playlist detail using name/playlist/name=:playlistName
    Can get playlist detail by passing it's name
    
    

    Parameter	Value	Type	Location	Description
    playlistName		string	query	Playlist name

  • POSTSearch playlists with post based query/playlist/searchQuery
    Returns details of playlist
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of PriceList
    conditions		string	query	Conditions

  • POSTCreate New Playlist/playlist
    Create new playlist.
    
    

    Parameter	Value	Type	Location	Description
    securityDomain		string	query	Domain of playlist
    learningInterventions		string	query	Learning interventions of the module, at least one learning intervention is must to create learning module.
    name		string	query	Name of playlist
    description		string	query	description of playlist
    avl_from		string	query	available from date of playlist
    disc_from		string	query	available from date of playlist
    featured		string	query	if playlist is featured
    publish_to_catalog		string	query	if playlist need to be published

  • PUTUpdate playlist/playlist/:id
    Allows Updating Playlist
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Playlist id
    securityDomain		string	query	The pricelist for the Learning item
    learningInterventions		string	query	Learning interventions of the module, at least one learning intervention is must to create learning module.
    name		string	query	Name of playlist
    description		string	query	description of playlist
    avl_from		string	query	available from date of playlist
    disc_from		string	query	available from date of playlist
    featured		string	query	if playlist is featured
    publish_to_catalog		string	query	if playlist need to be published

  • GETGet playlist detail with association by id/playlist/:id?includeassociation=:includeassociation
    Can get playlist detail by passing it's Id
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Playlist id
    includeassociation		string	query	Indicate association object details needs to be returned. Possible value (true / false)

  • POSTCreate New Playlist with association/playlist
    Create new playlist with association.
    
    

    Parameter	Value	Type	Location	Description
    securityDomain		string	query	Domain of playlist
    learningInterventions		string	query	Learning interventions of the module, at least one learning intervention is must to create learning module.
    name		string	query	Name of playlist
    description		string	query	description of playlist
    avl_from		string	query	available from date of playlist
    disc_from		string	query	available from date of playlist
    featured		string	query	if playlist is featured
    publish_to_catalog		string	query	if playlist need to be published
    associations		string	query	Associations that needs to be added

  • PUTUpdate playlist associatons/playlist/:id
    Allows Updating Playlist associations
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Playlist id
    securityDomain		string	query	The pricelist for the Learning item
    learningInterventions		string	query	Learning interventions of the module, at least one learning intervention is must to create learning module.
    name		string	query	Name of playlist
    description		string	query	description of playlist
    avl_from		string	query	available from date of playlist
    disc_from		string	query	available from date of playlist
    featured		string	query	if playlist is featured
    publish_to_catalog		string	query	if playlist need to be published
    associations		string	query	Associations that needs to be added

  • DELETEDelete a particular Playlist/playlist/:id
    Delete a particular Playlist
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of Playlist

• Transcript

  • List Methods
  • Expand Methods

  • GETGet the meta details of transcript/transcripts/meta:(:searchFields)
    Returns the meta details of the transcript.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of transcript (Using the component framework)/transcripts/:transcriptId:(:searchFields)
    Returns the details of the transcript using component .
    
    

    Parameter	Value	Type	Location	Description
    transcriptId		string	query	Transcript's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of transcript/transcript/:transcriptId
    Returns the details of the transcript.
    
    

    Parameter	Value	Type	Location	Description
    transcriptId		string	query	Transcript's ID

  • GETGet All Transcripts/transcripts?count=:count&startPage=:startPage
    Returns all Transcripts for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Transcripts/transcripts?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Transcripts along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the Transcripts that have changed over a given period of time/transcripts?q=(time_interval%3D%3D:field_value)&count=:count&startPage=:startPage
    Find the details of the Transcripts that have changed over a given period of time
    
    

    Parameter	Value	Type	Location	Description
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of the Transcripts (Using POST - Range based search)/transcripts/searchQuery?count=:count&startPage=:startPage
    Returns the details of the Transcripts along with the ID, Name and the Deeplink URL based on the provided range based search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions that need to be used as part of the request body.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new transcript/transcript
    Creates a new transcript
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    createNew		string	query	create New if true or Use existing if false
    learners		string	query	Learners
    location		string	query	Location
    deliveryType		string	query	Delivery Type
    fos		string	query	FOS
    competencies		string	query	Competencies
    courseId		string	query	Course's ID
    endTime		string	query	End Time
    version		string	query	Version
    startTime		string	query	Start Time
    deliveredBy		string	query	Delivered By
    duration		string	query	Duration
    offeringEndDate		string	query	Offering End Date
    description		string	query	Description
    courseNo		string	query	Course No
    offeringStartDate		string	query	Offering Start Date
    courseName		string	query	Course Name
    defaultCourseCredits		string	query	Default Course Credits
    customValues		string	query	Custom values

  • PUTUpdate a transcript/transcript/:transcriptId
    Updates a transcript.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    transcriptId		string	query	Transcript's ID
    durationStr		string	query	Duration
    completionDate		string	query	Completion Date
    totalProviderCredits		string	query	Total Provider Credits
    totalCredits		string	query	Total Credits
    Pending Approval		string	query	Completion Status Display
    grade		string	query	Grade
    startTime		string	query	Start Time
    endTime		string	query	End Time
    offeringStartDate		string	query	Offering Start Date
    offeringEndDate		string	query	Offering End Date
    score		string	query	Score
    deliveryTypeReference		string	query	Delivery Type Reference
    ceCourseCredits		string	query	Course Credits
    courseCompetencies		string	query	Course Competencies
    customValues		string	query	Custom values

  • DELETEDelete a transcript/transcripts/:id
    Deletes a transcript.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Transcript's ID

  • PUTUpdate the custom fields of the transcript/transcript/:transcriptId/custom
    Updates the custom fields of the transcript
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    transcriptId		string	query	Transcript's ID
    customValues		string	query	Custom values

• Purchase Order

  • List Methods
  • Expand Methods

  • GETGet the meta details of the purchase order/purchaseorder/meta:(:searchFields)
    Returns the meta details of the purchase order.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular purchase order/purchaseorder/:id:(:searchFields)
    Returns complete information about a purchase order based on the PO's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	PurchaseOrder's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular purchase order from purchase order number/purchaseorder/po_no=:number:(:searchFields)
    Returns complete information about a purchase order based on the PO's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    number		string	query	PurchaseOrder's Number
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Purchase Orders/purchaseorder?count=:count&startPage=:startPage
    Returns all Purchase Orders for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Purchase Order/purchaseorder?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the purchase order along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new purchase order/purchaseorder
    Allows creating a new purchase order.
    
    

    Parameter	Value	Type	Location	Description
    external_po_no		string	query	External Purchase Order Number
    po_no		string	query	Purchase Order Number
    organization		string	query	Account for PO
    terms		string	query	Terms for PO
    contact_id		string	query	Contact for PO
    expiry_dt		string	query	Expiry date for PO
    po_status		string	query	Status for PO
    initial_cr		string	query	Purchase Order Amount
    amt_booked		string	query	Amount Booked
    currency_id		string	query	Currency for PO
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the facility

  • PUTUpdate the details of a purchase order/purchaseorder/:id
    Allows updating an existing purchase order based on the PO's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	PO's ID
    external_po_no		string	query	External Purchase Order Number
    organization		string	query	Account for PO
    terms		string	query	Terms for PO
    contact_id		string	query	Contact for PO
    expiry_dt		string	query	Expiry date for PO
    po_status		string	query	Status for PO
    initial_cr		string	query	Purchase Order Amount
    amt_booked		string	query	Amount Booked
    currency_id		string	query	Currency for PO
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the PO

  • PUTUpdate the details of a purchase order from purchase order number/purchaseorder/po_no=:po_no
    Allows updating an existing purchase order based on the PO's number.
    
    

    Parameter	Value	Type	Location	Description
    po_no		string	query	PO's Number
    external_po_no		string	query	External Purchase Order Number
    organization		string	query	Account for PO
    terms		string	query	Terms for PO
    contact_id		string	query	Contact for PO
    expiry_dt		string	query	Expiry date for PO
    po_status		string	query	Status for PO
    initial_cr		string	query	Purchase Order Amount
    amt_booked		string	query	Amount Booked
    currency_id		string	query	Currency for PO
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the PO

  • DELETEDelete the details of a particular purchase order/purchaseorder/:id
    Delete a purchase order based on the PO's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	PurchaseOrder's ID

  • DELETEDelete the details of a particular purchase order from number/purchaseorder/po_no=:po_no
    Delete a purchase order based on the PO's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    po_no		string	query	PurchaseOrder's ID

  • POSTFind the details of PO (Using POST - Range based search)/purchaseorder/searchQuery?count=:count&startPage=:startPage
    Returns the details of the PO along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	conditions
    count		string	query	No description
    startPage		string	query	No description

• Training Unit

  • List Methods
  • Expand Methods

  • GETGet the meta details of the Training Unit/trainingunit/meta:(:searchFields)
    Returns the meta details of the Training Unit.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular training unit/trainingunit/:id:(:searchFields)
    Returns complete information about a training unit based on the Training Unit's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Training Unit's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Training Units/trainingunit?count=:count&startPage=:startPage
    Returns all Training Units for which the user does has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Training Unit/trainingunit?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the training unit along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Training Unit (Using POST - Range based search)/trainingunit/searchQuery?count=:count&startPage=:startPage
    Returns the details of the Training Unit along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	conditions
    count		string	query	No description
    startPage		string	query	No description

  • POSTCreate a new training unit/trainingunit
    Allows creating a new training unit.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of Training Unit
    priceList		string	query	Currency with price for Training Unit
    currencySelectionMode		string	query	Currency selection mode for Training Unit
    available_from		string	query	Available from date for Training Unit
    discontinued_from		string	query	Discontinued from date for Training Unit
    validtill_days		string	query	Valid till days
    discountEntries		string	query	Discounts for Training Unit
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the Training Unit
    restricted_access		string	query	Restrcited training unit.

  • PUTUpdate the details of a training unit/trainingunit/:id
    Allows updating an existing training unit based on the Training Unit's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Training Unit's ID
    name		string	query	Name of Training Unit
    available_from		string	query	Available from date for Training Unit
    discontinued_from		string	query	Discontinued from date for Training Unit
    validtill_days		string	query	Valid till days
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the Training Unit
    restricted_access		string	query	Restrcited training unit.

  • PUTUpdate locale-specific details training unit/trainingunit/:instanceId/locale
    Update locale-specific attributes of training unit.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • DELETEDelete a particular training unit/trainingunit/:id
    Delete a training unit based on the Training Unit's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Training Unit's ID

  • GETGet the details of a particular discount entry for the training unit/trainingunit/:tuid/discountEntries/:deid:(:searchFields)
    Returns complete information about a discount entry for the training unit based on the Training Unit's ID and the Discount Entry's ID that are passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	Training Unit's ID
    deid		string	query	Discount Entries's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • POSTCreate a new discount entry for the training unit/trainingunit/:tuid/discountEntries
    Allows creating a new discount entry for the training unit.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	Training Unit's ID
    low_value		string	query	Low value
    high_value		string	query	High value
    discount		string	query	Discount

  • DELETEDelete a particular discount entry for the training unit/trainingunit/:tuid/discountEntries/:deid
    Delete a discount entry for the training unit based on the Discount Entry's ID and Training Unit's ID that are passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	Training Unit's ID
    deid		string	query	Discount Entries's ID

  • GETGet the details of a particular pricelist entry for the training unit/trainingunit/:tuid/priceList/:plid:(:searchFields)
    Returns complete information about a pricelist entry for the training unit based on the Training Unit's ID and the pricelist Entry's ID that are passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	TrainingUnit's ID
    plid		string	query	Pricelist's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • POSTCreate a new pricelist entry for the training unit/trainingunit/:tuid/priceList
    Allows creating a new pricelist entry for the training unit.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	TrainingUnit's ID
    curr_id		string	query	Currency for pricelist
    amount		string	query	Amount per training unit

  • PUTUpdate the details of a particular pricelist entry for the training unit/trainingunit/:tuid/priceList/:plid
    Updates a pricelist entry for the training unit based on the Pricelist's ID and Training Unit's ID that are passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	TrainingUnit's ID
    plid		string	query	Pricelist's ID
    amount		string	query	Amount per training unit

  • DELETEDelete a particular pricelist entry for the training unit/trainingunit/:tuid/priceList/:plid
    Deletes a pricelist entry for the training unit based on the Pricelist's ID and Training Unit's ID that are passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    tuid		string	query	TrainingUnit's ID
    plid		string	query	Pricelist's ID

• Training Unit Agreement

  • List Methods
  • Expand Methods

  • GETGet the meta details of Training Unit Agreement/tuagreement/meta:(:searchFields)
    Returns the meta details of the Training Unit Agreement.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular Training Unit Agreement/tuagreement/:id:(:searchFields)
    Returns complete information about a training unit agreement based on the Training Unit Agreement's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	TrainingUnitAgreement's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Training Unit Agreements/tuagreement?count=:count&startPage=:startPage
    Returns all Training Unit Agreements for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Training Unit Agreement/tuagreement?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Training Unit Agreement along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new training unit agreement/tuagreement
    Allows creating a new training unit agreement.
    
    

    Parameter	Value	Type	Location	Description
    owner_id		string	query	Organization for Training Unit Agreement
    order_contact		string	query	Order contact for Training Unit Agreement
    expiration_date		string	query	Expiration date for Training Unit Agreement
    agreement_no		string	query	Agreement Number for Training Unit Agreement
    is_shared_with_other_orgs		string	query	Allows you to share the training units agreement with other organizations
    trainingunit_id		string	query	Trainingunit for Training Unit Agreement
    no_unit		string	query	No of units for Training Unit Agreement
    currency		string	query	Currency
    paymentType		string	query	Payment Type for Training Unit Agreement
    paymentTransactionId		string	query	Payment Transaction ID for Training Unit Agreement
    invoiceRequest		string	query	Payment using InvoiceMe for Training Unit Agreement
    customValues		string	query	custom Values

  • PUTUpdate the details of a training unit agreement/tuagreement/:id
    Allows updating an existing training unit agreement based on the Training Unit Agreement's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Training Unit Agreement's ID
    agreement_no		string	query	Agreement Number for Training Unit Agreement
    is_shared_with_other_orgs		string	query	Allows you to share the training units agreement with other organizations
    expiration_date		string	query	Expiration date for Training Unit Agreement
    customValues		string	query	Custom values

• Attendance

  • List Methods
  • Expand Methods

  • GETGet the meta details of attendance/attendance/meta:(:searchFields)
    Returns the meta details of the attendance.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular attendance/attendance/:id:(:searchFields)
    Returns complete information about an attendance based on the Attendance's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Attendance's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • POSTMark attendance for a learner/attendance
    Marks the attendance for a learner
    
    

    Parameter	Value	Type	Location	Description
    offering		string	query	Offering's ID
    learner		string	query	Learner's ID
    session_no		string	query	Session No
    hours		string	query	Hours
    minutes		string	query	Minutes

  • GETSearch details of a attendance/attendance?q=(:criteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns complete information about an attendance based on the offering or learner.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	Condition for attendance search
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the Session Templates in the search

  • POSTPost based search details of a attendance/attendance/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns complete information about an attendance based on the offering or learner.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the attendance in the search

  • POSTUpdate attendance in Bulk/learning/offering/:offeringId/roster/attendance
    Update attendance of session classes by updating in Bulk
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	Input JSON class name
    offeringId		string	query	Offering's ID
    allLearners		string	query	Mark for all learners?
    sessionNo		string	query	Specify number of session to mark attendance
    hours		string	query	Specify hours
    minutes		string	query	Specify minutes
    learners		string	query	List of learners
    learnerSessions		string	query	List of learners with duration details

• Learning Event

  • List Methods
  • Expand Methods

  • POSTAssign certification/curriculum to a person/learning/heldlearningevent/:certId/person
    Assigns certification/curriculum to a person
    
    

    Parameter	Value	Type	Location	Description
    certId		string	query	Certification/Curriculum ID
    @type		string	query	Input detail type
    targetDays		string	query	Target days
    source		string	query	Certification/Curriculum assigner
    assignee		string	query	Assignee
    targetDate		string	query	Target Date

  • PUTChange status of held certification/curriculum/learning/heldlearningevent/:held_cert_curr_Id
    Change status of held certification/curriculum.
    
    

    Parameter	Value	Type	Location	Description
    held_cert_curr_Id		string	query	Held Certification/Curriculum ID
    action	cancelrevokechangeTargetDatedelete	enumerated	query	Action to be performed on held certification/curriculum.
    auditAction		string	query	Audit action.
    reassign		string	query	In case of revoke, flag to reassign certification
    target_date		string	query	Target Date

  • POSTGrant certification/curriculum to a learner/learning/heldlearningevent/:cert_curr_Id/person?action=grant
    Grants certification/curriculum to a learner. The status of such granted certification/curriculum will be shown as acquired for that learner. To grant an already assigned certification the suppressWarning flag should be true.
    
    

    Parameter	Value	Type	Location	Description
    cert_curr_Id		string	query	Certification/Curriculum ID
    @type		string	query	Input detail type
    acquiredOn		string	query	Date on which the certification/curriculum was acquired
    expiredOn		string	query	Date on which the certification will expire, only applicable for certification
    assignee		string	query	Assignee
    auditReason		string	query	Audit reason for grant

  • GETGet held Certification/Curriculum details along with all the activities/learning/heldlearningevent/:heldCertId
    Gets held Certification/Curriculum details along with all the activities
    
    

    Parameter	Value	Type	Location	Description
    heldCertId		string	query	Held Certification/Curriculum's ID

  • GETGet held Certification/Curriculum activity details/learning/heldlearningevent/activity/:activityId
    Gets held Certification/Curriculum activity details
    
    

    Parameter	Value	Type	Location	Description
    activityId		string	query	Held Certification/Curriculum activity ID

  • GETSearch Certifications/Curricula of the logged in user or Get all heldCertifications/heldCurriculum incase of an admin/learning/heldlearningevent?type=:type&isAdmin=:isAdmin&count=:count&startPage=:startPage
    If isAdmin is true, Get all heldCertifications/heldCurriculum incase of an admin else Get Certifications/Curricula of logged in user.
    
    

    Parameter	Value	Type	Location	Description
    type	certificationcurriculum	enumerated	query	The desired component i.e. Certification or Curriculum.
    isAdmin		string	query	Get all heldCertifications/heldCurriculum, incase of an admin
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETSearch all the certifications/curricula assigned to a learner based on the status/learning/heldlearningevent?type=:type&q=(:criteria)&count=:count&startPage=:startPage
    Search all the certifications/curricula assigned to a learner based on the status
    
    

    Parameter	Value	Type	Location	Description
    type	certificationcurriculum	enumerated	query	The desired component i.e. Certification or Curriculum.
    criteria		string	query	The search criteria
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • PUTUpdate the target days/date for the assigned certification/curriculum activity/learning/heldlearningevent/activity/:activityId
    Updates the target days/date for the assigned certification/curriculum activity
    
    

    Parameter	Value	Type	Location	Description
    activityId		string	query	Held Certification/Curriculum activity's ID
    @type		string	query	Input detail type
    targetDays		string	query	Target days
    targetDate		string	query	Target Date
    auditReason		string	query	Audit reason for changing target date

  • DELETERemove the certification/curriculum activity of a learner/learning/heldlearningevent/activity/:activityId
    Removes the certification/curriculum activity of a learner
    
    

    Parameter	Value	Type	Location	Description
    activityId		string	query	Held Certification/Curriculum activity's ID

  • GETGet the meta details of the course activity/courseactivity/meta:(:searchFields)
    Returns the meta details of the course activity.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular course activity/courseactivity/:id:(:searchFields)
    Returns complete information about a course activity based on the Course Activity's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Course activity's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet all the course activities of the logged in user/courseactivity?q=(:criteria)&count=:count&startPage=:startPage&startPage=:startPage
    Returns all the course activities of the logged in user
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    criteria		string	query	The search criteria
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the course activities based on criteria/courseactivity?includeDetails=:includeDetails&q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the course activities along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		boolean	query	To include details for courses

  • GETFind the details of the recurring course activities based on criteria/courseactivity?q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the course activities along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTAssign a course or recurring course to a person/courseactivity/
    Assigns a course to a person.
    
    

    Parameter	Value	Type	Location	Description
    source		string	query	Course/Recurring Course assigner
    assignee		string	query	Assignee
    activityDefinition		string	query	Course to assign
    targetDate		string	query	Target Date
    targetDays		string	query	Target days

  • PUTUpdate the details of a course activity/courseactivity/:id
    Allows updating an existing course activity based on the course activity's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Course activity's ID
    targetDate		string	query	Target date
    targetDays		string	query	Target days

  • DELETERemove a course or recurring course from a learner/courseactivity/:id
    Removes a course from a learner based on the course activity's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Course activity's ID

  • GETGet completion detail of the learning event./learning/heldlearningevent/:heldCertId/:pathId/sections:(:searchFields)
    Gets held Certification/Curriculum details along with all the activities
    
    

    Parameter	Value	Type	Location	Description
    heldCertId		string	query	Held Certification/Curriculum's ID
    pathId		string	query	Path Id
    searchFields		string	query	Completion Detail of the learning event.

  • POSTAuto-enroll into courses inside the certification/curriculum/learning/heldlearningevent/autoenroll
    Auto-enrolls into courses inside the certification/curriculum
    
    

    Parameter	Value	Type	Location	Description
    learningEvent		string	query	learning Event Input, lookup supported with displayName of the learning event
    orderContact		string	query	Order Contact, lookup supported with displayName
    learner		string	query	learner to which the learning event would be enrolled and course enrolled, lookup supported with displayName
    targetDate		string	query	Target Date

• Order

  • List Methods
  • Expand Methods

  • GETGet the order details of a particular order/learning/order/:orderId
    Returns the order details of a particular order
    
    

    Parameter	Value	Type	Location	Description
    orderId		string	query	Order's ID

  • GETSearch all orders/learning/order?count=:count&startPage=:startPage
    Returns all orders
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the orders/learning/order?q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the Orders along with the ID and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria [created_on|learner_id|order_no]
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • PUTApprove/Reject an Order Item/learning/enroll/:regId?action=:action
    Approves/Rejects an Order Item
    
    

    Parameter	Value	Type	Location	Description
    regId		string	query	Registration's ID
    action		string	query	The action to be performed. Can be approve or reject

  • PUTCancel Order/learning/order/cancel
    Cancel Order
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Order Id
    order_number		string	query	Order number
    cancelWithCharge		string	query	Cancel order with charge
    reason		string	query	Order cancel reason

  • PUTMark Order Item as Billed/learning/order/billing/:regId
    Mark Order Item as Billed
    
    

    Parameter	Value	Type	Location	Description
    regId		string	query	Registration's ID / OrderItem Id
    billNumber		string	query	Bill Number
    billingDate		string	query	Date of billing
    reason		string	query	Audit Reason

  • GETGet Order Item Billing Details/learning/order/billing/:regId
    Get Order Item Billing Details.
    
    

    Parameter	Value	Type	Location	Description
    regId		string	query	Registration's ID / OrderItem Id

  • PUTApprove/Reject an Order Invoice Payment/learning/order/:orderId/invoicePaymentApproval?action=:action
    Approve/Reject an Order Invoice Payment.
    
    

    Parameter	Value	Type	Location	Description
    orderId		string	query	Order's ID
    action		string	query	The action to be performed. Can be approve or reject

  • PUTApprove/Reject an Order TU Payment/learning/order/:orderId/paymentApproval?action=:action
    Approve/Reject an Order TU Payment.
    
    

    Parameter	Value	Type	Location	Description
    orderId		string	query	Order's ID
    action		string	query	The action to be performed. Can be approve or reject

• Subscription

  • List Methods
  • Expand Methods

  • GETGet the meta details of the subscription/subscription/meta:(:searchFields)
    Returns the meta details of the subscription.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular subscription/subscription/:id:(:searchFields)
    Returns complete information about a subscription based on the subscription's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Subscription's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Subscriptions/subscription?count=:count&startPage=:startPage
    Returns all Subscription for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Subscriptions/subscription?q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the subscription along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. [subscription_no%3D%3D111].
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new subscription/subscription
    Allows creating a new subscription.
    
    

    Parameter	Value	Type	Location	Description
    title		string	query	Title of the subscription
    description		string	query	Description of the subscription
    subscription_no		string	query	Subscription number
    is_featured		string	query	Is Featured Or Not
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    avail_web		string	query	Available on web
    avail_call_center		string	query	Available for call center
    training_units		string	query	Training units
    grace_period		string	query	Grace period
    reg_limit		string	query	Registration limit
    days_limit		string	query	Days limit
    entire_catalog		string	query	Entire catalog
    is_enterprise		string	query	Check for enterprise
    cost_limit		string	query	Cost limit
    before_expiry		string	query	Before expiry
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the subscription
    allCostLimits		string	query	All Cost Limits
    allPrices		string	query	All Prices
    create_group		string	query	Create Group

  • PUTUpdate the details of a subscription/subscription/:id
    Allows updating an existing subscription based on the Subscription's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Subscription's ID
    title		string	query	Title of the subscription
    description		string	query	Description of the subscription
    subscription_no		string	query	Subscription number
    is_featured		string	query	Is Featured Or Not
    avail_from		string	query	Available from
    disc_from		string	query	Discontinued from
    avail_web		string	query	Available on web
    avail_call_center		string	query	Available for call center
    training_units		string	query	Training units
    grace_period		string	query	Grace period
    reg_limit		string	query	Registration limit
    days_limit		string	query	Days limit
    entire_catalog		string	query	Entire catalog
    cost_limit		string	query	Cost limit
    before_expiry		string	query	Before expiry
    customValues		string	query	Custom values
    securityDomain		string	query	The domain for the subscription

  • PUTUpdate locale-specific details of subscription/subscription/:instanceId/locale
    Update locale-specific attributes of subscription.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • POSTFind the details of subscription (Using POST - Range based search)/subscription/searchQuery?count=:count&startPage=:startPage
    Returns the details of the subscription along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description

  • POSTAdd subscription price to a subscription/learning/subscription/:subscriptionId/subscriptionPrice
    Allows to add price to a subscription
    
    

    Parameter	Value	Type	Location	Description
    subscriptionId		string	query	Subscription Id
    @type		string	query	Price type
    price		string	query	Price amount
    currency		string	query	Price currency
    currencySelectionMode		string	query	Currency selection mode

  • POSTAdd cost limit price to a subscription/learning/subscription/:subscriptionId/subscriptionPrice?type=costLimitPrice
    Allows to add limit in cost to a subscription
    
    

    Parameter	Value	Type	Location	Description
    subscriptionId		string	query	Subscription Id
    @type		string	query	Price type
    price		string	query	Cost limit amount
    currency		string	query	Price currency
    currencySelectionMode		string	query	Currency selection mode

  • DELETERemove subscription price / cost limit price from a subscription/learning/subscription/:subscriptionId/subscriptionPrice/:priceListEntryId
    Allows to delete price or limit in cost from a subscription
    
    

    Parameter	Value	Type	Location	Description
    subscriptionId		string	query	Subscription Id
    priceListEntryId		string	query	PriceList Entry Id

• Subscription Order

  • List Methods
  • Expand Methods

  • GETGet the order details of a particular subscription order/learning/subscriptionorder/:orderId
    Returns the order details of a particular subscription order
    
    

    Parameter	Value	Type	Location	Description
    orderId		string	query	Subscription Order's ID

  • GETSearch all subscription orders/learning/subscriptionorder?count=:count&startPage=:startPage
    Returns all subscription orders
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the subscription orders/learning/subscriptionorder?q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the Subscription Orders along with the ID and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETSearch subscription order - All (OrderHistory Flow)/learning/order?type=subscriptionOrder&count=:count&startPage=:startPage
    Returns all Subscription orders for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETSearch subscription order - with search criteria (OrderHistory Flow)/learning/order?type=subscriptionOrder&q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the subscription orders along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. [subscription_no%3D%3D111].
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a subscription order/learning/subscriptionorder
    Creates a subscription order
    
    

    Parameter	Value	Type	Location	Description
    paymentRequests		string	query	Payment Requests
    cartRequest		string	query	Cart Request
    @type		string	query	Input JSON class name

  • POSTChange learner of a particular subscription order/learning/subscriptionorder/learningsubscription/:learningSubscriptionId/assignee
    Changes the learner of a particular learning subscription.
    
    

    Parameter	Value	Type	Location	Description
    learningSubscriptionId		string	query	Learning Subscription's ID
    @type		string	query	Input JSON class name
    id		string	query	Learner's ID
    displayName		string	query	Name of the learner

  • GETGet the detail of a particular learning subscription/learning/subscriptionorder/learningsubscription/:learningSubscriptionId
    Returns the complete details of a particular learning subscription.
    
    

    Parameter	Value	Type	Location	Description
    learningSubscriptionId		string	query	Learning subscription's ID

• Category

  • List Methods
  • Expand Methods

  • POSTCreate Category/learning/category/
    Creates a new Category
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	Category DTO
    name		string	query	Category Name
    language		string	query	Category Language
    owner		string	query	Category Owner
    parentCategory		string	query	Category Parent
    roles		List	query	Category Roles
    description		string	query	Category Description
    split		string	query	Category Domain
    recommendable		String	query	Is Category Recommendable
    featured		String	query	Is Category Featured
    forExternal		String	query	Is Category For External Person
    atList		string	query	Audience Types associated with Category

  • GETGet All Categories/learning/category
    Returns All First Level Categories
    
    
  • GETGet Category Details/learning/category/:categoryId
    Returns All First Level Categories
    
    

    Parameter	Value	Type	Location	Description
    categoryId		String	query	Category Id

  • GETGet Category Detail from name/learning/category/name=:categoryName
    Returns All First Level Categories
    
    

    Parameter	Value	Type	Location	Description
    categoryName		String	query	Category Name

  • DELETEDelete a Category/learning/category/:id
    Deletes the specified Category
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Category ID
    cascade		string	query	Cascade Delete

  • DELETEDelete a Category from name/learning/category/name=:name
    Deletes the specified Category
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Category Name
    cascade		string	query	Cascade Delete

  • GETSearch the details of the category/learning/category?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the category along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • PUTUpdate Category/learning/category
    Updates a Category
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	Category DTO
    id		string	query	Category ID
    name		string	query	Category Name
    language		string	query	Category Language
    owner		string	query	Category Owner
    parentCategory		string	query	Category Parent
    roles		List	query	Category Roles
    description		string	query	Category Description
    split		string	query	Category Domain
    recommendable		string	query	Is Category Recommendable
    featured		string	query	Is Category Featured
    forExternal		string	query	Is Category For External Person
    atList		string	query	Audience Types associated with Category

• Field Of Study

  • List Methods
  • Expand Methods

  • GETGet the meta details of Field Of Study/fieldofstudy/meta:(:searchFields)
    Returns the meta details of the Field Of Study.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular field of study/fieldofstudy/:id:(:searchFields)
    Returns complete information about a field of study based on the field of study's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Field Of Study's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Fields of Study/fieldofstudy?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns all Fields of Study for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	If true then returns the complete details of Field Of Study

  • GETFind the details of the Fields Of Study/fieldofstudy?q=(:criteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the fields of study along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	If true then returns the complete details of Field Of Study

  • POSTFind the details of Field Of Study (Using POST - Range based search)/fieldofstudy/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the field of study along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	If true then returns the complete details of Field Of Study

• Session Template

  • List Methods
  • Expand Methods

  • GETGet the meta details of SessionTemplate/sessiontemplate/meta:(:searchFields)
    Returns the meta details of the SessionTemplate.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a SessionTemplate/sessiontemplate/:id:(:searchFields)
    Returns complete information about a Session Template based on the Session Template's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Session Template Id
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Session Templates/sessiontemplate?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns all Session Templates for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the Session Templates in the search

  • GETFind the details of the Session Templates/sessiontemplate?q=(:criteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Session Templates along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the Session Templates in the search

  • POSTFind the details of Session Template (Using POST - Range based search)/sessiontemplate/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Session Template along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the Session Templates in the search

  • POSTCreate a new Session Template/sessiontemplate
    Creates a new session template
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the Session Template
    sessionType		string	query	Session Type (Weekly/Adhoc)
    noOfWeeks		string	query	Total number of weeks (in case of Weekly Sessions)
    templateInfo		string	query	Time Period Template

  • PUTUpdate the details of a Session Template/sessiontemplate/:sessionTemplateId
    Update a Session Template
    
    

    Parameter	Value	Type	Location	Description
    sessionTemplateId		string	query	SessionTemplate's ID
    name		string	query	Name of the Session Template
    templateInfo		string	query	Time Period Template

  • DELETEDelete a SessionTemplate/sessiontemplate/:id
    Deletes a Session Template.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Session Template's ID

• Task Definition

  • List Methods
  • Expand Methods

  • GETGet the meta details of tasks/taskdefinition/meta:(:searchFields)
    Returns meta details of the tasks.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet all task/taskdefinition?count=:count&startPage=:startPage
    Returns all the details of tasks
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Tasks/taskdefinition?q=(:criteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the tasks based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the tasks in the search

  • POSTFind the details of Tasks (Using POST based search)/taskdefinition/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the tasks based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the Tasks in the search

  • GETGet details of task/taskdefinition/:taskId
    Returns the details of tasks
    
    

    Parameter	Value	Type	Location	Description
    taskId		string	query	Task id need to be passed

  • POSTCreate task/taskdefinition
    create the details of tasks
    
    

    Parameter	Value	Type	Location	Description
    securityDomain		string	query	Domain
    customValues		string	query	Custom Values
    name		string	query	name
    type		string	query	type
    description		string	query	description
    disc_from		string	query	disc_from
    avail_from		string	query	avail_from
    objectives		string	query	objectives
    launch_url		string	query	launch_url
    task_no		string	query	task_no
    task_references		string	query	task_references
    id		string	query	id
    taskevaluator		string	query	taskevaluator

  • PUTUpdate task/taskdefinition/:taskId
    update the details of tasks
    
    

    Parameter	Value	Type	Location	Description
    taskId		string	query	Task id need to be passed
    securityDomain		string	query	Domain
    customValues		string	query	Custom Values
    name		string	query	name
    type		number	query	type
    description		string	query	description
    disc_from		string	query	disc_from
    avail_from		string	query	avail_from
    objectives		string	query	objectives
    launch_url		string	query	launch_url
    task_no		string	query	task_no
    task_references		string	query	task_references
    id		string	query	id
    taskevaluator		string	query	taskevaluator

  • DELETEDelete task/taskdefinition/:taskId
    Deletes a task
    
    

    Parameter	Value	Type	Location	Description
    taskId		string	query	task id need to be passed

• Calendar

  • List Methods
  • Expand Methods

  • POSTFind the calendar events/calendar/search
    Returns the details of the calendar events based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    @type		String	query	type
    type		String	query	ILTCLASS,BLENDEDOFFERING,VIRTUALCLASS,SABAMEETING,COURSE,CERTIFICATION,CURRICULUM,RECURRINGCOURSE,APPOINTMENT,ALL
    context		String	query	Context
    startDate		String	query	startDate
    endDate		String	query	endDate
    ownerID		String	query	Person who is associated with the event
    title		string	query	Title
    location		string	query	Location

  • GETGet the details of a particular Appointment/calendar/appointment/:id
    Returns complete information about a Appointment based on the Appointments ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Appointment's ID

  • POSTCreate a new Appointment/calendar/appointment?failOnConflict=:failOnConflict
    Allows creating a new Appointment.
    
    

    Parameter	Value	Type	Location	Description
    failOnConflict		string	query	Flag to specify if Appointment needs conflict check
    @type		string	query	type appointment detail
    subject		string	query	Appointment subject
    startDate		string	query	Start Date of Appointment
    startTime		string	query	Start timings of Appointment in HH:mm format
    endDate		string	query	End Date of Appointment
    endTime		string	query	End timings of Appointment in HH:mm format
    timeZone		string	query	Timezone's ID
    owner		string	query	Owner
    note		string	query	Note to be added on Appointment

  • PUTUpdate existing Appointment/calendar/appointment/:id?failOnConflict=:failOnConflict
    Allows updating Appointment.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Appointment's ID
    failOnConflict		string	query	Flag to specify if Appointment needs conflict check
    @type		string	query	type list appointment detail
    subject		string	query	Appointment subject
    startDate		string	query	Start Date of Appointment
    startTime		string	query	Start timings of Appointment in HH:mm format
    endDate		string	query	End Date of Appointment
    endTime		string	query	End timings of Appointment in HH:mm format
    timeZone		string	query	Timezone's ID
    note		string	query	Note to be added on Appointment

  • DELETEDelete an Appointment/calendar/appointment/:id
    Deletes an Appointment
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Appointment's ID

• Recurring Course

  • List Methods
  • Expand Methods

  • GETGet all recurring completions./recurringcompletions?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns all recurring completions of a logged in person.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the recurring completions in the search

  • GETSearch recurring completions./recurringcompletions?q=(:searchCriteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of recurring completions based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    searchCriteria		string	query	The search criteria i.e. the person Id.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the recurring completions in the search

  • POSTFind the details of recurring completions (Using POST - Range based search)/recurringcompletions/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the recurring completions based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the recurring completions in the search

  • DELETEDelete completely recurring course./recurringcompletions/removeCompletely?courseId=:courseId&learnerId=:learnerId&auditReason=:auditReason
    Delete completely recurring course from learner profile
    
    

    Parameter	Value	Type	Location	Description
    courseId		string	query	Id of Course
    learnerId		string	query	Learner Id
    auditReason		string	query	Audit Reason for delete completely action.

  • GETSearch progress history of recurring completions./recurringcompletions/progresshistory?q=(:searchCriteria)&count=:count&startPage=:startPage
    Returns the details of recurring completion progress history based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    searchCriteria		string	query	The search criteria i.e. the person Id.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the progress history of recurring completions (Using POST - Range based search)/recurringcompletions/progresshistory/searchQuery?count=:count&startPage=:startPage
    Returns the details of the recurring completions progress history based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description

• Checklist

  • List Methods
  • Expand Methods

  • GETGet the meta details of Checklist/checklist/meta:(:searchFields)
    Returns the meta details of the Checklist.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned

  • GETGet the details of a particular Checklist/checklist/:id:(:searchFields)
    Returns complete information about a Checklist based on the Checklist's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Checklist's ID

  • GETGet All Checklist/checklist?count=:count&startPage=:startPage
    Returns all Held Checklist for catalog admin.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Checklist/checklist?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Checklist along with the ID and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Checklist (Using POST - Range based search)/checklist/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Checklist.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the Checklist in the search

• Held Checklist

  • List Methods
  • Expand Methods

  • GETGet the meta details of Held Checklist/heldchecklist/meta:(:searchFields)
    Returns the meta details of the Held Checklist.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned

  • GETGet the details of a particular Held Checklist/heldchecklist/:id:(:searchFields)
    Returns complete information about a Held Checklist based on the Held Checklist's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Held Checklist's ID

  • GETGet All Held Checklist of logged in user/heldchecklist?count=:count&startPage=:startPage
    Returns all Held Checklist for which the user is assignee.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Held Checklist/heldchecklist?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Held Checklist along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Held Checklist (Using POST - Range based search)/heldchecklist/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Held Checklist.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the Held Checklist in the search

• Package

  • List Methods
  • Expand Methods

  • GETGet the details of a particular package/package/:id:(:searchFields)
    Returns complete information about a package based on the package's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Package's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Packages/package?count=:count&startPage=:startPage
    Returns all Packages for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Packages/package?q=(:criteria)&count=:count&startPage=:startPage
    Returns the details of the Packages along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field available_from with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Package/package
    Creates a new Package
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Package name
    package_no		string	query	Package Number
    securityDomain		string	query	Domain
    description		string	query	Package description
    administrator_id		string	query	Package Adminstrator
    currency		string	query	Package Currency
    available_from		string	query	Package stat date
    discontinued_from		string	query	Package end date
    featured		string	query	defines whether package is feature package or not
    displayfor_callcenter		string	query	Display for Call Center
    displayfor_web		string	query	Display for Web
    pricingType		number	query	Package Pricing Type
    multicurrency_pref		number	query	Multicurrency Preference
    price		string	query	Package Price
    items		string	query	Package Items
    owners		string	query	List of Owners
    customValues		string	query	Custom Values
    audienceType		string	query	Audience Type
    packageKeywords		string	query	Package Keywords
    dropPolicyInfo		string	query	Drop Policy
    category		string	query	Category

  • PUTUpdate the details of a Package/package/:packageid
    Update a Package
    
    

    Parameter	Value	Type	Location	Description
    packageid		string	query	Package's ID
    name		string	query	Package name
    package_no		string	query	Package Number
    securityDomain		string	query	Domain
    description		string	query	Package description
    administrator_id		string	query	Package Adminstrator
    available_from		string	query	Package stat date
    discontinued_from		string	query	Package end date
    featured		string	query	defines whether package is feature package or not
    displayfor_callcenter		string	query	Display for Call Center
    displayfor_web		string	query	Display for Web
    pricingType		string	query	Package Pricing Type
    multicurrency_pref		string	query	Multicurrency Preference
    allPrice		string	query	Package Price
    items		string	query	Package Items
    owners		string	query	List of Owners
    customValues		string	query	Custom Values
    audienceType		string	query	Audience Type
    packageKeywords		string	query	Package Keywords
    dropPolicyInfo		string	query	Drop Policy
    category		string	query	Category

  • DELETEDelete Package/package/:packageid
    Delete perticular package
    
    

    Parameter	Value	Type	Location	Description
    packageid		string	query	Package Id

• Image Upload

  • List Methods
  • Expand Methods

  • GETGet Image URL of object/imageupload/:objectType/:objectId?version=:version
    Returns image URL of object
    
    

    Parameter	Value	Type	Location	Description
    objectType		string	query	Object Type
    objectId		string	query	Object Id
    version		string	query	Version

• Package Order

  • List Methods
  • Expand Methods

  • POSTCreate Package Order/learning/enroll/package
    Create Package Order
    
    

    Parameter	Value	Type	Location	Description
    currency		string	query	Currency
    sabaPackage		string	query	Saba Package
    taxExempt		string	query	Tax Excempt
    cartItems		string	query	Cart Items
    paymentRequests		string	query	Payment Requests