Sign in
Periods

Close a period

patch/api/periods/{id}/close

Path parameters

idstring required

Response

Period

_idstring required
namestring required
status'OPEN' | 'QUANTIFY' | 'CLOSED' required
startDatestring date-time required
endDatestring date-time required
attestationsTxHashstring
createdAtstring date-time required
updatedAtstring date-time required
numberOfPraisenumber required

Example response

{
  "_id": "621f802b813dbdba9eeaf7d7",
  "name": "June 2021",
  "attestationsTxHash": "0x46164b8581258eec4b4f44d626925953d0d7581514d9fd1335e3bd660d48e07c",
  "quantifiers": [
    {
      "_id": "5f9f1b9b9b9b9b9b9b9b9b9b",
      "identityEthAddress": "0xAAB27b150451726EC7738aa1d0A94505c8729bd1",
      "username": "darth",
      "finishedCount": 1,
      "praiseCount": 1,
      "quantifications": [
        {
          "_id": "639b178f19296ee0f2d0585d",
          "score": 144,
          "scoreRealized": 144,
          "dismissed": true,
          "duplicatePraise": "639b178f19296ee0f2d0585d",
          "quantifier": "639b178f19296ee0f2d0585d",
          "praise": "639b178f19296ee0f2d0585d",
          "createdAt": "2021-06-01T00:00:00.000Z",
          "updatedAt": "2021-06-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "givers": [
    {
      "_id": "63b428f7d9ca4f6ff5370d05",
      "accountId": "098098098098098",
      "name": "darth#6755",
      "avatarId": "098098098087097",
      "platform": "DISCORD",
      "user": "621f802b813dbdba9eeaf7d7",
      "score": 144
    }
  ],
  "receivers": [
    {
      "_id": "63b428f7d9ca4f6ff5370d05",
      "accountId": "098098098098098",
      "name": "darth#6755",
      "avatarId": "098098098087097",
      "platform": "DISCORD",
      "user": "621f802b813dbdba9eeaf7d7",
      "score": 144
    }
  ],
  "numberOfPraise": 543
}

Changes

Changed in 16 of the 50 revisions of this API.1418

  • 89707aed2e4e1See the full diff
    • ▲

      the response property attestationsTxHash became optional for the status 200

      response-property-became-optional

  • 990e717b779e1See the full diff
    • ○

      endpoint added

      endpoint-added

  • abdaebb919d21See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 56 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bc9e361c5d5d2See the full diff
    • ▲

      the givers/items/name response property's minLength was decreased from 4 to 2 for the response status 200

      response-property-min-length-decreased

    • ▲

      the receivers/items/name response property's minLength was decreased from 4 to 2 for the response status 200

      response-property-min-length-decreased

  • 00d037b830a52See the full diff
    • ▲

      removed the required property attestationsTxHash from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property startDate from the response with the 200 status

      response-required-property-removed

  • a1650a3ffd3f1See the full diff
    • ○

      added the required property startDate to the response with the 200 status

      response-required-property-added

  • 0373dfbf63cd1See the full diff
    • ○

      added the required property attestationsTxHash to the response with the 200 status

      response-required-property-added

  • 78c48cd671842See the full diff
    • ▲

      the givers/items/name response property's maxLength was increased from 20 to 32 for the response status 200

      response-property-max-length-increased

    • ▲

      the receivers/items/name response property's maxLength was increased from 20 to 32 for the response status 200

      response-property-max-length-increased

  • e14b4c818c531See the full diff
    • ○

      endpoint added

      endpoint-added

  • e8ffc3233d9e1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 52 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog