Create SynopticSession

POST

/synoptic-sessions

Request

Body Params application/vnd.api+jsonRequired

Example

{
    "data": {
        "type": "SynopticSession",
        "attributes": {},
        "relationships": {
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/synoptic-sessions' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "SynopticSession",
        "attributes": {},
        "relationships": {
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}'

Responses

🟢201

application/vnd.api+json

Created

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "SynopticSession",
        "attributes": {
            "id": "string",
            "token": "string"
        },
        "relationships": {
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

🟢202

🟠400

🟠401

🟠403

🟠404

🟠409

Modified at 2026-03-24 08:18:55

Get SynopticSession

Find SynopticSession