Update Assignment - Synap API (Beta)

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (Assignment)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Assignment

Example:

Assignment

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Assignment",
        "attributes": {
            "name": "string",
            "description": "string",
            "shortDescription": "string",
            "status": "Not started"
        },
        "relationships": {}
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (Assignment)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Assignment

Example:

Assignment

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Assignment",
        "attributes": {
            "createdAt": "string",
            "name": "string",
            "description": "string",
            "shortDescription": "string",
            "image": {
                "url": "string"
            },
            "deadline": "string",
            "status": "Not started",
            "progress": 0,
            "startDate": "string",
            "endDate": "string",
            "setDate": "string",
            "timeSpentInMinutes": 0,
            "totalItems": 0,
            "itemsCompleted": 0,
            "attemptNumber": 0
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "course": {
                "data": {
                    "id": "FID001",
                    "type": "Course"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "AssignmentItemAudio"
                    }
                ]
            },
            "folders": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "AssignmentFolder"
                    }
                ]
            },
            "certificate": {
                "data": {
                    "id": "FID001",
                    "type": "Certificate"
                }
            },
            "certificateFile": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found