Create/Update case study

Method

Method Description
exam.caseStudyCreate Create case study
exam.caseStudyUpdate Update case study

Request parameters

{
    "case_study": {
        "id": {CaseStudyId}, /* Only for update operation */
        "test_id": {TestId},
        "name": "{Name}",
        "description": "{Description}",
        "external_id": "{ExternalId}"
    },
    "resources": {
        "{ResourcePath}": "{ResourceCnt}",
        ...
    }
}

Response parameters

{
    "case_study": {
        "id": {CaseStudyId},
        "test_id": {TestId},
        "name": "{Name}",
        "description": "{Description}",
        "external_id": "{ExternalId}"
    },
    "resources": {
        "{ResourcePath}": "{NewResourcePath}",
        ...
    },
    "completed": {Comleted}
}

Variable Type Appearance Description
{CaseStudyId} Integer Mandatory Case study id. Mandatory for update operation.
{TestId} Integer Mandatory Exam id.
{Name} String Mandatory Case study name.
{Description} String Mandatory Case study content. HTML formatted, may contain media resources like images and audio. Please be aware that only relative URLs are allowed.
{ExternalId} String Optional External Id. Optional field to store external system case study id, which later can be used for matching/synchronization.
resources Object Optional If you are using media resources like images you need to send the content of each media resource under "resources" node.
{ResourcePath} String Mandatory Path of media resource. Same value as it was used in Description.
Example: "fld/image.jpg" for <img src="fld/image.jpg">.
{ResourceCnt} String Mandatory Base64 encoded content of media resource.
{NewResourcePath} String Mandatory New media resource path.
{Completed} Boolean Mandatory Indicates whether action was successfully completed or not.