Create CollectionProgress

POST

/collection-progresses

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

CollectionProgress

Example:

CollectionProgress

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "type": "CollectionProgress",
        "attributes": {},
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/collection-progresses' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "CollectionProgress",
        "attributes": {},
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (CollectionProgress)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CollectionProgress

Example:

CollectionProgress

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "CollectionProgress",
        "attributes": {
            "percentageSeen": 0,
            "tally": {
                "unseen": 0,
                "seen": 0,
                "updated": 0,
                "new": 0
            },
            "progress": [
                {
                    "collectionItemId": "string",
                    "targetId": "string",
                    "targetType": "test",
                    "status": "string",
                    "lastSeen": "string",
                    "firstSeen": "string",
                    "timesSeen": 0
                }
            ]
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

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

List CollectionMocks

List CollectionProgresses