Create MarkingEntry

POST

/marking-entries

Marking

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

MarkingEntry

Example:

MarkingEntry

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "type": "MarkingEntry",
        "attributes": {
            "rubricMarks": {},
            "credits": 0,
            "penalties": 0,
            "status": "pending",
            "escalationReason": {
                "slug": "string",
                "label": "string",
                "description": "string",
                "comment": "string"
            },
            "escalationResponse": "string",
            "candidateFeedback": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "portal": {
                "data": {
                    "id": "FID001",
                    "type": "Portal"
                }
            },
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "response": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerAudioResponse"
                }
            },
            "question": {
                "data": {
                    "id": "FID001",
                    "type": "QuizQuestion"
                }
            },
            "markingSession": {
                "data": {
                    "id": "FID001",
                    "type": "MarkingSession"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/marking-entries' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "MarkingEntry",
        "attributes": {
            "rubricMarks": {},
            "credits": 0,
            "penalties": 0,
            "status": "pending",
            "escalationReason": {
                "slug": "string",
                "label": "string",
                "description": "string",
                "comment": "string"
            },
            "escalationResponse": "string",
            "candidateFeedback": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "portal": {
                "data": {
                    "id": "FID001",
                    "type": "Portal"
                }
            },
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "response": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerAudioResponse"
                }
            },
            "question": {
                "data": {
                    "id": "FID001",
                    "type": "QuizQuestion"
                }
            },
            "markingSession": {
                "data": {
                    "id": "FID001",
                    "type": "MarkingSession"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (MarkingEntry)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MarkingEntry

Example:

MarkingEntry

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "MarkingEntry",
        "attributes": {
            "rubricAreas": [
                {}
            ],
            "rubricMarks": {},
            "maxPoints": 0,
            "points": 0,
            "credits": 0,
            "penalties": 0,
            "role": "provisional",
            "status": "pending",
            "escalationReason": {
                "slug": "string",
                "label": "string",
                "description": "string",
                "comment": "string"
            },
            "escalationResponse": "string",
            "disabled": true,
            "conflict": true,
            "timeMarked": "string",
            "final": true,
            "candidateFeedback": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "portal": {
                "data": {
                    "id": "FID001",
                    "type": "Portal"
                }
            },
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "response": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerAudioResponse"
                }
            },
            "question": {
                "data": {
                    "id": "FID001",
                    "type": "QuizQuestion"
                }
            },
            "markingSession": {
                "data": {
                    "id": "FID001",
                    "type": "MarkingSession"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

Modified at 2025-07-08 10:51:22

Update Survey Pages

List MarkingEntries