{
  "opencollection": "1.0.0",
  "info": {
    "name": "NextGen Catalog Accounts Contributions API",
    "version": "0.2.0"
  },
  "items": [
    {
      "info": {
        "name": "Contributions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get contribution data directly from the database.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/",
            "params": [
              {
                "name": "userId",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "query",
                "description": "Contributor's unique identifier which maps to the record.contributor.userId field"
              },
              {
                "name": "status",
                "value": "active",
                "type": "query",
                "description": "Contribution's status which maps to the status field in the MySQL database"
              },
              {
                "name": "contributionType",
                "value": "tag",
                "type": "query",
                "description": "Contribution type which maps to the contributionType field in the MySQL database"
              },
              {
                "name": "targetNaId",
                "value": "1667758",
                "type": "query",
                "description": "Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database"
              },
              {
                "name": "createdAt",
                "value": "2020-01-01 07:00:00",
                "type": "query",
                "description": "Contribution's date of creation by which to filter"
              },
              {
                "name": "updatedAt",
                "value": "2020-01-02 07:00:00",
                "type": "query",
                "description": "Contribution's date of modification by which to filter"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort order:\n * `contribution.asc` - Sort by contribution, ascending from A to Z\n * `contribution.desc` - Sort by contribution, descending from Z to A\n * `createdAt.asc` - Sort by created date, ascending\n * `createdAt.desc` - Sort by created date, descending\n * `updatedAt.asc` - Sort by updated date, ascending\n * `updatedAt.desc` - Sort by updated date, descending\n * `count.asc` - Sort by aggregated tag counts, ascending, ONLY works when contributionType = tag is present\n * `count.desc` - Sort by aggregated tag counts, descending, ONLY works when contributionType = tag is present\n"
              },
              {
                "name": "includeTotalCount",
                "value": "true",
                "type": "query",
                "description": "Returns the total count of results in each result."
              }
            ]
          },
          "docs": "Get contribution data directly from the database. Returns a JSON result."
        },
        {
          "info": {
            "name": "Update a contribution.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://catalog.archives.gov/api/v2/contributions/",
            "params": [
              {
                "name": "review",
                "value": "true",
                "type": "query",
                "description": "review flag which when true indicates that a contribution should be reviewed"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a contribution to a record."
        },
        {
          "info": {
            "name": "Get search results for contributions data by sending a request with search parameters to the catalog.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/search",
            "params": [
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (\"\")."
              },
              {
                "name": "id",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "query",
                "description": "An individual contribution's unique identifier which maps to the record.contributionId field"
              },
              {
                "name": "userName",
                "value": "johndoe1",
                "type": "query",
                "description": "Contributor's screen name which maps to the record.contributor.userName field"
              },
              {
                "name": "userId",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "query",
                "description": "Contributor's unique identifier which maps to the record.contributor.userId field"
              },
              {
                "name": "naId",
                "value": "146919092, 146919093",
                "type": "query",
                "description": "An array of NARA-specific identifiers, each of which is unique to a single record."
              },
              {
                "name": "debug",
                "value": "true",
                "type": "query",
                "description": "Turns on debug mode, showing metadata in the response body, if set to true."
              },
              {
                "name": "searchAfter",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "query",
                "description": "Enables deep pagination to retrieve records beyond the first 10,000 results.  Not compatible with sort, or page parameters.\n\nFor the inital request use `searchAfter=*` and for all subsequent requests set `searchAfter` to the value of the sort array in the last member of `body.hits.hits` for each page.\n"
              }
            ]
          },
          "docs": "Get search results for contributions data by sending a request with search parameters to the catalog. Returns a JSON result."
        },
        {
          "info": {
            "name": "Get contribution data by target object id directly from the database.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/targetObjectId/:targetObjectId",
            "params": [
              {
                "name": "targetObjectId",
                "value": "45710028",
                "type": "path",
                "description": "Contribution's target objects's unique identifier which maps to the targetObjectId field in the MySQL database"
              },
              {
                "name": "status",
                "value": "active",
                "type": "query",
                "description": "Contribution's status which maps to the status field in the MySQL database"
              },
              {
                "name": "contributionType",
                "value": "tag",
                "type": "query",
                "description": "Contribution type which maps to the contributionType field in the MySQL database"
              },
              {
                "name": "targetPageNum",
                "value": "1",
                "type": "query",
                "description": "Contribution's target page number which maps to the targetPageNum field in the MySQL database"
              }
            ]
          },
          "docs": "Get contribution data by target object id directly from the database. Returns a JSON result."
        },
        {
          "info": {
            "name": "Get contribution data by parent contribution id directly from the database.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/parentContributionId/:parentContributionId",
            "params": [
              {
                "name": "parentContributionId",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "path",
                "description": "A contribution's parent contribution's unique uuid identifier, which maps to the parentContributorId field in the MySQL database"
              },
              {
                "name": "status",
                "value": "active",
                "type": "query",
                "description": "Contribution's status which maps to the status field in the MySQL database"
              },
              {
                "name": "contributionType",
                "value": "tag",
                "type": "query",
                "description": "Contribution type which maps to the contributionType field in the MySQL database"
              },
              {
                "name": "targetNaId",
                "value": "1667758",
                "type": "query",
                "description": "Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database"
              },
              {
                "name": "createdAt",
                "value": "2020-01-01 07:00:00",
                "type": "query",
                "description": "Contribution's date of creation by which to filter"
              },
              {
                "name": "updatedAt",
                "value": "2020-01-02 07:00:00",
                "type": "query",
                "description": "Contribution's date of modification by which to filter"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort order:\n * `contribution.asc` - Sort by contribution, ascending from A to Z\n * `contribution.desc` - Sort by contribution, descending from Z to A\n * `createdAt.asc` - Sort by created date, ascending\n * `createdAt.desc` - Sort by created date, descending\n * `updatedAt.asc` - Sort by updated date, ascending\n * `updatedAt.desc` - Sort by updated date, descending\n * `count.asc` - Sort by aggregated tag counts, ascending, ONLY works when contributionType = tag is present\n * `count.desc` - Sort by aggregated tag counts, descending, ONLY works when contributionType = tag is present\n"
              }
            ]
          },
          "docs": "Get contribution data by parent contribution id directly from the database. Returns a JSON result."
        },
        {
          "info": {
            "name": "Get contribution data by contribution id directly from the database.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/contributionId/:contributionId",
            "params": [
              {
                "name": "contributionId",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "path",
                "description": "An individual contribution's unique uuid identifier which maps to the contributorId field in the MySQL database"
              },
              {
                "name": "status",
                "value": "active",
                "type": "query",
                "description": "Contribution's status which maps to the status field in the MySQL database"
              },
              {
                "name": "contributionType",
                "value": "tag",
                "type": "query",
                "description": "Contribution type which maps to the contributionType field in the MySQL database"
              }
            ]
          },
          "docs": "Get contribution data by contribution id directly from the database. Returns a JSON result."
        },
        {
          "info": {
            "name": "Get contribution data by user id directly from the database.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/userId/:userId",
            "params": [
              {
                "name": "userId",
                "value": "55555555-5555-5555-5555-555555555555",
                "type": "query",
                "description": "Contributor's unique identifier which maps to the userId field in the MySQL database"
              },
              {
                "name": "status",
                "value": "active",
                "type": "query",
                "description": "Contribution's status which maps to the status field in the MySQL database"
              },
              {
                "name": "contributionType",
                "value": "tag",
                "type": "query",
                "description": "Contribution type which maps to the contributionType field in the MySQL database"
              },
              {
                "name": "updatedAt",
                "value": "tag",
                "type": "query",
                "description": "Compares provided timestamp to records updated timestamp, which maps to the updatedAt field in the MySQL database"
              },
              {
                "name": "targetNaId",
                "value": "1667758",
                "type": "query",
                "description": "Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database"
              },
              {
                "name": "createdAt",
                "value": "2020-01-01 07:00:00",
                "type": "query",
                "description": "Contribution's date of creation by which to filter"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort order:\n * `contribution.asc` - Sort by contribution, ascending from A to Z\n * `contribution.desc` - Sort by contribution, descending from Z to A\n * `createdAt.asc` - Sort by created date, ascending\n * `createdAt.desc` - Sort by created date, descending\n * `updatedAt.asc` - Sort by updated date, ascending\n * `updatedAt.desc` - Sort by updated date, descending\n * `count.asc` - Sort by aggregated tag counts, ascending, ONLY works when contributionType = tag is present\n * `count.desc` - Sort by aggregated tag counts, descending, ONLY works when contributionType = tag is present\n"
              }
            ]
          },
          "docs": "Get contribution data by user id directly from the database. Returns a JSON result."
        },
        {
          "info": {
            "name": "Get contribution data by target naId directly from the database.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://catalog.archives.gov/api/v2/contributions/targetNaId/:targetNaId",
            "params": [
              {
                "name": "targetNaId",
                "value": "1667758",
                "type": "path",
                "description": "Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database"
              },
              {
                "name": "status",
                "value": "active",
                "type": "query",
                "description": "Contribution's status which maps to the status field in the MySQL database"
              },
              {
                "name": "contributionType",
                "value": "tag",
                "type": "query",
                "description": "Contribution type which maps to the contributionType field in the MySQL database"
              },
              {
                "name": "createdAt",
                "value": "2020-01-01 07:00:00",
                "type": "query",
                "description": "Contribution's date of creation by which to filter"
              },
              {
                "name": "updatedAt",
                "value": "2020-01-02 07:00:00",
                "type": "query",
                "description": "Contribution's date of modification by which to filter"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort order:\n * `contribution.asc` - Sort by contribution, ascending from A to Z\n * `contribution.desc` - Sort by contribution, descending from Z to A\n * `createdAt.asc` - Sort by created date, ascending\n * `createdAt.desc` - Sort by created date, descending\n * `updatedAt.asc` - Sort by updated date, ascending\n * `updatedAt.desc` - Sort by updated date, descending\n * `count.asc` - Sort by aggregated tag counts, ascending, ONLY works when contributionType = tag is present\n * `count.desc` - Sort by aggregated tag counts, descending, ONLY works when contributionType = tag is present\n"
              }
            ]
          },
          "docs": "Get contribution data by target naId directly from the database. Returns a JSON result."
        },
        {
          "info": {
            "name": "Deactivate/remove a contribution.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://catalog.archives.gov/api/v2/contributions/delete"
          },
          "docs": "Change the status of a contribution to 'inactive'"
        }
      ]
    }
  ],
  "bundled": true
}