Get 1st ended info

In order to get the ended (instead of the current) status of the production line of the 1st tokens part, the identifier of the tokens object MUST be sent as the first HTTP request path parameter together with ended as the second HTTP request path parameter.

If the JSON response body contains the path data attributes status: ended together with other attribute–value pairs, the production of the 1st tokens part has been finished. In this case, the tokens data are linked in it and available for download. The snapshot of the production line is not available for download at this point.

Request endpoint

GET SERVER:PORT/api/tokens/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/ended

Response status

Request headers

Accept:application/vnd.api+json
Content-Type:application/vnd.api+json
Session-Key:SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS

Response headers

Transfer-Encoding:chunked
Connection:keep-alive
Accept:application/vnd.api+json
Cache-Control:no-cache
Date:Tue, 19 Mar 2024 12:57:32 GMT
Content-Type:application/vnd.api+json
Server:nginx/1.25.4

Request body

# intentionally blank

Response body

{
    "meta": {
        "seed": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "links": {
        "self": "/api/tokens",
        "data": "/api/tokens/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/data",
        "info": "/api/tokens/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "data": {
        "attributes": {
            "analysis": "none",
            "rate": 15038,
            "reachable": "10485",
            "alphabet": "UPPER_VOWELS",
            "available": "7888609052210118054117285652827862296732064351090230047702789306639625",
            "partial": true,
            "checksum": "1010001100111110000111001001101010110001011010011100000110101011000011100000110011011001001101011110010011001101101000110111011010111101000110010011011111101111110011011000111101111110110111001011101100110011111011111101111110111011011011101011110010111010111101000110011011000001100111110010111011001101111110011011000101100000110000111001111101100110011011010011100101110001111000001100110110010011011011100101110100011001101101010110100111001101100011110101011001101100111110001111011001101011110100011010001101101110000111010111100101110001011010111101111110001111000001101111110111111000111100100110111011001111100101110000111000011100111110010011011101100010110101011011101100101110000111010001",
            "status": "ended",
            "progress": 100,
            "filesizes": {
                "data": 100999
            },
            "digits": "100",
            "filehashes": {
                "data": "8b5e65c60e2a4a263eec8b56f58ff04c70236831d9d1f1d8311715ddb072d361"
            },
            "size": "1000",
            "timestamps": {
                "ended": "2024-03-19T12:57:27.839Z",
                "started": "2024-03-19T12:57:21.181Z",
                "requested": "2024-03-19T12:57:19.785Z"
            }
        },
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "type": "tokens",
        "relationships": {
            "payment": {
                "data": {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "ident": "pi_XXXXXXXXXXXXXXXXXXXXXXXX",
                    "type": "transaction"
                }
            }
        }
    }
}

HTTPie example

$ http get SERVER:PORT/api/tokens/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/ended Accept:application/vnd.api+json Content-Type:application/vnd.api+json Session-Key:SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS