{"openapi":"3.0.0","info":{"title":"NextGen Catalog API","version":"0.2.0","description":"\nThis is the NextGen Catalog API application made with Express and documented with Swagger.\n\nThis API requires the use of an API key in order to access. Once you have obtained an API key, you can pass the API key into a REST API call in the x-api-key header of the request. For example, the request might look like\n\n    curl --location --request GET 'https://catalog.archives.gov/api/v2/records/search?q=constitution'\n    --header 'Content-Type: application/json'\n    --header 'x-api-key: API_KEY'\n\nwhere API_KEY is the key string of your API key.\n\nFor write operations, in addition to the API key, a user ID in the format of a Universally Unique Identifier (UUID) is required in the body of the request. For example, a request to POST a tag might look like:\n\n    curl --location --request POST 'https://catalog.archives.gov/api/v2/tags'\n    --header 'Content-Type: application/json'\n    --data-raw '{\n    \"tag\": \"example tag\",\n    \"targetNaId\": 1667751,\n    \"userId\": \"USER_UUID\"\n    }'\nwhere USER_UUID is the UUID of the user.\n\nPlease contact O&M at Catalog_API@nara.gov for an API Key."},"servers":[{"url":"https://catalog.archives.gov/api/v2/"}],"paths":{"/records/search":{"get":{"summary":"Get records by using url parameters to perform a catalog search.","description":"Get records by using url parameters to perform a catalog search. Returns a JSON result.","tags":["Records"],"parameters":[{"$ref":"#/components/parameters/paramQuery"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"},{"$ref":"#/components/parameters/paramSearchAfterRecord"},{"$ref":"#/components/parameters/paramSourceIncludes"},{"$ref":"#/components/parameters/paramTitle"},{"$ref":"#/components/parameters/paramTitleIs"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramNaIdIs"},{"$ref":"#/components/parameters/paramObjectCount"},{"$ref":"#/components/parameters/paramOnline"},{"$ref":"#/components/parameters/paramLevel"},{"$ref":"#/components/parameters/paramPersonOrOrg"},{"$ref":"#/components/parameters/paramSource"},{"$ref":"#/components/parameters/paramMaterials"},{"$ref":"#/components/parameters/paramControlNumbers"},{"$ref":"#/components/parameters/paramLocalID"},{"$ref":"#/components/parameters/paramLocalIDIs"},{"$ref":"#/components/parameters/paramMicroformPublicationsID"},{"$ref":"#/components/parameters/paramMicroformPublicationsIDIs"},{"$ref":"#/components/parameters/paramControlNumberIs"},{"$ref":"#/components/parameters/paramControlType"},{"$ref":"#/components/parameters/paramControlTypeIs"},{"$ref":"#/components/parameters/paramControlGroup"},{"$ref":"#/components/parameters/paramCollectionIdentifier"},{"$ref":"#/components/parameters/paramRecordGroupNumber"},{"$ref":"#/components/parameters/paramCreators"},{"$ref":"#/components/parameters/paramObjectType"},{"$ref":"#/components/parameters/paramReferenceUnits"},{"$ref":"#/components/parameters/paramGeographicReference"},{"$ref":"#/components/parameters/paramAncestorNaId"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramAbbreviated"},{"$ref":"#/components/parameters/paramStartDate"},{"$ref":"#/components/parameters/paramEndDate"},{"$ref":"#/components/parameters/paramFieldExists"},{"$ref":"#/components/parameters/paramContributionsExist"},{"$ref":"#/components/parameters/paramTagsExist"},{"$ref":"#/components/parameters/paramTranscriptionsExist"},{"$ref":"#/components/parameters/paramCommentsExist"},{"$ref":"#/components/parameters/paramExactDate"},{"$ref":"#/components/parameters/paramExcludeField"},{"$ref":"#/components/parameters/paramRecurringDateDay"},{"$ref":"#/components/parameters/paramRecurringDateMonth"},{"$ref":"#/components/parameters/paramBeginCongress"},{"$ref":"#/components/parameters/paramEndCongress"},{"$ref":"#/components/parameters/paramCongressNumber"},{"$ref":"#/components/parameters/paramTagContribution"},{"$ref":"#/components/parameters/paramCommentContribution"},{"$ref":"#/components/parameters/paramTranscriptionContribution"},{"$ref":"#/components/parameters/paramExtractedTextContribution"},{"$ref":"#/components/parameters/paramIncludeExtractedText"},{"$ref":"#/components/parameters/paramIncludeOtherExtractedText"},{"$ref":"#/components/parameters/paramIngestTimeStart"},{"$ref":"#/components/parameters/paramIngestTimeEnd"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/records/search/by-other-extracted-text":{"get":{"summary":"Get records by using other extracted text to perform a catalog search.","description":"Get records by using other extracted text to perform a catalog search. Returns a JSON result.","tags":["Records"],"parameters":[{"$ref":"#/components/parameters/paramQuery"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/records/search/by-contribution":{"get":{"summary":"Get records related to contributions by using url parameters to perform a catalog search.","description":"Get records related to contributions by using url parameters to perform a catalog search. Returns a JSON result.","tags":["Records"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramAbbreviated"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/records/search/by-tag":{"get":{"summary":"Get records related to tags by using url parameters to perform a catalog search.","description":"Get records related to tags by using url parameters to perform a catalog search. Returns a JSON result.","tags":["Records"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"},{"$ref":"#/components/parameters/paramTagIs"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramAbbreviated"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/records/search/by-transcription":{"get":{"summary":"Get records related to transcriptions by using url parameters to perform a catalog search.","description":"Get records related to transcriptions by using url parameters to perform a catalog search. Returns a JSON result.","tags":["Records"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramAbbreviated"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/records/search/by-comment":{"get":{"summary":"Get records related to comments by using url parameters to perform a catalog search.","description":"Get records related to comments by using url parameters to perform a catalog search. Returns a JSON result.","tags":["Records"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramAbbreviated"}],"responses":{"200":{"description":"A body of response data containing full record objects, if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/records/parentNaId/{parentNaId}":{"get":{"summary":"Get records which are immediate children of a specified parentNaId.","description":"Get records which are immediate children of a specified parentNaId. Returns a JSON result.","tags":["Records"],"parameters":[{"in":"path","name":"parentNaId","schema":{"type":"string"},"required":true,"description":"id of parent whose immediate children to return","example":"7005"},{"$ref":"#/components/parameters/paramControlGroup"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramAbbreviated"},{"$ref":"#/components/parameters/paramIngestionTimeStart"},{"$ref":"#/components/parameters/paramIngestionTimeEnd"}],"responses":{"200":{"description":"A body of response data containing full record objects, if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/tags/search":{"get":{"summary":"Get search results for tag data by sending a request with search parameters to the catalog.","description":"Get search results for tag data by sending a request with search parameters to the catalog. Returns a JSON result.","tags":["Tags"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing full tag objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/tags/{id}":{"get":{"summary":"Get a single tag object by tag id.","description":"Get a single tag object by tag id. Returns a JSON result.","tags":["Tags"],"parameters":[{"in":"path","$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing a tag object if it was found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/tags/naId/{naId}":{"get":{"summary":"Get tags by their parent record's naId.","description":"Get tags by their parent record's naId. Returns a JSON result.","tags":["Tags"],"parameters":[{"in":"path","name":"naId","schema":{"type":"string"},"required":true,"description":"naId of parent record whose tags to return","example":"31124739"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing tag objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/tags/userId/{userId}":{"get":{"summary":"Get tags by their contributor's userId.","description":"Get tags by their contributor's userId. Returns a JSON result.","tags":["Tags"],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of tag to return","example":"5b18f857-29d7-31a9-b944-f4e68c12fd3f"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing tag objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/tags/":{"post":{"summary":"Add a tag.","description":"Add a tag to a record.","tags":["Tags"],"requestBody":{"description":"Add a tag to a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tagBody"}}}},"responses":{"200":{"description":"A response body containing confirmation that the tag was added successfully."},"422":{"description":"An error response while processing the request to add a tag."}}}},"/tags/:contributionId":{"delete":{"summary":"Deactivate/remove a tag.","description":"Change the status of a tag to 'inactive' or 'removed'. Normal tags will be made inactive. Administrator tags will be removed.","tags":["Tags"],"parameters":[{"in":"path","name":"contributionId","schema":{"type":"string"},"required":true,"description":"contributionId of a tag to be deactivated/removed.","example":"e3fe99d2-7af7-11ec-90d6-0242ac120003"},{"in":"body","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of the user that created the tag to be deactivated/removed.","example":"55555555-5555-5555-5555-555555555555"},{"in":"body","name":"justificationId","schema":{"type":"number"},"required":false,"description":"justificationId for the tag being deactivated/removed. Defaults to","example":2},{"in":"body","name":"actionNotes","schema":{"type":"string"},"required":false,"description":"Additional notes for the tag being deactivated/removed. Defaults to the empty string.","example":"Tag removed at users request."}],"responses":{"200":{"description":"A response body containing confirmation that the tag was deactivated/removed successfully."},"409":{"description":"An error response while processing the request to deactivate/remove the tag."}}}},"/comments/search":{"get":{"summary":"Get search results for comment data by sending a request with search parameters to the catalog.","description":"Get search results for comment data by sending a request with search parameters to the catalog. Returns a JSON result.","tags":["Comments"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing full comment objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/comments/{id}":{"get":{"summary":"Get a single comment object by comment id.","description":"Get a single comment object by comment id. Returns a JSON result.","tags":["Comments"],"parameters":[{"in":"path","$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing a comment object if it was found."},"422":{"description":"Unprocessable Entity."}}}},"/comments/naId/{naId}":{"get":{"summary":"Get comments by their parent record's naId.","description":"Get comments by their parent record's naId. Returns a JSON result.","tags":["Comments"],"parameters":[{"in":"path","name":"naId","schema":{"type":"string"},"required":true,"description":"naId of parent record whose comments to return","example":"57664721"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing comment objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/comments/userId/{userId}":{"get":{"summary":"Get comments by their contributor's userId.","description":"Get comments by their contributor's userId. Returns a JSON result.","tags":["Comments"],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of contributor whose comments to return","example":"5b18f857-29d7-31a9-b944-f4e68c12fd3f"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing comment objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/comments/":{"post":{"summary":"Add a comment.","description":"Add a comment to a record.","tags":["Comments"],"requestBody":{"description":"Add a comment to a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commentBody"}}}},"responses":{"200":{"description":"A response body containing confirmation that the comment was added successfully."},"422":{"description":"An error response while processing the request to add a comment."}}}},"/comments/{contributionId}":{"patch":{"summary":"Update a comment.","description":"Update a comment on a record.","tags":["Comments"],"parameters":[{"in":"path","name":"contributionId","schema":{"type":"string"},"required":true,"description":"contributionId of comment to update","example":"cf831974-7af7-11ec-90d6-0242ac120003"}],"requestBody":{"description":"Update a comment on a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commentUpdateBody"}}}},"responses":{"200":{"description":"A response body containing confirmation that the comment was added successfully."},"422":{"description":"An error response while processing the request to add a comment."}}},"delete":{"summary":"Deactivate/remove a comment.","description":"Change the status of a comment to 'inactive' or 'removed'. Normal comments will be made inactive. Administrator comments will be removed.","tags":["Comments"],"parameters":[{"in":"path","name":"contributionId","schema":{"type":"string"},"required":true,"description":"contributionId of a comment to be deactivated/removed.","example":"e3fe99d2-7af7-11ec-90d6-0242ac120003"},{"in":"body","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of the user that created the comment to be deactivated/removed.","example":"55555555-5555-5555-5555-555555555555"},{"in":"body","name":"justificationId","schema":{"type":"number"},"required":false,"description":"justificationId for the comment being deactivated/removed. Defaults to","example":2},{"in":"body","name":"actionNotes","schema":{"type":"string"},"required":false,"description":"Additional notes for the comment being deactivated/removed. Defaults to the empty string.","example":"Comment removed at users request."}],"responses":{"200":{"description":"A response body containing confirmation that the comment was deactivated/removed successfully."},"409":{"description":"An error response while processing the request to deactivate/remove a comment."}}}},"/transcriptions/search":{"get":{"summary":"Get search results for transcriptions data by sending a request with search parameters to the catalog.","description":"Get search results for transcriptions data by sending a request with search parameters to the catalog. Returns a JSON result.","tags":["Transcriptions"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing full transcription objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/transcriptions/{id}":{"get":{"summary":"Get a single transcription object by transcription id.","description":"Get a single transcription object by transcription id. Returns a JSON result.","tags":["Transcriptions"],"parameters":[{"in":"path","$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing a transcription object if it was found."},"422":{"description":"Unprocessable Entity."}}}},"/transcriptions/naId/{naId}":{"get":{"summary":"Get transcriptions by their parent record's naId.","description":"Get transcriptions by their parent record's naId. Returns a JSON result.","tags":["Transcriptions"],"parameters":[{"in":"path","name":"naId","schema":{"type":"string"},"required":true,"description":"naId of parent record whose transcriptions to return","example":"893506"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing transcriptions objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/transcriptions/userId/{userId}":{"get":{"summary":"Get transcriptions by their contributor's userId.","description":"Get transcriptions by their contributor's userId. Returns a JSON result.","tags":["Transcriptions"],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of contributor whose transcriptions to return","example":"5b18f857-29d7-31a9-b944-f4e68c12fd3f"},{"$ref":"#/components/parameters/paramDebug"}],"responses":{"200":{"description":"A body of response data containing transcription objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/transcriptions/":{"put":{"summary":"Add or update a transcription.","description":"Add a transcription to a record.","tags":["Transcriptions"],"requestBody":{"description":"Add a transcription to a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionBody"}}}},"parameters":[{"in":"query","name":"publish","schema":{"type":"boolean"},"required":false,"description":"publish flag which when true indicates that a transcription should be published","example":"true"}],"responses":{"200":{"description":"A response body containing confirmation that the transcription was added successfully."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"An error response while processing the request to add a transcription."}}},"post":{"summary":"Add a transcription.","description":"Add a transcription to a record.","tags":["Transcriptions"],"requestBody":{"description":"Add a transcription to a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transcriptionBody"}}}},"responses":{"200":{"description":"A response body containing confirmation that the transcription was added successfully."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"An error response while processing the request to add a transcription."}}}},"/contributions/":{"put":{"summary":"Update a contribution.","description":"Update a contribution to a record.","tags":["Contributions"],"requestBody":{"description":"Update a contribution to a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contributionBody"}}}},"parameters":[{"in":"query","name":"review","schema":{"type":"boolean"},"required":false,"description":"review flag which when true indicates that a contribution should be reviewed","example":"true"}],"responses":{"200":{"description":"A response body containing confirmation that the transcription was added successfully."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"An error response while processing the request to add a transcription."}}},"get":{"summary":"Get contribution data directly from the database.","description":"Get contribution data directly from the database. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramContType"},{"$ref":"#/components/parameters/paramTargetNaIdFilter"},{"$ref":"#/components/parameters/paramCreatedAtFilter"},{"$ref":"#/components/parameters/paramUpdatedAtFilter"},{"$ref":"#/components/parameters/paramSortBy"},{"$ref":"#/components/parameters/paramIncludeTotalCount"}],"responses":{"200":{"description":"A body of response data containing contribution data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/transcriptions/history/:parentContributionId":{"post":{"summary":"Get the history of a transcription.","description":"Get the history of a transcription to a record.","tags":["Transcriptions"],"parameters":[{"in":"query","name":"parentContributionId","schema":{"type":"string"},"required":true,"description":"parentContributionId indicating the transcription of which to request the history.","example":"232a3c9d-d0b5-32cb-a2d7-26c9eeab57a3"}],"responses":{"200":{"description":"A response body containing the transcription historyPos."},"400":{"description":"Bad Request. Invalid parentContributionId."}}}},"/transcriptions/:contributionId/justificationId/:justificationId":{"delete":{"summary":"Deactivate a transcription.","description":"Deactivate a transcription, reactivate the previous version if it exists.","tags":["Transcriptions"],"parameters":[{"in":"path","name":"contributionId","schema":{"type":"string"},"required":true,"description":"contributionId of a transcription to be deactivated.","example":"e3fe99d2-7af7-11ec-90d6-0242ac120003"},{"in":"path","name":"justificationId","schema":{"type":"integer"},"required":true,"description":"justificationId of the reason a transcription is being deactivated.","example":5},{"in":"query","name":"autoActivate","schema":{"type":"boolean"},"required":false,"description":"autoActivate tag which when true has the API choose a previous transcription to activate","example":true},{"in":"body","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of the user that created the transcription to be deactivated.","example":"55555555-5555-5555-5555-555555555555"},{"in":"body","name":"actionNotes","schema":{"type":"string"},"required":false,"description":"Additional notes for the transcription being deactivated. Defaults to the empty string.","example":"Comment removed at users request."}],"responses":{"200":{"description":"A response body containing confirmation that the transcription was deactivated successfully."},"409":{"description":"An error response while processing the request to deactivate a transcription."}}},"post":{"summary":"Activate a transcription.","description":"Activate a transcription, deactivate any other versions if they exist.","tags":["Transcriptions"],"parameters":[{"in":"path","name":"contributionId","schema":{"type":"string"},"required":true,"description":"contributionId of a transcription to be activated.","example":"e3fe99d2-7af7-11ec-90d6-0242ac120003"},{"in":"path","name":"justificationId","schema":{"type":"integer"},"required":true,"description":"justificationId of the reason a transcription is being activated.","example":5},{"in":"body","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of the user that created the comment to be deactivated.","example":"55555555-5555-5555-5555-555555555555"}],"responses":{"200":{"description":"A response body containing confirmation that the transcription was activated successfully."},"403":{"description":"Insufficient user permissions to change a transcription's status"},"409":{"description":"An error response while processing the request to activate a transcription."}}}},"/contributions/search":{"get":{"summary":"Get search results for contributions data by sending a request with search parameters to the catalog.","description":"Get search results for contributions data by sending a request with search parameters to the catalog. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramContQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramDebug"},{"$ref":"#/components/parameters/paramSearchAfterContribution"}],"responses":{"200":{"description":"A body of response data containing full contribution objects if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/contributions/targetObjectId/{targetObjectId}":{"get":{"summary":"Get contribution data by target object id directly from the database.","description":"Get contribution data by target object id directly from the database. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramTargetObjectId"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramContType"},{"$ref":"#/components/parameters/paramTargetPageNum"}],"responses":{"200":{"description":"A body of response data containing contribution data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/contributions/parentContributionId/{parentContributionId}":{"get":{"summary":"Get contribution data by parent contribution id directly from the database.","description":"Get contribution data by parent contribution id directly from the database. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramParentContUuid"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramContType"},{"$ref":"#/components/parameters/paramTargetNaIdFilter"},{"$ref":"#/components/parameters/paramCreatedAtFilter"},{"$ref":"#/components/parameters/paramUpdatedAtFilter"},{"$ref":"#/components/parameters/paramSortBy"}],"responses":{"200":{"description":"A body of response data containing contribution data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/contributions/contributionId/{contributionId}":{"get":{"summary":"Get contribution data by contribution id directly from the database.","description":"Get contribution data by contribution id directly from the database. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramContUuid"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramContType"}],"responses":{"200":{"description":"A body of response data containing contribution data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/contributions/userId/{userId}":{"get":{"summary":"Get contribution data by user id directly from the database.","description":"Get contribution data by user id directly from the database. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramContUserId"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramContType"},{"$ref":"#/components/parameters/updatedAfter"},{"$ref":"#/components/parameters/paramTargetNaIdFilter"},{"$ref":"#/components/parameters/paramCreatedAtFilter"},{"$ref":"#/components/parameters/paramUpdatedAtFilter"},{"$ref":"#/components/parameters/paramSortBy"}],"responses":{"200":{"description":"A body of response data containing contribution data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/contributions/targetNaId/{targetNaId}":{"get":{"summary":"Get contribution data by target naId directly from the database.","description":"Get contribution data by target naId directly from the database. Returns a JSON result.","tags":["Contributions"],"parameters":[{"$ref":"#/components/parameters/paramTargetNaId"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramContType"},{"$ref":"#/components/parameters/paramCreatedAtFilter"},{"$ref":"#/components/parameters/paramUpdatedAtFilter"},{"$ref":"#/components/parameters/paramSortBy"}],"responses":{"200":{"description":"A body of response data containing contribution data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/contributions/delete":{"delete":{"summary":"Deactivate/remove a contribution.","description":"Change the status of a contribution to 'inactive'","tags":["Contributions"],"parameters":[{"in":"body","name":"contributionList","schema":{"type":"array"},"required":true,"description":"Array containing contributionIds of the contribution to be deactivated/removed.","example":["e3fe99d2-7af7-11ec-90d6-0242ac120003","3fa85f64-5717-4562-b3fc-2c963f66afa"]},{"in":"body","name":"userId","schema":{"type":"string"},"required":true,"description":"Moderator's unique identifier which maps to the userId field in the MySQL database","example":"55555555-5555-5555-5555-555555555555"}],"responses":{"200":{"description":"A response body containing confirmation that the contribution was deactivated/removed successfully."},"409":{"description":"An error response while processing the request to deactivate/remove the contribution."}}}},"/users/userId/{userId}":{"get":{"summary":"Get public account data by account id directly from the database.","description":"Get public account data by account id directly from the database. Returns a JSON result.","tags":["Accounts"],"responses":{"200":{"description":"A body of response data containing public account data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/justifications":{"get":{"summary":"Get justifications directly from the database.","description":"Get justifications directly from the database. Returns a JSON result.","tags":["Justifications"],"parameters":[{"$ref":"#/components/parameters/paramAssociatedTable"}],"responses":{"200":{"description":"A body of response data containing public account data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/users/userName/{userName}":{"get":{"summary":"Get public account data by account id directly from the database.","description":"Get public account data by account id directly from the database. Returns a JSON result.","tags":["Accounts"],"responses":{"200":{"description":"A body of response data containing public account data from the database if any were found."},"422":{"description":"Unprocessable Entity."}}}},"/records/stats":{"get":{"summary":"Retrieve statistics related to user contributions.","description":"Fetches aggregated statistics for different contribution types (e.g., comments, tags, transcriptions) across various record types (e.g., authorityRecords, digitalObjects, descriptions). The results include a breakdown by contribution type and grand totals.","tags":["Statistics"],"responses":{"200":{"description":"Successfully retrieved contribution statistics.","content":{"application/json":{"schema":{"type":"object","properties":{"digitalObjects":{"$ref":"#/components/schemas/ContributionRecord"},"descriptions":{"$ref":"#/components/schemas/ContributionRecord"},"authorityRecords":{"$ref":"#/components/schemas/ContributionRecord"},"metaData":{"$ref":"#/components/schemas/MetaData"}}}}}},"500":{"description":"Internal server error"}}}},"/fetch-coords":{"post":{"summary":"Fetch JSON data from S3 based on a provided URL.","description":"This endpoint receives an S3 URL pointing to a resource, modifies the URL to target a JSON file instead of an image, and returns the content of the JSON file.","tags":["Utilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["s3Url"],"properties":{"s3Url":{"type":"string","description":"The S3 URL pointing to the original image file.","example":"https://s3.amazonaws.com/bucket-name/path/to/file.jpg"}}}}}},"responses":{"200":{"description":"JSON data successfully retrieved from the specified S3 URL.","content":{"application/json":{"schema":{"type":"object","properties":{"averageConfidenceScore":{"type":"number","description":"The average confidence score of the digital object transcription."},"data":{"type":"object","description":"The structure of the JSON data can vary depending on the content of the file.","example":{"DocumentMetadata":{"Pages":1},"Blocks":[{"BlockType":"PAGE","Text":"Example text"}]}}}}}}},"400":{"description":"Invalid S3 URL format. Please check the URL and try again."},"500":{"description":"Server error occurred while fetching JSON from S3."}}}},"/other-extracted-text/search":{"get":{"summary":"Get search results for active contribution data by sending a request to the catalog with other extracted text as a search parameter.","description":"Get search results for active contribution data by sending a request to the catalog with other extracted text as a search parameter. It returns a JSON result.","tags":["Other Extracted Text"],"parameters":[{"$ref":"#/components/parameters/paramOETQuery"},{"$ref":"#/components/parameters/paramContId"},{"$ref":"#/components/parameters/paramUserId"},{"$ref":"#/components/parameters/paramUserName"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramContStatus"},{"$ref":"#/components/parameters/paramCreatedAtFilter"},{"$ref":"#/components/parameters/paramUpdatedAtFilter"},{"$ref":"#/components/parameters/paramSortBy"},{"$ref":"#/components/parameters/paramIncludeTotalCount"}],"responses":{"200":{"description":"A body of response data containing other extracted objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity."}}}},"/online-availability":{"get":{"summary":"Get all online availability information.","tags":["Online Availability"],"parameters":[{"$ref":"#/components/parameters/paramAvailability"},{"$ref":"#/components/parameters/paramAvailabilityStatus"},{"$ref":"#/components/parameters/paramNaId"},{"$ref":"#/components/parameters/paramLimit"},{"$ref":"#/components/parameters/paramPage"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity. Query must be a non-empty string."}}}},"/online-availability/naId/{naId}":{"get":{"summary":"Get all online availability information for a record with the given naId.","tags":["Online Availability"],"parameters":[{"$ref":"#/components/parameters/paramPathNaId"}],"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity. Query must be a non-empty string."}}}},"/online-availability/update":{"put":{"summary":"Update or insert online availability information given a record's naId.","tags":["Online Availability"],"requestBody":{"description":"Add online availability information about a record.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/onlineAvailabilityBody"}}}},"responses":{"200":{"description":"A body of response data containing full record objects if any were found."},"400":{"description":"Bad Request. Invalid search terms, revise terms."},"422":{"description":"Unprocessable Entity. Query must be a non-empty string."}}}},"/online-availability/delete":{"delete":{"summary":"Completely remove online availability information for a given record naId.","tags":["Online Availability"],"parameters":[{"$ref":"#/components/parameters/paramNaId"}],"responses":{"200":{"description":"A message confirming the online availability status for the specified record was successfully deleted"},"500":{"description":"Internal server error."}}}},"users":{"0":{"name":"Users","description":"Information about users"}},"/users":{"get":{"summary":"Get public account data directly from the database","description":"Provide any combination of the parameters below to return all users that match this criteria. Use asterisks for wildcards. Values are NOT case sensitive.","x-role":"public","tags":["Accounts"],"parameters":[{"in":"query","name":"userId","schema":{"type":"string"},"description":"User id of the user account.","example":"55555555-5555-5555-5555-555555555555"},{"in":"query","name":"email","schema":{"type":"string"},"description":"Email address of the user account.","example":"johndoe@example.com"},{"in":"query","name":"userName","schema":{"type":"string"},"description":"Username of the user account.","example":"johndoe1"},{"in":"query","name":"fullName","schema":{"type":"string"},"description":"Full name of the user account.","example":"John Doe"},{"in":"query","name":"role","schema":{"type":"string"},"description":"Role of the user account.","example":"contributor"},{"in":"query","name":"status","schema":{"type":"string","enum":["active","deactivated"]},"description":"Status of the user account.","example":"active"},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"Number of records to be returned on a page. Defaults to 5.","example":100},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page number of records to display. Defaults to 1.","example":2},{"in":"query","name":"sortCol","schema":{"type":"string"},"description":"Column name to sort the results by. Optional.","example":"userName"},{"in":"query","name":"sortOrder","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort order, ascending or descending. Defaults to \"asc\" if not specified.","example":"asc"}],"responses":{"200":{"description":"A body of response data containing user records from the database that match search criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"criteria":{"type":"object"},"metadata":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of users."}}},"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"400":{"description":"Invalid query parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Error retrieving data."}}},"patch":{"summary":"Update user information given a user's email.","description":"Update user information given a user. Requires an administrative account and a justification. Returns a JSON result.","tags":["Users"],"requestBody":{"description":"Update information about a user.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/userUpdateBody"}}}},"responses":{"200":{"description":"Successfully updated user"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity - params are invalid"}}}},"/users/username":{"patch":{"summary":"Update a users username given their userId.","description":"Update user information given a user's userId. Returns a JSON result.","tags":["Users"],"requestBody":{"description":"Update information about a user.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usernameUpdateBody"}}}},"responses":{"200":{"description":"Successfully updated user"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity - params are invalid"}}}},"/users/notifications/:userId":{"get":{"summary":"Recieve the users notifications.","description":"Recieve the users notifications, including edited transcriptions, moderated contributions, and replies to comments. Notifications are contributions, with an additional field 'notificationType' to denote type.","tags":["Users"],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of the user recieving notifications.","example":"55555555-5555-5555-5555-555555555555"},{"in":"query","name":"countOnly","schema":{"type":"boolean"},"required":false,"description":"Recieve only the count of notifications, and none of the contributions.","example":true},{"in":"query","name":"date","schema":{"type":"string"},"required":false,"description":"Recieve only the notifications past a certain date. Date must be in YYYY-MM-DD format.","example":"2022-02-22"},{"in":"query","name":"limit","schema":{"type":"int"},"required":false,"description":"Limit the amount of returned notifications.","example":5},{"in":"query","name":"page","schema":{"type":"int"},"required":false,"description":"Page number for pagination of notifications. Page size is denoted by limit, defaults to 5. For example, if page = 3 notifications 10-14 will be returned.","example":2}],"responses":{"200":{"description":"Successfully retrieved notifications"},"422":{"description":"Unprocessable Entity - params are invalid"}}}},"/users/lastViewedNotificationsAt/:userId":{"put":{"summary":"Update the timestamp of the last time the user viewed their notifications.","description":"Update the timestamp of the last time the user viewed their notifications, by userId, to the current time.","tags":["Accounts"],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true,"description":"userId of the user who's lastViewedNotificationsAt is being updated.","example":"55555555-5555-5555-5555-555555555555"},{"in":"body","name":"lastViewedNotificationsAt","schema":{"type":"string"},"required":false,"description":"Optional timestamp to update lastViewedNotificationsAt with.","example":"2016-1-17T16:27:05.000Z"}],"responses":{"200":{"description":"A sucess response."},"422":{"description":"Unprocessable Entity."}}}},"/announcements/latest":{"get":{"summary":"Get a list of active announcements.","description":"Retrieve a paginated list of announcements.","tags":["Announcements"],"responses":{"200":{"description":"A list of announcements.","content":{"application/json":{"schema":{"type":"object","properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/Announcement"}}}}}}}}}},"/announcements":{"get":{"summary":"Get a list of announcements.","description":"Retrieve a paginated list of announcements.","tags":["Announcements"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer","default":1},"description":"The page number of announcements to retrieve."},{"in":"query","name":"limit","schema":{"type":"integer","default":10},"description":"The number of announcements to display per page."},{"in":"query","name":"status","schema":{"type":"string","enum":["ACTIVE","DRAFT","INACTIVE"]},"description":"The status of the announcements to filter by."},{"in":"query","name":"sortCol","schema":{"type":"string","enum":["status","created_at","updated_at","user_name"]},"description":"The column to sort the announcements by."},{"in":"query","name":"sortOrder","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"The order of sorting (ascending or descending)."}],"responses":{"200":{"description":"A list of announcements.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of announcements."},"activeCount":{"type":"integer","description":"The number of active announcements."},"draftCount":{"type":"integer","description":"The number of draft announcements."},"inactiveCount":{"type":"integer","description":"The number of inactive announcements."}}},"announcements":{"type":"array","items":{"$ref":"#/components/schemas/Announcement"}}}}}}}}},"post":{"summary":"Create a new announcement.","description":"Allows a moderator to create a new announcement. The announcement is initially created with a status of 'DRAFT'.","tags":["Announcements"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["announcement_text"],"properties":{"announcement_text":{"type":"string","description":"The content of the announcement."},"notes":{"type":"string","description":"Optional notes about the announcement."},"user_id":{"type":"integer","description":"The ID of the user who is creating the announcement."}}}}}},"responses":{"201":{"description":"Announcement created successfully. The response includes the created announcement details.","content":{"application/json":{"schema":{"type":"object","properties":{"announcement_id":{"type":"integer","description":"The unique identifier of the announcement."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the announcement was created."},"announcement_text":{"type":"string","description":"The content of the announcement."},"notes":{"type":"string","description":"Optional notes about the announcement."},"user_id":{"type":"string","description":"The ID of the user who created the announcement."},"status":{"type":"string","description":"The status of the announcement."}}}}}},"400":{"description":"Validation error. This can occur if the request body does not match the expected format."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/announcements/{announcement_id}":{"put":{"summary":"Update an existing announcement.","description":"Allows a moderator to update an existing announcement.","tags":["Announcements"],"parameters":[{"in":"path","name":"announcement_id","required":true,"schema":{"type":"integer"},"description":"The unique identifier of the announcement to update."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"announcement_text":{"type":"string","description":"Updated content of the announcement."},"status":{"type":"string","enum":["DRAFT","ACTIVE","INACTIVE"],"description":"Updated status of the announcement."},"user_id":{"type":"string","format":"uuid","description":"The ID of the user who is updating the announcement."},"notes":{"type":"string","description":"Optional notes about the announcement."}}}}}},"responses":{"200":{"description":"Announcement updated successfully. Returns the updated announcement object.","content":{"application/json":{"schema":{"type":"object","properties":{"announcement_id":{"type":"integer","description":"The unique identifier of the announcement."},"announcement_text":{"type":"string","description":"Content of the announcement."},"status":{"type":"string","description":"Current status of the announcement."},"user_id":{"type":"string","format":"uuid","description":"The ID of the user who updated the announcement."},"user_name":{"type":"string","description":"The name of the user who updated the announcement."},"notes":{"type":"string","description":"Optional notes about the announcement."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the announcement was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the announcement was last updated."}}}}}},"400":{"description":"Validation error."},"404":{"description":"Announcement not found."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/partners/create":{"post":{"summary":"Create a new partner.","description":"Allows a moderator to create a new partner. The partner is initially created with a status of 'ACTIVE'.","tags":["Partner"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status","fullName","userId"],"properties":{"userId":{"format":"uuid","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa","description":"The Id of the partner."},"status":{"type":"string","example":"ACTIVE","description":"The current status of the partner. Default is set to active."},"fullName":{"type":"string","example":"Demo Partner","description":"The full name of the partner."}}}}}},"responses":{"201":{"description":"The partner was created successfully. The response includes the created partner details.","content":{"application/json":{"schema":{"type":"object","properties":{"partnerNameId":{"type":"string","example":"0360214c-55b4-4819-8f28-206b24cca41a","description":"The unique identifier of the partner.","format":"uuid"},"userId":{"format":"uuid","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa","description":"The Id of the partner."},"status":{"type":"string","example":"ACTIVE","description":"The current status of the partner. Default is set to active."},"fullName":{"type":"string","example":"Demo Partner","description":"The full name of the partner."}}}}}},"400":{"description":"Validation error. This can occur if the request body does not match the expected format."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/partners/search":{"get":{"summary":"Search for partners","description":"Allows users to search for partners via userId , partner name, partnerNameId or all","tags":["Partner"],"parameters":[{"in":"query","name":"partnerNameId","description":"partnerNameId of the partner being searched","required":false,"schema":{"maximum":50,"type":"string"},"example":"0360214c-55b4-4819-8f28-206b24cca41a"},{"in":"query","name":"fullName","description":"Full name of the partner being searched","required":false,"schema":{"maximum":100,"type":"string"},"example":"Demo Partner"},{"in":"query","name":"userId","description":"userId of the user that associated with the partner","required":false,"schema":{"maximum":50,"type":"string"},"example":"3fa85f64-5717-4562-b3fc-2c963f66afa"}],"responses":{"200":{"description":"List of the partners retrieved through the search criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"partnerNameId":{"type":"string","description":"The unique identifier of the partner.","format":"uuid"},"userId":{"format":"uuid","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa","description":"The Id of the partner."},"status":{"type":"string","example":"ACTIVE","description":"The current status of the partner. Default is set to active."},"fullName":{"type":"string","example":"Demo Partner","description":"The full name of the partner."}}}}}},"400":{"description":"Validation error. This can occur if the request body does not match the expected format."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/partners/update":{"patch":{"summary":"Update partner name.","description":"Allows a moderator to update partner's full name and status.","tags":["Partner"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerNameId","userId"],"properties":{"partnerNameId":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa","description":"Id of the partner to be updated."},"status":{"type":"string","example":"INACTIVE","description":"Current status of the partner to be updated."},"userId":{"type":"string","format":"uuid","example":"0360214c-55b4-4819-8f28-206b24cca41a","description":"Id of the account to do the update."},"fullName":{"type":"string","example":"Demo Partner Changed","description":"Name of the partner to be updated."}}}}}},"responses":{"200":{"description":"The partner was updated successfully. The response includes the updated partner name.","content":{"application/json":{"schema":{"type":"object","properties":{"partnerNameId":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa","description":"The unique identifier of the partner."},"userId":{"type":"string","format":"uuid","example":"0360214c-55b4-4819-8f28-206b24cca41a","description":"The unique identifier of the user making the changes."},"fullName":{"type":"string","format":"string","example":"Demo Partner Changed","description":"The new name of the partner."},"status":{"type":"string","format":"string","example":"INACTIVE","description":"The status of the partner."}}}}}},"400":{"description":"Validation error. This can occur if the request body does not match the expected format."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/partners/contributions/partnerNameId/{partnerNameId}":{"get":{"summary":"Get partner contributions by partnerNameId.","description":"Allows a moderator to get partner contributions by partnerNameId.","tags":["Partner"],"parameters":[{"in":"path","name":"partnerNameId","type":"string","format":"uuid","required":true,"description":"The unique identifier of the partner.","example":"0360214c-55b4-4819-8f28-206b24cca41a"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"}],"responses":{"200":{"description":"List of the partner contributions retrieved successfully."},"400":{"description":"Validation error. This can occur if the request body does not match the expected format."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/partners/contributions/fullName/{fullName}":{"get":{"summary":"Get partner contributions by fullName.","description":"Allows a moderator to get partner contributions by id.","tags":["Partner"],"parameters":[{"in":"path","name":"fullName","type":"string","required":true,"description":"The fullName of the partner.","example":"NARA Partner"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"}],"responses":{"200":{"description":"List of the partner contributions retrieved successfully."},"400":{"description":"Validation error. This can occur if the request body does not match the expected format."},"500":{"description":"Internal server error."}},"security":[{"ApiKeyAuth":[]}]}},"/metadata/naid-availability/naid/{naId}":{"get":{"summary":"Get digital object IDs by matching Ancestry metadata in partner-metadata index.","description":"Returns a list of digital object IDs that match the given naid in the partner-metadata index.","tags":["Metadata"],"parameters":[{"name":"naId","in":"path","required":true,"schema":{"type":"string"},"description":"The naid to search for in the partner-metadata index."}],"responses":{"200":{"description":"A list of digital object IDs.","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"List of matching digital object IDs."}}}}}},"400":{"description":"Bad Request. Invalid naid provided."},"404":{"description":"No matching records found."},"500":{"description":"Internal server error."}}}},"/extractedText/{naId}":{"get":{"summary":"Get extracted text for a given naid and digital object ID.","description":"Returns a list of extracted text for a given naid and digital object ID.","tags":["Extracted Text"],"parameters":[{"$ref":"#/components/parameters/paramPathNaId"},{"$ref":"#/components/parameters/paramObjectIdInQuery"},{"$ref":"#/components/parameters/paramPage"},{"$ref":"#/components/parameters/paramLimit"}],"responses":{"200":{"description":"A list of digital object IDs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"objectId":{"type":"string","description":"The digital object ID."},"extractedText":{"type":"string","description":"The extracted text."}}}}}}},"400":{"description":"Bad Request. Invalid naid provided."},"404":{"description":"No matching records found."},"500":{"description":"Internal server error."}}}}},"components":{"properties":{"abolishDate":{"title":"abolishDate","description":"The date on which the organization was terminated, disbanded, inactivated, or superseded.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"accessRestriction":{"title":"accessRestriction","description":"The indication of, explicit markings for, and detailed notes regarding access restrictions on the archival materials.  Alerts users if access to the archival materials may be restricted.","type":"object","properties":{"note":{"type":"string","description":"Significant information pertaining to the access restrictions on archival materials.","examples":["The records may be restricted due to privacy concerns. Register numbers 1 through 900 have been screened and are open for research."]},"specificAccessRestrictions":{"type":"array","items":{"$ref":"#/components/properties/specificAccessRestriction"}},"status":{"type":"string","description":"The indication of whether or not there are access restrictions on the archival materials.","examples":["Restricted - Partly","Restricted - Possibly","Unrestricted"]}}},"accessionNumber":{"title":"accessionNumber","description":"The unique identifier assigned to a group of archival materials that have been transferred into the legal custody of NARA.  Links the description of the archival materials and their acquisition/accession documentation.","type":"string","examples":["NRFFA-276-99-0001","N3-58-88-1"]},"administrativeHistoryNote":{"title":"administrativeHistoryNote","description":"Explanations or significant information regarding the organization, including information relevant to an understanding of its creation, mission, functions, program areas, activities, incumbents, administrative and operational hierarchy, relationships to other corporate bodies, relationships with superior organizations, and earlier or successor names. Establishes an appropriate context for understanding the records created by an organization.","type":"string","examples":["MACV was abolished March 29, 1973, by authority of JCS message 4825 DTG 220021Z Nov 72.","Following U.S. entry into the war the Special Operations Group (SPOBS) became an advance element of a theater of operations and was redesignated Headquarters, U.S. Army Forces in the British Isles by direction of the President conveyed in War Department message 293, AGWAR to SPOBS, January 8, 1942, and announced by HQ USAFBI General Order 1, January 8, 1942."]},"ancestorCollection":{"title":"ancestorCollection","description":"Identifiable and pertinent information that represents a collection that is a parent or more distant ancestor to another archival description or control group.","type":"object","allOf":[{"$ref":"#/components/properties/ancestorDescription"}],"properties":{"collectionIdentifier":{"$ref":"#/components/properties/collectionIdentifier"}}},"ancestorDescription":{"title":"ancestorDescription","description":"Base model for ancestors (parent, grandparent, etc..) to descriptions","type":"object","properties":{"distance":{"$ref":"#/components/properties/distance"},"inclusiveEndDate":{"$ref":"#/components/properties/inclusiveEndDate"},"inclusiveStartDate":{"$ref":"#/components/properties/inclusiveStartDate"},"levelOfDescription":{"$ref":"#/components/properties/levelOfDescription"},"naId":{"$ref":"#/components/properties/naId"},"title":{"$ref":"#/components/properties/title"}}},"ancestorFileUnit":{"title":"ancestorFileUnit","description":"Identifiable and pertinent information that represents a file unit that is a parent or more distant ancestor of another archival description.","type":"object","properties":{"allOf":{"$ref":"#/components/properties/ancestorDescription"}}},"ancestorRecordGroup":{"title":"ancestorRecordGroup","description":"Identifiable and pertinent information that repsents a record group that is a parent or more distant ancestor to another archival description or control group.","type":"object","allOf":[{"$ref":"#/components/properties/ancestorDescription"}],"properties":{"recordGroupNumber":{"$ref":"#/components/properties/recordGroupNumber"}}},"ancestorSeries":{"title":"ancestorSeries","description":"Identifiable and pertinent information that represents a series that is a parent or more distant ancestor of another archival description.","type":"object","properties":{"allOf":{"$ref":"#/components/properties/ancestorDescription"},"creators":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/creatingIndividual"},{"$ref":"#/components/properties/creatingOrganization"}]}}}},"arrangement":{"title":"arrangement","description":"The pattern or ordering sequence, such as alphabetical or chronological, of the archival material.  Helps users locate particular archival materials within a series or file unit.","type":"string","examples":["Arranged alphabetically by subject.","Unarranged."]},"audiovisual":{"title":"audiovisual","description":"Indicates if a file unit or series is audio-visual in nature.","type":"boolean","examples":[true,false]},"authorityReference":{"title":"authorityReference","description":"Heading and identifier of a primary authority record.  Represents a relationship between authorities or between authorities and descriptions.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/authorityType"},"heading":{"$ref":"#/components/properties/heading"},"naId":{"$ref":"#/components/properties/naId"}}},"authorityType":{"title":"authorityType","description":"Type of the primary authority used to control descriptive and entitic terms on archival materials.","type":"string","anyOf":[{"$ref":"#/components/properties/contextualAuthorityType"},{"$ref":"#/components/properties/descriptiveAuthorityType"}]},"beginCongress":{"title":"beginCongress","description":"The beginning number of the Congress during which the archival materials were created.","type":"integer","examples":[27,103]},"biographicalNote":{"title":"biographicalNote","description":"Explanations or significant information relevant to the understanding of a person's life or activities.","type":"string","examples":["Sarah Weddington was born in Abilene Texas in 1945. In 1965 she received her B.S. degree from McMurry College in Abilene, and in 1967 her J.D. from the University of Texas, Austin. She was a Texas state legislator and in private practice in Austin from 1972 to 1977, when she came to Washington to be the General Counsel of the Department of Agriculture. In October 1978 she became Special Assistant (Assistant after September 1979) to the President for Women's Affairs. In 1981 she returned to Austin to practice law."]},"birthDate":{"title":"birthDate","description":"The date on which the person was born.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"broadcastDate":{"title":"broadcastDate","description":"The date on which the item was first broadcast or another known broadcast date, if first date is unknown.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"broaderTerm":{"title":"broaderTerm","description":"An authorized, preferred heading that is broader in definition and scope","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"heading":{"$ref":"#/components/properties/heading"}}},"collectionIdentifier":{"title":"collectionIdentifier","description":"The unique identifier assigned to a collection.","type":"string","examples":["COLSA","BYRD"]},"contextualAuthorityType":{"title":"contextualAuthorityType","description":"The type of primary authority used to provide context by capturing the historical background of the organizations and individuals who created, contributed to, or are the subject of archival materials.","type":"string","enum":["Organization","Person"]},"contribution":{"title":"contribution","description":"The text of the tag, comment, or transcription entered by a user.","type":"string","examples":["Washington D.C.","Four score and seven years ago...","1991"]},"contributionId":{"title":"contributionId","description":"Uniquely identifies a public contribution among other contributions of the same type.","type":"string","examples":["72d186d6-8d88-11ec-b909-0242ac120002","82fb3958-8d88-11ec-b909-0242ac120002"]},"contributionSequence":{"title":"contributionSequence","description":"Represents the order in which contributions are made in relation to a parent contribution.","type":"integer","examples":[1,27]},"contributionTarget":{"title":"contributionTarget","description":"Values needed to identify the description, authority, or digital object that is the target of this contribution.","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"objectId":{"$ref":"#/components/properties/objectId"},"pageNum":{"$ref":"#/components/properties/pageNum"}}},"contributionType":{"title":"contributionType","description":"Identifies the type of public contribution.","type":"string","enum":["comment","tag","transcription"]},"contributor":{"title":"contributor","description":"An organization or person, other than the archival creator, responsible for the intellectual, technical, artistic, or financial production of the archival materials.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/contextualAuthorityType"},"contributorType":{"$ref":"#/components/properties/contributorType"},"heading":{"$ref":"#/components/properties/heading"},"naId":{"$ref":"#/components/properties/naId"}}},"contributorType":{"title":"contributorType","description":"The role of an individual who or an organization that contributed or contributes to archival materials.","type":"string","examples":["Compiler","Musician","Photographer","Producer"]},"coordinates":{"title":"coordinates","description":"Indicates the position of the place, expressed in degrees/minutes/seconds in accor. Latitude is the angular distance north or south of the equator, measured along a meridian. Longitude is the angular distance east or west of the Prime Meridian, which runs through Greenwich, England. Meridians are imaginary north-south lines on the Earth's surface that connect both geographic poles, used to measure longitude.","type":"string","examples":["16 00 N, 106 00 E (16, 106)","40 10 N, 087 45 W (40.167, -87.75)"]},"copyrightDate":{"title":"copyrightDate","description":"The date on which the item was copyrighted. (A copyright date does not mean an item is still copyrighted.)","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"coverageEndDate":{"title":"coverageEndDate","description":"The end of the time period covered by the subject(s) of the archival materials.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"coverageStartDate":{"title":"coverageStartDate","description":"The beginning of the time period covered by the subject(s) of the archival materials.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"createdAt":{"title":"createdAt","description":"Date and time the public contribution was created.","type":"string","format":"date-time","examples":["2018-11-13 20:20:39","2020-01-29 08:11:00"]},"creatingIndividual":{"title":"creatingIndividual","description":"A person responsible for the creation, accumulation, or maintenance of the series when in working (primary) use.","type":"object","allOf":[{"$ref":"#/components/properties/creator"}],"properties":{"birthDate":{"$ref":"#/components/properties/birthDate"},"deathDate":{"$ref":"#/components/properties/deathDate"}}},"creatingOrganization":{"title":"creatingOrganization","description":"The name of an organization responsible for the creation, accumulation, or maintenance of the series when in working (primary) use.","type":"object","allOf":[{"$ref":"#/components/properties/creator"}],"properties":{"abolishDate":{"$ref":"#/components/properties/abolishDate"},"establishDate":{"$ref":"#/components/properties/establishDate"}}},"creator":{"title":"creator","description":"The name of a person or organization responsible for the creation, accumulation, or maintenance of the series when in working (primary) use.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/contextualAuthorityType"},"creatorType":{"$ref":"#/components/properties/creatorType"},"heading":{"$ref":"#/components/properties/heading"},"naId":{"$ref":"#/components/properties/naId"}}},"creatorType":{"title":"creatorType","description":"The means for indicating if a person or organization is the most recent or predecessor creator of archival materials.","type":"string","examples":["Most Recent","Predecessor"]},"custodialHistoryNote":{"title":"custodialHistoryNote","description":"The description of the custodial history for the archival materials from the time of their creation to the time of their accessioning by NARA. This information may be particularly important for personal papers, donated materials, and Federal records that do not come to NARA through the regular government records transfer process. Provides information on any changes of ownership or breaks in the government chain-of-custody that may impact the interpretation of the archival materials or are significant for ensuring their authenticity and integrity.","type":"string","examples":["In 1983 the U.S. Air Force loaned its pre-1945 and Korean War-era photographs and related documentation (including the subject index) to the National Air and Space Museum, Smithsonian Institution, in accordance with a Memorandum of Agreement. The purpose of the loan was, in part, to enable the National Air and Space Museum to produce a videodisc of the collection. The records remained at the museum until 1998 when they were accessioned into the National Archives.","The nucleus of the Stephen T. Mather Collection was placed in the Prints and Photographs Division of the Library of Congress in 1945. In 1954 it was transferred back to the National Park Service (NPS). While the collection was housed at the Library of Congress, the NPS added to it on a regular basis. No additions to the collection were made after 1954. The National Archives accessioned the Mather Collection in 1963."]},"dataControlGroup":{"title":"dataControlGroup","description":"Defines which office within NARA owns or is the custodian of the archival record.","type":"object","properties":{"groupId":{"type":"string","description":"Group identifier","examples":["RDTP1"]},"groupCode":{"type":"string","description":"A list of organizational units that describe a data control group.","examples":["ou=RDTP1,ou=groups"]},"groupName":{"type":"string","description":"The name of the data control group.","examples":["National Archives at Washington, DC - Textual Reference"]}}},"dateNote":{"title":"dateNote","description":"The explanation of various dates or predominant bulk dates or gaps in the archival materials.","type":"string","examples":["The bulk of these are from the period from 1940 to mid-1960s."]},"deathDate":{"title":"deathDate","description":"The date on which the person died.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"descriptiveAuthorityType":{"title":"descriptiveAuthorityType","description":"The type of primary authority used to control specific terms that help describe archival materials.","type":"string","enum":["Geographic Place Name","Specific Records Type","Topical Subject"]},"digitalObject":{"title":"digitalObject","description":"The digital representation of all or part of the archival materials being described.","type":"object","properties":{"extractedText":{"description":"Text that was able to be extracted from the digital object.","type":"string","examples":["Four score and seven years ago our fathers brought forth...","We the People of the United States, in Order to form a more perfect Union..."]},"otherExtractedText":{"description":"Text that was contributed by the NARA partners.","type":"string","examples":["Some text extracted by another OCR technology","Some text extracted by another advanced technology"]},"extractedTextAccurracy":{"description":"A percentage representing how accurately the text extracted from the digital object matches the text displayed in the object.","type":"integer","examples":[50,97]},"objectDescription":{"description":"A brief description of the digital object.","type":"string","examples":["Only the first page of this 12-page letter is available online.","Table of contents"]},"objectDesignator":{"description":"An identifier for each digital object when there is more than one digital object associated with an archival description.","type":"string","examples":["1","Page 1"]},"objectFileSize":{"description":"The size in bytes of the computer file containing the access version of the digital object.","type":"integer","examples":[600000000,202000]},"objectFilename":{"description":"The porition of the object URL that identifies the file without any directory or location.","type":"string","examples":["16-1557a.gif","c43674A.jpg"]},"objectId":{"$ref":"#/components/properties/objectId"},"objectType":{"description":"The type or file format of the digital object.","type":"string","examples":["World Wide Web Page","Portable Document File (PDF)"]},"objectUrl":{"description":"The identifier assigned to the file containing the access version of the digital object.","type":"string","examples":["https://nara-media-001.s3.amazonaws.com/arcmedia/media/images/16/16/16-1557a.gif","http://www.reaganlibrary.archives.gov/photos/large/c43674A.jpg"]},"thumbnailUrl":{"description":"The identifier assigned to the file containing the thumbnail version of the digital object.","type":"string","examples":["https://nara-media-001.s3.amazonaws.com/arcmedia/media/images/16/16/16-1557t.gif","http://www.reaganlibrary.archives.gov/photos/large/c43674T.jpg"]}}},"dispositionAuthorityNumber":{"title":"dispositionAuthorityNumber","description":"The unique identifier assigned by NARA to a category of records indicating that their disposition has been approved by NARA.  This is also known as the schedule number.","type":"string","examples":["N1-370-90-3, item 1501-16a","N1-59-91-33, item 1"]},"distance":{"title":"distance","description":"Indicates number of nodes removed an ancestor is from a descendent description.","type":"integer","examples":[1,2]},"donor":{"title":"donor","description":"The name of an organization or person that has donated a collection of archival materials.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/contextualAuthorityType"},"heading":{"$ref":"#/components/properties/heading"},"naId":{"$ref":"#/components/properties/naId"}}},"editStatus":{"title":"editStatus","description":"The identification of the production or pre-production stage of audiovisual materials (motion pictures, sound recordings or video recordings).","type":"string","examples":["Edited","Partially Edited"]},"endCongress":{"title":"endCongress","description":"The last number of the Congress during which the archival materials were created.","type":"integer","examples":[34,116]},"establishDate":{"title":"establishDate","description":"The date on which the organization was established.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"fileUnitCount":{"title":"fileUnitCount","description":"Total count of file units which are children of this object.","type":"integer","examples":[5023]},"fileUnitPhysicalOccurrence":{"title":"fileUnitPhysicalOccurrence","description":"Details about the physical occurrence of archival materials within a file unit.","type":"object","allOf":[{"$ref":"#/components/properties/physicalOccurrence"}],"properties":{"mediaOccurrences":{"type":"array","items":{"$ref":"#/components/properties/mediaOccurrence"}}}},"findingAid":{"title":"findingAid","description":"Tools that help users more easily find archival descriptions and materials.","type":"object","properties":{"fileFormat":{"type":"string","description":"The type or file format of the online finding aid.","examples":["HTML","Microsoft Word Document"]},"findingAidtype":{"type":"string","description":"The type of finding aid.","examples":["Index","Prelim. Checklist"]},"note":{"type":"string","description":"The explanation of significant information about a finding aid.","examples":["An alphabetical list of cities can be found in the research room."]},"source":{"type":"string","description":"The author or creator of the finding aid.","examples":["National Archives and Records Administration"]},"url":{"type":"string","format":"uri","description":"The URL associated with a finding aid.","examples":["http://www.archives.gov/rocky-mountain/finding-aids/naturalization/"]},"urlNote":{"type":"string","description":"Explanation of significant information about a finding aid url.","examples":["This Online Resource URL is a finding aid for naturalizations."]},"urlDescription":{"type":"string","description":"Description of the information contained at a finding aid url","examples":["This Online Resource URL is a finding aid for naturalizations."]}}},"formerCollection":{"title":"formerCollection","description":"The identifiable information of the collection to which the archival materials were previously allocated. Enables users to locate archival materials by their former collection citations, which can be found in out-of-date finding aids.","type":"object","properties":{"collectionIdentifier":{"$ref":"#/components/properties/collectionIdentifier"},"naId":{"$ref":"#/components/properties/naId"},"title":{"$ref":"#/components/properties/title"}}},"formerRecordGroup":{"title":"formerRecordGroup","description":"The number and indentifiable information of the record group to which the archival materials were previously allocated. Enables users to locate archival materials by their former record group citations, which can be found in out-of-date finding aids, such as earlier versions of the Guide to Federal Records in the National Archives of the United States.formerRecordGroup model description","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"recordGroupNumber":{"$ref":"#/components/properties/recordGroupNumber"},"title":{"$ref":"#/components/properties/title"}}},"formerlyContained":{"title":"formerlyContained","type":"array","description":"A list of naId values that were previously a part of the archival control group.","items":{"$ref":"#/components/properties/naId"}},"formerlyContainedBy":{"title":"formerlyContainedBy","type":"array","description":"A list of naId values representing archival control groups of which this series was a part.","items":{"$ref":"#/components/properties/naId"}},"fullerFormOfName":{"title":"fullerFormOfName","description":"A more complete form of a person's name than is indicated in the name field.","type":"string","examples":["(John Fitzgerald),","(William Childs),"]},"functionAndUse":{"title":"functionAndUse","description":"The description of why the archival materials were created. This element differs from scopeAndContentNote which describes the significant information contained within the records. This data element is about the activities that resulted in the creation of the archival materials. The scopeAndContentNote value is what is in the archival materials.","type":"string","examples":["The Reports of Death were created at field hospitals or by battlefield commanders and were later used by Sextons to complete Internment Records.","The minute books were created to record the court's activities on a daily basis, including both criminal and civil litigation."]},"generalMediaType":{"title":"generalMediaType","description":"The general physical media form of the archival materials.","type":"string","examples":["Loose Sheets","Magnetic Media"]},"generalNote":{"title":"generalNote","description":"Significant information that does not belong in any other element. Provides a place to capture information significant to the public that is not appropriate for any other element.","type":"string","examples":["This series serves as an index to the series 'Correspondence of the Director, 1880-1932.'","This series was known as 'Miscellaneous' in previous finding aids."]},"generalRecordType":{"title":"generalRecordType","description":"The general intellectual form of the archival materials. Allows users to search for archival materials by general records types.","type":"string","examples":["Data Files","Photographs and other Graphic Materials","Textual Records"]},"geographicPlaceNameLinkCounts":{"title":"geographicPlaceNameLinkCounts","description":"Tracks the number and manner of the relationships to a geographic place name authority record.","type":"object","properties":{"geographicPlaceName":{"description":"Total numer of times this geographic place name is referred to in another geographic place name authority record.","examples":[1,1330]},"jurisdiction":{"description":"Total number of times this geographic place name acts as the juristiction of an organization.","type":"integer","examples":[3,349]},"organization":{"description":"Total number of times this geographic place anem is referred to in an organization authority record.","type":"integer","examples":[99,1]},"subject":{"description":"Total number of times this geographic place name acts as the subject of archival materials.","type":"integer","examples":[77,910]},"totalDescription":{"description":"Total number of times this geographic place name is referred to, in any way, in archival materials.","type":"integer","examples":[101,324]}}},"geographicReference":{"title":"geographicReference","description":"The geographic area represented in the archival materials.","allOf":[{"$ref":"#/components/properties/authorityReference"}]},"heading":{"title":"heading","description":"A version of the authorized name of an authority that includes additional information such as dates or fuller forms of names.","type":"string","examples":["Dulles, John Foster, 1888-1959","Kennedy, John F. (John Fitzgerald), 1917-1963","Department of Defense. Department of the Navy. U.S. Naval Support Activity, Chu Lai, Vietnam. 1964-1971"]},"holdingsMeasurement":{"title":"holdingsMeasurement","description":"The unit and quantity of the archival materials in the series.","type":"object","properties":{"count":{"type":"number","description":"The quantity of the archival materials in the series. For artifacts, it counts the number of artifacts in the series. For electronic data, it counts the number of logical data records in the series. For all other records, it counts the number of each type of physical container in which archival materials are stored.","examples":[267,0.5]},"type":{"type":"string","description":"The unit by which archival materials are counted physically for performance measures. The unit is either a physical container or physical entity. Examples of physical containers include legal-size or letter-size boxes, aerial film cans, cabinet drawers, and bound volumes. Physical entities include artifacts and logical data records.","examples":["LTA-S","MAP-1"]}}},"importRecordControlNumber":{"title":"importRecordControlNumber","description":"The number assigned by the organization that created or distributed an imported authority record. It provides traceability for an imported authority record back to the original external source.","type":"string","examples":["n 79021421","n 84804450"]},"inclusiveEndDate":{"title":"inclusiveEndDate","description":"The ending date on which the record group, collection, series, or item was created, maintained, or accumulated by the creator.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"inclusiveStartDate":{"title":"inclusiveStartDate","description":"The beginning date on which the record group, collection, series, or item was created, maintained, or accumulated by the creator.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"internalTransferNumber":{"title":"internalTransferNumber","description":"The unique identifier assigned to a group of archival materials that was transferred within NARA. This type of information is particularly important for archival materials that have been regionalized.","type":"string","examples":["NNTR-S-94-155","NN3-74-89-001"]},"itemAvMediaOccurrence":{"title":"itemAvMediaOccurrence","description":"Additional media occurrence information available for audtiovisual items.","type":"object","allOf":[{"$ref":"#/components/properties/mediaOccurrence"}],"properties":{"base":{"type":"string","description":"The substance of the media used to physically carry or hold the information in the archival item. Also called the substrate.","examples":["Cellulose Acetate","Paper"]},"elementNumber":{"type":"integer","description":"The number assigned to an individual physical component that makes up a reel, tape, or disc. Commonly used when a film reel is made up of separate sound and picture elements, or when a film reel is composed of A and B rolls. For example, a film reel may be composed of an image reel and a soundtrack reel. The image reel could be designated element number 1, and the soundtrack reel could be designated element number 2.","examples":[1,2]},"emulsion":{"type":"string","description":"The type of coating that is bonded to and supported by the base of the specific media type.","examples":["Metal Evaporation","Ferric Oxide"]},"footage":{"type":"integer","description":"The length in feet for an individual roll or reel in an audiovisual item.","examples":[502,465]},"format":{"type":"string","description":"The format of the media comprising the audiovisual materials. For example, the format of videotape can be VHS or Betamax, the format for sound recordings can be Master or Stamper Matrix, or the format for motion pictures can be Duplicate Negative Composite or Master Projection Print Composite.","examples":["Dication Belt: Magnabelt","Sound: Mass Produced Pressing"]},"otherPreservationCharacteristics":{"type":"array","items":{"$ref":"#/components/properties/otherPreservationCharacteristics"}},"recordingSpeed":{"type":"string","description":"The speed at which audio recordings are recorded or reproduced. For audio tapes, the measurement is inches per second (ips). For audio discs or cylinders, the measurement is revolutions per minute (rpm).","examples":["Audio Disk: 120 rpm","Audio Tape: 15 ips"]},"reelTapeDiscNumber":{"type":"integer","description":"Could not find description in LCDRG","examples":[44,3]},"roll":{"type":"string","description":"Indication of the roll used in a motion picture. In creating a film, alternate scenes are typically assembled in checkerboard fashion on two or more different rolls with black leaders between scenes to facilitate fades and dissolves and to ultimately produce a single strip master positive from which a duplicating negative (dupe neg) can then be made.","examples":["A Roll","B Roll"]},"runningTime":{"type":"integer","description":"The duration in seconds of the individual parts (reels, tapes, rolls) of an audiovisual item.","examples":[7200,290]},"soundtrackConfiguration":{"type":"string","description":"The recording configuration of a sound recording or motion picture soundtrack.","examples":["Film: Variable Area, Push-pull","Sound: Dual"]},"soundtrackLanguage":{"type":"string","description":"The language of the soundtrack for a motion picture or video recording.","examples":["Dutch","German"]},"tapeThickness":{"type":"string","description":"The thickness of the tape on which the audiovisual item has been recorded.","examples":["0.5 mil","1.0 mil"]},"wind":{"type":"string","description":"The playback direction of the reel/roll.","examples":["A Wind","B Wind"]}}},"itemAvPhysicalOccurrence":{"title":"itemAvPhysicalOccurrence","description":"itemAvPhysicalOccurrence model description","type":"object","allOf":[{"$ref":"#/components/properties/physicalOccurrence"}],"properties":{"mediaOccurrences":{"type":"array","items":{"$ref":"#/components/properties/itemAvMediaOccurrence"}},"totalFootage":{"type":"number","description":"The length in feet of all the reels or rolls that make up the entire copy of an audiovisual item.","examples":[43,1002]},"totalRunningTime":{"type":"integer","description":"The total duration of an audiovisual item in seconds.","examples":[2340,182]}}},"itemCommon":{"title":"itemCommon","description":"The smallest indivisible archival unit (e.g. a letter, memorandum, report, leaflet, or photograph). For example, a book or record album would be described as an item, but the individual chapters of the book or the discs or songs that make up the album would not be described as items.","type":"object","properties":{"accessionNumber":{"$ref":"#/components/properties/accessionNumber"},"accessRestriction":{"$ref":"#/components/properties/accessRestriction"},"ancestors":{"description":"Identifiable and otherwise relevant information about archival control groups or hierarchical description levels that are parents or more distant ancestors to this file unit.","type":"array","items":{"oneOf":[{"$ref":"#/components/properties/ancestorRecordGroup"},{"$ref":"#/components/properties/ancestorCollection"},{"$ref":"#/components/properties/ancestorSeries"},{"$ref":"#/components/properties/ancestorFileUnit"}]}},"audiovisual":{"$ref":"#/components/properties/audiovisual"},"beginCongress":{"$ref":"#/components/properties/beginCongress"},"contributors":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/organizationalContributor"},{"$ref":"#/components/properties/personalContributor"}]}},"copyrightDates":{"type":"array","items":{"$ref":"#/components/properties/copyrightDate"}},"coverageEndDate":{"$ref":"#/components/properties/coverageEndDate"},"coverageStartDate":{"$ref":"#/components/properties/coverageStartDate"},"custodialHistoryNote":{"$ref":"#/components/properties/custodialHistoryNote"},"dataControlGroup":{"$ref":"#/components/properties/dataControlGroup"},"dateNote":{"$ref":"#/components/properties/dateNote"},"levelOfDescription":{"$ref":"#/components/properties/levelOfDescription"},"digitalObjects":{"type":"array","items":{"$ref":"#/components/properties/digitalObject"}},"endCongress":{"$ref":"#/components/properties/endCongress"},"generalNotes":{"type":"array","items":{"$ref":"#/components/properties/generalNote"}},"generalRecordsTypes":{"type":"array","items":{"$ref":"#/components/properties/generalRecordType"}},"internalTransferNumbers":{"type":"array","items":{"$ref":"#/components/properties/internalTransferNumber"}},"languages":{"type":"array","items":{"$ref":"#/components/properties/language"}},"localIdentifier":{"$ref":"#/components/properties/localIdentifier"},"microformPublications":{"type":"array","items":{"$ref":"#/components/properties/microformPublication"}},"naId":{"$ref":"#/components/properties/naId"},"onlineResources":{"type":"array","items":{"$ref":"#/components/properties/onlineResource"}},"otherTitles":{"type":"array","items":{"$ref":"#/components/properties/otherTitle"}},"partyDesignation":{"$ref":"#/components/properties/partyDesignation"},"productionDates":{"type":"array","items":{"$ref":"#/components/properties/productionDate"}},"recordsCenterTransferNumbers":{"type":"array","items":{"$ref":"#/components/properties/recordsCenterTransferNumber"}},"recordType":{"$ref":"#/components/properties/recordType"},"scaleNote":{"$ref":"#/components/properties/scaleNote"},"scopeAndContentNote":{"$ref":"#/components/properties/scopeAndContentNote"},"subjects":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/geographicReference"},{"$ref":"#/components/properties/organizationalReference"},{"$ref":"#/components/properties/personalReference"},{"$ref":"#/components/properties/specificRecordsTypeReference"},{"$ref":"#/components/properties/topicalSubjectReference"}]}},"subtitle":{"$ref":"#/components/properties/subtitle"},"title":{"$ref":"#/components/properties/title"},"transferNote":{"$ref":"#/components/properties/transferNote"},"useRestriction":{"$ref":"#/components/properties/useRestriction"},"variantControlNumbers":{"type":"array","items":{"$ref":"#/components/properties/variantControlNumber"}}}},"itemCount":{"title":"itemCount","description":"Number of items (including audiovisual items) within this series or file unit","type":"integer","examples":[101,7]},"itemMediaOccurrence":{"title":"itemMediaOccurrence","description":"Additional media occurrence information only available for items.","type":"object","allOf":[{"$ref":"#/components/properties/mediaOccurrence"}],"properties":{"base":{"type":"string","description":"The substance of the media used to physically carry or hold the information in the archival item. Also called the substrate.","examples":["Cellulose Acetate","Paper"]},"emulsion":{"type":"string","description":"The type of coating that is bonded to and supported by the base of the specific media type.","examples":["Metal Evaporation","Ferric Oxide"]},"otherPreservationCharacteristics":{"type":"array","items":{"$ref":"#/components/properties/otherPreservationCharacteristics"}}}},"itemPhysicalOccurrence":{"title":"itemPhysicalOccurrence","description":"itemPhysicalOccurrence model description","type":"object","allOf":[{"$ref":"#/components/properties/physicalOccurrence"}],"properties":{"mediaOccurrences":{"type":"array","items":{"$ref":"#/components/properties/itemMediaOccurrence"}}}},"jurisdiction":{"title":"jurisdiction","description":"The geographic area over which the organization had an administrative responsibility or about which it collected information.  Represents a geographical name authority record.","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"name":{"description":"The name of the jurisdiction","type":"string","examples":["Japan (Asia) nation","Aomori (Tohoku-chiho, Japan, Asia) prefecture"]}}},"language":{"title":"language","description":"The language used in the archival materials.","type":"string","examples":["Algonquian (Other)","Portuguese"]},"levelOfDescription":{"title":"levelOfDescription","description":"The archival control group level (record group or collection) or hierarchical description level (series, file unit, or item) of the archival materials.","type":"string","enum":["Record Group","Collection","File Unit","Series","Item"]},"linkCounts":{"title":"linkCounts","description":"Tracks the number and manner of the relationships between records.","type":"object","properties":{"totalDescription":{"description":"Total number of times this person is referred to, in any way, in archival materials.","type":"integer","examples":[101,324]}}},"localIdentifier":{"title":"localIdentifier","description":"The identifier that a NARA custodial unit specifies to be used to request archival materials in the unit's custody.","type":"string","examples":["64-371","3.3","85-02-04-01.9"]},"location":{"title":"location","description":"Information about where the archival materials are kept.","type":"object","properties":{"facility":{"type":"string","description":"The building where archival materials are kept.","examples":["John F. Kennedy Library (Boston, MA)","National Archives Building - Archives I (Washington, DC)"]},"note":{"type":"string","description":"Location Note indicates the particular location of the archival materials within a building.","examples":["These materials are located in Research Room 5050.","These items are located in the cold vault."]}}},"mediaOccurrence":{"title":"mediaOccurrence","description":"Provides information about the physical description of the archival materials and additional information used to describe the media occurrence of the archival materials.","type":"object","properties":{"color":{"type":"string","description":"The absence or presence of colors, besides black, white and gray, of the specific media type.","examples":["Color","Black-and-White"]},"containerId":{"type":"string","description":"The identifier or number for the individual container storing each specific media type.","examples":["Box 6829","27"]},"depth":{"type":"number","description":"The distance measured from front to back of a specific media type.","examples":[6.75,10]},"dimension":{"type":"string","description":"The standard size of the physical items of a specific media type.","examples":["3x5 inch","Varied"]},"generalMediaTypes":{"type":"array","items":{"$ref":"#/components/properties/generalMediaType"}},"height":{"type":"number","description":"The distance measured from top to bottom of the specific media type.","examples":[11.75,3.5]},"mediaOccurrenceNote":{"type":"string","description":"Explanations or significant information relating to the media occurrence of the archival materials.","examples":["This reel contains music and sound effects.","These images were made by the albumen and collodion processes."]},"physicalRestrictionNote":{"type":"string","description":"Information regarding any physical restrictions that apply to the particular specific media type of the archival materials. Physical restrictions are primarily preservation restrictions.","examples":["Because these records are stored offsite, researchers must request the records 48 hours in advance.","This film reel has shrunk and may not be viewed."]},"pieceCount":{"type":"integer","description":"The exact number of physical items comprising the specific media type of the archival materials.","examples":[3,10]},"process":{"type":"string","description":"The technical or manual means by which the specific media type was created.","examples":["Artwork: Chalk","Photocopy"]},"reproductionCount":{"type":"integer","description":"The exact number of parts or sides of the physical items needed to create a complete duplicate of the specific media type of the archival materials.","examples":[6,49]},"specificMediaType":{"type":"string","description":"The physical form of the archival materials.","examples":["Digital Audio Tape","Film Reel"]},"technicalAccessRequirementsNote":{"type":"string","description":"A description of the equipment needed to view the specific media type, such as a light table to view aerial film, or hardware and software to view archival materials on electronic media.","examples":["An open reel computer tape drive is required.","A light table is needed to view these aerial photographs."]},"width":{"type":"number","description":"The horizontal distance measured from side to side of a specific media type.","examples":[6.25,4.5]}}},"microformPublication":{"title":"microformPublication","description":"Information about the microform publication of the archival material. Microform publications are reproductions of archival materials, which are made available in research rooms for consultation and sometimes marketed and sold.","type":"object","properties":{"identifier":{"type":"string","description":"The unique identifier associated with a microform publication.","examples":["A3354","M1131","T228"]},"note":{"type":"string","description":"Explanations or significant information regarding a microform publication in relation to the archival materials being described.","examples":["These records have been reproduced in full in this microform publication.","Records in this series from 1917-1920 are available in this microform publication."]},"title":{"type":"string","description":"The unique title associated with a microform publication.","examples":["Dunn Rolls of 1867 and 1869, Citizens and Freedmen of the Creek Nation, 1867-1869","Captured North Vietnamese Documents of the Combined Document Exploitation Center, 1950-1975"]}}},"naId":{"title":"naId","description":"National Archives Identifier","type":"integer","examples":[401,1138498]},"name":{"title":"name","description":"The authorized form of an authority record name.","type":"string","examples":["Austria","Financial records","International Trade"]},"narrowerTerm":{"title":"narrowerTerm","description":"An authorized, preferred heading that is narrower in definition and scope.","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"heading":{"$ref":"#/components/properties/heading"}}},"numberingNote":{"title":"numberingNote","description":"The explanation of an agency or NARA-assigned numbering scheme.","type":"string","examples":["Requests for case files in this series must include the final certificate number, which is often found in tract books or on patent documents. When requesting canceled or relinquished case files under the Homestead Act and Timber Culture Acts, include the application number."]},"numerator":{"title":"numerator","description":"A roman numeral which is the subsequent part of a person's forename (first name). In general, a numerator is usually only part of the names of popes and royalty.","type":"string","examples":["II","IV"]},"objectId":{"title":"objectId","description":"The identifier given to a digital object.","type":"string","examples":["Report XR657, Page 1","Map N67, Sht. 36"]},"onlineResource":{"title":"onlineResource","description":"A digital resource, such as a web page or PDF file, that resides outside of the DAS database and enhances understanding of and access to archival materials described within it. Online Resource contains information about the archival materials or their use that is not part of a standard archival description. Online Resource may be created by NARA or by external sources, and may be mounted on NARA or external web sites.","type":"object","properties":{"description":{"type":"string","description":"Textual description of the type of online resource.","examples":["Access to Archival Databases (AAD) system","Filing Manual"]},"note":{"type":"string","description":"Explanations or significant information regarding an Online Resource in relation to the archival materials being described.","examples":["The electronic records in some of the files in this series can be searched online via the Access to Archival Databases (AAD) system.","Order Online! can be used to order copies of these records."]},"url":{"type":"string","description":"The URL associated with an Online Resource.","examples":["http://www.archives.gov/research/order/orderonline.html","http://www.maritime.org/navyfile/index.htm"]}}},"orgLinkCounts":{"title":"orgLinkCounts","description":"Tracks the number and manner of relationships between organizations and other archival materials.","type":"object","properties":{"contributor":{"description":"Total number of times this organization acts as a contributor to archival materials.","type":"integer","examples":[0,1]},"creator":{"description":"Total number of times this organiation acts as a creator for archival materials.","type":"integer","examples":[10,15]},"donor":{"description":"Total number of times this object acts as a donor for archival material.","type":"integer","examples":[10,13]},"subject":{"description":"Total number of times this organization acts as a subject to archival materials.","type":"integer","examples":[3,349]},"totalDescription":{"description":"Total number of times this organization is referred to in an approved archival description.","type":"integer","examples":[101,324]}}},"organizationName":{"title":"organizationName","description":"Represents the name of the organization being described in the authority record. The official designation of an organization","type":"object","properties":{"abolishDate":{"$ref":"#/components/properties/abolishDate"},"contributorTypes":{"type":"array","items":{"$ref":"#/components/properties/contributorType"}},"creatorTypes":{"type":"array","items":{"$ref":"#/components/properties/creatorType"}},"establishDate":{"$ref":"#/components/properties/establishDate"},"heading":{"$ref":"#/components/properties/heading"},"linkCounts":{"$ref":"#/components/properties/orgLinkCounts"},"naId":{"$ref":"#/components/properties/naId"},"name":{"$ref":"#/components/properties/name"},"predecessors":{"type":"array","items":{"$ref":"#/components/properties/predecessor"}},"recordSource":{"$ref":"#/components/properties/recordSource"},"role":{"$ref":"#/components/properties/role"},"successors":{"type":"array","items":{"$ref":"#/components/properties/successor"}},"variantOrganizationNames":{"type":"array","items":{"$ref":"#/components/properties/variantOrganizationName"}}}},"organizationalContributor":{"title":"organizationalContributor","description":"The name of an organization, other than the archival creator, responsible for the intellectual, technical, artistic, or financial production of the archival materials.","type":"object","allOf":[{"$ref":"#/components/properties/contributor"}],"properties":{"abolishDate":{"$ref":"#/components/properties/abolishDate"},"establishDate":{"$ref":"#/components/properties/establishDate"}}},"organizationalDonor":{"title":"organizationalDonor","description":"The name of an organization that has donated a collection of archival materials. Organizational entities include meetings, conferences, commissions, production groups, and Federal agencies. They can be any entity other than an individual.","type":"object","allOf":[{"$ref":"#/components/properties/donor"}],"properties":{"abolishDate":{"$ref":"#/components/properties/abolishDate"},"establishDate":{"$ref":"#/components/properties/establishDate"}}},"organizationalReference":{"title":"organizationalReference","description":"The name of an organization that is the subject of or highly relevant to the archival materials.","type":"object","allOf":[{"$ref":"#/components/properties/authorityReference"}],"properties":{"abolishDate":{"$ref":"#/components/properties/abolishDate"},"establishDate":{"$ref":"#/components/properties/establishDate"}}},"otherPreservationCharacteristics":{"title":"otherPreservationCharacteristics","description":"Additional information about the physical nature of the archival materials needed for preservation purposes.","type":"string","examples":["Artifacts: Copper alloy","Fastners/records adhered together"]},"otherTitle":{"title":"otherTitle","description":"An additional or variant title, such as a title that was translated into English, a formal title that has been changed or corrected, an agency-supplied title, or an informal title. Variant titles include those that do not meet NARA standards for the formation of a title.","type":"string","examples":["Index to Series Described in Entry 36","French Revenge Around Verdun"]},"pageNum":{"title":"pageNum","description":"The page number of a digital object that is the target of a contribution, if applicable.","type":"integer","examples":[100,2]},"parentContributionId":{"title":"parentContributionId","description":"Identifies the first version of a transcription or the comment being replied to.","allOf":[{"$ref":"#/components/properties/contributionId"}]},"partyDesignation":{"title":"partyDesignation","description":"Specifies the an association of a archival record with a political party","type":"string","examples":["Democrat","Non-designated","Republican"]},"personLinkCounts":{"title":"personLinkCounts","description":"Tracks the number and manner of the relationships to a person authority record.","type":"object","properties":{"contributor":{"description":"Total number of times this person acts as a contributor to archival materials.","type":"integer","examples":[0,1]},"creator":{"description":"Total number of times this person acts as a creator for archival materials.","type":"integer","examples":[10,15]},"donor":{"description":"Total number of times this person acts as a donor of archival materials.","type":"integer","examples":[10,13]},"organization":{"description":"Total number of times this object is referred to in an organization authority.","type":"integer","examples":[10,11]},"subject":{"description":"Total number of times this person acts as the subject of archival materials.","type":"integer","examples":[3,349]},"totalDescription":{"description":"Total number of times this person is referred to, in any way, in archival materials.","type":"integer","examples":[101,324]}}},"personName":{"title":"personName","description":"The authorized name of person.","type":"string","examples":["Dulles, John Foster","Elizabeth, Queen, consort of George VI, King of Great Britain","Kennedy, John F."]},"personalContributor":{"title":"personalContributor","description":"The name of a person, other than the archival creator, responsible for the intellectual, technical, artistic, or financial production of the archival materials.","type":"object","allOf":[{"$ref":"#/components/properties/contributor"}],"properties":{"birthDate":{"$ref":"#/components/properties/birthDate"},"deathDate":{"$ref":"#/components/properties/deathDate"}}},"personalDonor":{"title":"personalDonor","description":"The name of a person who donated a collection of archival materials.","type":"object","allOf":[{"$ref":"#/components/properties/donor"}],"properties":{"birthDate":{"$ref":"#/components/properties/birthDate"},"deathDate":{"$ref":"#/components/properties/deathDate"}}},"personalReference":{"title":"personalReference","description":"The name of an individual who is the subject of or highly relevant to the archival materials.","type":"object","allOf":[{"$ref":"#/components/properties/authorityReference"}],"properties":{"birthDate":{"$ref":"#/components/properties/birthDate"},"deathDate":{"$ref":"#/components/properties/deathDate"}}},"personalTitle":{"title":"personalTitle","description":"Titles and other words associated with a person's name, including titles designating rank, office, or nobility; terms of address (Mr., Mrs.); initials for an academic degree (MBA, Dr), a roman numeral used with a surname; or other phrases associated with a name (Saint, Statesman).","type":"string","examples":["Chief","Jr.","Queen of Great Britain"]},"physicalOccurrence":{"title":"physicalOccurrence","description":"physicalOccurrence model description","type":"object","properties":{"copyStatus":{"type":"string","description":"The role or purpose of each physical occurrence (copy) of the archival materials. The purposes are preservation, reference, reproduction or some combination of the three.","examples":["Preservation","Reproduction"]},"extent":{"type":"string","description":"The measurement or amount of the archival materials themselves -- the linear measurement, page count, number of rolls, reels, cassettes, or number of data files.","examples":["Approximately 6,000 pages","100 films on 1,000 film reels"]},"physicalOccurrenceNote":{"type":"string","description":"Explanations or significant information relating to the physical occurrence of the archival materials.","examples":["Some photographs are mounted.","The cubic footage for the series of artifacts was estimated as one quarter of the stack area or 5,000 cubic feet."]},"referenceUnits":{"type":"array","items":{"$ref":"#/components/properties/referenceUnit"}}}},"predecessor":{"title":"predecessor","description":"The name and identifier of the immediate predecessor organization.","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"name":{"$ref":"#/components/properties/name"}}},"productionDate":{"title":"productionDate","description":"The date on which the item was first produced or created.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"productionSeriesNumber":{"title":"productionSeriesNumber","description":"The alphabetic or numeric identifier for a part or section of a production series. Parts or sections refer to segments, such as individual episodes, in a production series. The word \"series\" is used in a non-archival sense.  It specifically refers to motion pictures or videotapes produced as a series, such as a television series or movie serials.","type":"string","examples":["Episode","No. 2","Series 1"]},"productionSeriesSubtitle":{"title":"productionSeriesSubtitle","description":"The title of a part or section of a production series.  Parts or sections refer to segments, such as individual episodes, in a production series. The word \"series\" is used in a non-archival sense. It specifically refers to motion pictures, sound recordings, or videotapes produced as a series, such as a television series or movie serials.","type":"string","examples":["Physics","America's Civil Rights Years (1954-1965)"]},"productionSeriesTitle":{"title":"productionSeriesTitle","description":"The name of a production series to which an audiovisual item belongs. The word \"series\" is used in a non-archival sense. It specifically refers to motion pictures, sound recordings, or videotapes produced as a series, such as a television series or movie serials.","type":"string","examples":["Music for Today","This is America","Viewmaster Science Series"]},"programArea":{"title":"programArea","description":"The function or program area of the organization.","type":"string","examples":["Agriculture","Livestock"]},"publicContributor":{"title":"publicContributor","description":"Information about the user who made the public contribution","type":"object","properties":{"fullName":{"$ref":"#/components/properties/publicContributorFullName"},"naraStaff":{"$ref":"#/components/properties/publicContributorNaraStaff"},"userId":{"$ref":"#/components/properties/publicContributorUserId"},"userName":{"$ref":"#/components/properties/publicContributorUserName"}}},"publicContributorFullName":{"title":"publicContributorFullName","description":"Display name of user who made the public contribution.","type":"string","examples":["John Q Public","Jane Doe"]},"publicContributorHistory":{"title":"publicContributorHistory","description":"Information about the user who made a public contribution that includes date and version information.","type":"object","properties":{"contributionSequence":{"$ref":"#/components/properties/contributionSequence"},"createdAt":{"$ref":"#/components/properties/createdAt"},"fullName":{"$ref":"#/components/properties/publicContributorFullName"},"naraStaff":{"$ref":"#/components/properties/publicContributorNaraStaff"},"userId":{"$ref":"#/components/properties/publicContributorUserId"},"userName":{"$ref":"#/components/properties/publicContributorUserName"}}},"publicContributorNaraStaff":{"title":"publicContributorNaraStaff","description":"Identifies the contributions as being NARA Stff or not.","type":"boolean","examples":[true,false]},"publicContributorUserId":{"title":"publicContributorUserId","description":"Unique identifier of a user who made the public contribution.","type":"integer","examples":[56897,91991]},"publicContributorUserName":{"title":"publicContributorUserName","description":"publicContributorUserName model description","type":"string","examples":["historybuff123","johndoe1776"]},"qualifiableDate":{"title":"qualifiableDate","description":"A datetime with the means to qualify uncertainty.","type":"object","properties":{"day":{"type":"integer","description":"Day of month in DD format (1-31)","examples":[25]},"logicalDate":{"type":"string","format":"date","description":"Day, month, and year combined into a <a href='https://www.iso.org/iso-8601-date-and-time-format.html'> ISO 8601</a> date format: CCYY-MM-DD If day or month is unknown, they are replaced by 01-01 or 12-31 in this representation.","examples":["2020-12-25"]},"month":{"type":"integer","description":"Month of year in MM format (1-12)","examples":[12]},"qualifier":{"type":"string","description":"The means for indicating an uncertain or approximate date.","examples":["ca.","?"]},"year":{"type":"integer","description":"Year in YYYY format","examples":[2020]}}},"recordGroupNumber":{"title":"recordGroupNumber","description":"The unique number assigned to a record group.","type":"integer","examples":[5,59]},"recordSource":{"title":"recordSource","description":"External authority source that provided the authority record.","type":"string","examples":["Getty Art and Architecture Thesaurus","Library of Congress Name Authority File"]},"recordType":{"title":"recordType","description":"Identifies the type of information stored on the record.","type":"string","enum":["description","authority","contribution","delete"]},"recordsCenterTransferNumber":{"title":"recordsCenterTransferNumber","description":"The unique identifier assigned to a group of records that has been transferred into the physical custody of a records center. Formerly this was commonly known as the Records Center Accession Number","type":"string","examples":["490-88-0066A","021-53T-0007P"]},"referenceUnit":{"title":"referenceUnit","description":"Contact information of the unit that provides reference services for the archival materials.","type":"object","properties":{"address1":{"type":"string","description":"Street address of the point of contact / reference unit.","examples":["17101 Huron Street"]},"address2":{"type":"string","description":"Street address of the point of contact / reference unit.","examples":["Suite 100"]},"city":{"type":"string","description":"City portion of address of the point of contact / reference unit.","examples":["Bloomfield"]},"email":{"format":"email","type":"string","description":"Email address of the point of contact / reference unit.","examples":["denver.archives@nara.gov"]},"fax":{"type":"string","description":"Fax number of the point of contact / reference unit","examples":["303-604-4750"]},"mailCode":{"type":"string","description":"Internal mailing code of the point of contact / reference unit.","examples":["RM-DV"]},"name":{"type":"string","description":"Name of the point of contact / reference unit","examples":["National Archives at Denver"]},"phone":{"type":"string","description":"Phone number of the point of contact / reference unit.","examples":["303-604-4740"]},"postalCode":{"type":"string","description":"Postal code of the point of contact / reference unit.","examples":["80023"]},"state":{"type":"string","description":"State portion of address of the point of contact / reference unit.","examples":["CO"]}}},"relatedTerm":{"title":"relatedTerm","description":"An authorized, preferred heading that is related in definition and scope but is not broader or narrower.","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"heading":{"$ref":"#/components/properties/heading"}}},"releaseDate":{"title":"releaseDate","description":"The date on which the audiovisual item was released for distribution.","allOf":[{"$ref":"#/components/properties/qualifiableDate"}]},"role":{"title":"role","description":"Identifies roles that this person or organization fills.","type":"object","properties":{"contributor":{"description":"Indicates if the person or organization acts as a contributor.","type":"boolean","examples":[true,false]},"creator":{"description":"Indicates if the person or organization acts as a contributor.","type":"boolean","examples":[true,false]},"donor":{"description":"Indicates if the person or organization acts as a donor","type":"boolean","examples":[true,false]},"reference":{"description":"Indicates if the person or organization is referenced by another person or org","type":"boolean","examples":[true,false]}}},"roles":{"title":"roles","description":"Identifies roles that this person or organization fills.","type":"object","properties":{"contributor":{"description":"Indicates if the person or organization acts as a contributor.","type":"boolean","examples":[true,false]},"creator":{"description":"Indicates if the person or organization acts as a contributor.","type":"boolean","examples":[true,false]},"donor":{"description":"Indicates if the person or organization acts as a donor","type":"boolean","examples":[true,false]},"subject":{"description":"Indicates if the person or organization acts as a subject","type":"boolean","examples":[true,false]}}},"scaleNote":{"title":"scaleNote","description":"The level of detail in cartographic or architectural documents expressed as a numerical ratio to one, which may have been computed from the verbal or bar scales included on the materials.","type":"string","examples":["1 inch to approximately 90 miles.","The charts are drawn at the 1:250,000 scale (one inch equals 3.43 nautical miles)."]},"scopeAndContentNote":{"title":"scopeAndContentNote","description":"The description of the breadth and depth of the record group, collection, or archival materials.","type":"string","examples":["This collection of donated historical materials consists of files maintained by Gerald M. Rafshoon's Atlanta-based advertising agency. The materials relate to the agency's work advising Jimmy Carter in his successful 1970 gubernatorial campaign, as well as his 1976 presidential campaign and his 1980 bid for re-election."]},"scopeNote":{"title":"scopeNote","description":"A note explaining the coverage, specialized usage, and/or rules for assigning the authority.","type":"string","examples":["Assign this heading to holdings limited to the indigenous Arctic peoples of Greenland, Canada, and northern Alaska.","Located at mouth of Hudson River; visited by Europeans 16th-17th cen.; settled by Dutch, seized by British in 1664; was cosmopolitan center & nations largest city by 18th cen. Today is huge metropolis composed of 5 boroughs corresponding to 5 counties."]},"seriesCount":{"title":"seriesCount","type":"integer","description":"Number of series within the archival control group.","examples":[110]},"seriesPhysicalOccurrence":{"title":"seriesPhysicalOccurrence","description":"Details about the physical occurrence of archival materials within a series.","type":"object","allOf":[{"$ref":"#/components/properties/physicalOccurrence"}],"properties":{"containerList":{"type":"string","description":"The listing of the starting and ending titles of the contents of each container in which the archival materials are stored.","examples":["Volume 1: A - D Volume 2: E - H","Box 1: Correspondence: ca. 1914 -- 1939/1940 Box 2: Correspondence: 1941 -- 1954"]},"holdingsMeasurements":{"type":"array","items":{"$ref":"#/components/properties/holdingsMeasurement"}},"mediaOccurrences":{"type":"array","items":{"$ref":"#/components/properties/mediaOccurrence"}}}},"shortName":{"title":"shortName","description":"A version of the authorized name of an organization or person without additional information such as dates or fuller forms of names.","type":"string","examples":["Dulles, John Foster","Elizabeth, Queen, consort of George VI, King of Great Britain","Kennedy, John F.","Department of Defense. Department of the Navy. U.S. Naval Support Activity, Chu Lai, Vietnam."]},"shotList":{"title":"shotList","description":"A shot-by-shot description of a film or video.","type":"string","examples":["1) GV Wave of LCMs underway, Corregidor under bombardment BG-SV.2) GV Paratrooper descends to Corregidor, many parachutes lay on ground.3) MS Plane passes paratroopers descend to Corregidor (good).4) MS Planes pass over island & drop paratroopers, paratroopers descend, many parachutes lay on island BG-SV.QUALITY: GENERALLY VERY GOOD."]},"soundType":{"title":"soundType","description":"The identification of the sound characteristics (absence or presence of sound) of audiovisual materials.","type":"string","examples":["Silent","Sound and Silent"]},"sourceNote":{"title":"sourceNote","description":"Resources cited to develop and support headings and references in an authority record.","type":"string","examples":["LC authorities online, Jan. 11, 2011","Encyclopedia Britannica Online (1997-2002)"]},"specificAccessRestriction":{"title":"specificAccessRestriction","description":"Specific access restrictions to the archival materials, based on national security considerations, donor restrictions, court orders, and other statutory or regulatory provisions.","type":"object","properties":{"restriction":{"type":"string","description":"The specific reason for access restriction.","examples":["Donor Restricted","FOIA (b)(1) National Security","Presidential Records Act (p)(1) National Security Classified"]},"securityClassification":{"type":"string","description":"The highest level of national security protections or classified nuclear information protections on the archival materials.","examples":["Secret","Top Secret"]}}},"specificRecordsTypeLinkCounts":{"title":"specificRecordsTypeLinkCounts","description":"Tracks the number and manner of the relationships to a specific records type authority record.","type":"object","properties":{"specificRecordsType":{"description":"Total number of times this specific record type is referred to in another specifc records type authority record.","type":"integer","examples":[3,349]},"subject":{"description":"Total number of times this specific record type acts as the subject of archival materials.","type":"integer","examples":[77,910]},"totalDescription":{"description":"Total number of times this specific record type is referred to, in any way, in archival materials.","type":"integer","examples":[101,324]}}},"specificRecordsTypeReference":{"title":"specificRecordsTypeReference","description":"The intellectual format of the archival materials.","allOf":[{"$ref":"#/components/properties/authorityReference"}]},"specificUseRestriction":{"title":"specificUseRestriction","description":"The identification of the type of use restrictions, based on copyright, donor, or statutory provisions, on the archival materials.","type":"string","examples":["Copyright","Donor Restrictions"]},"subtitle":{"title":"subtitle","description":"The secondary name in the formal title of the item, usually indicated by punctuation such as a colon or brackets.","type":"string","examples":["The Final Months","Rev. Martin Luther King, Jr., 1929-1968"]},"successor":{"title":"successor","description":"The name and identifier of the immediate successor ogranization.","type":"object","properties":{"naId":{"$ref":"#/components/properties/naId"},"name":{"$ref":"#/components/properties/name"}}},"title":{"title":"title","description":"The name assigned to the record group, collection, or archival materials.","type":"string","examples":["Inflation Sourcebook [1]","Lou Henry Hoover Papers","Manual for Army Cooks","Records of the Office of the Pardon Attorney","Records of the War Labor Policies Board"]},"topicalSubjectLinkCounts":{"title":"topicalSubjectLinkCounts","description":"Tracks the number and manner of the relationships to a topical subject authority record.","type":"object","properties":{"subject":{"description":"Total number of times this topical subject acts as the subject of archival materials.","type":"integer","examples":[77,910]},"topicalSubject":{"description":"Total number of times this topical subject is referred to in another topical subject.","type":"integer","examples":[3,349]},"totalDescription":{"description":"Total number of times this topical subject is referred to, in any way, in archival materials.","type":"integer","examples":[101,324]}}},"topicalSubjectReference":{"title":"topicalSubjectReference","description":"The topics represented in the archival materials.","allOf":[{"$ref":"#/components/properties/authorityReference"}]},"transferNote":{"title":"transferNote","description":"Significant information regarding the internal transfer of archival materials from one NARA unit to another. This type of information is particularly important for archival materials that have been regionalized. Provides clarification needed to understand Internal Transfer Number or Records Center Transfer Number.","type":"string","examples":["These records were formerly housed with the textual records of the Polar Gift Collection in the former Division of Polar Archives and were transferred to the Still Picture Branch in January 1997."]},"updatedAt":{"title":"updatedAt","description":"Date and time the public contribution was updated.","type":"string","format":"date-time","examples":["2018-11-13 20:20:39","2020-01-29 08:11:00"]},"useFor":{"title":"useFor","description":"The non-preferred, non-authorized form of a subject heading.","type":"string","examples":["Voting rights","Charles Towne (S.C.)","photographs, aerial"]},"useRestriction":{"title":"useRestriction","description":"Provides information and status about restrictions on use of archival materials.","type":"object","properties":{"note":{"type":"string","description":"Significant information pertaining to the use or reproduction of the archival materials.","examples":["Copyright held by RKO General Inc.","Some or all of the images in this series may be subject to copyright or other intellectual property restrictions."]},"specificUseRestrictions":{"type":"array","items":{"$ref":"#/components/properties/specificUseRestriction"}},"status":{"type":"string","description":"Indication of whether or not there are use restrictions on the archival materials.","examples":["Restricted - Fully","Unrestricted"]}}},"variantControlNumber":{"title":"variantControlNumber","description":"The control number or identifier given to the archival materials either by the creator or by NARA.  Allows users to retrieve the archival materials by any known control number.","type":"object","properties":{"note":{"type":"string","description":"The explanation of the variant control number and variant control type.","examples":["Entry 194 is the entry number for this series found in Preliminary Inventory of the Cartographic Records of the American Expeditionary Forces, 1917-21 (Record Group 120) (PI 165)"]},"number":{"type":"string","description":"The actual control number or identifier given to the archival materials.","examples":["MS 74-1094","PI66 181"]},"type":{"type":"string","description":"The type of variant control number or identifier.","examples":["Master Location Register Number","NUCMC Number"]}}},"variantOrganizationName":{"title":"variantOrganizationName","description":"Familiar or commonly used designations for an organization that varies from the organization's official name.","type":"string","examples":["Fannie Mae.","FBI","1st Army."]},"variantPersonName":{"title":"variantPersonName","description":"Additional or variant names commonly used for the person, including nicknames, pen names, or transliterations.","type":"object","properties":{"birthDate":{"$ref":"#/components/properties/birthDate"},"deathDate":{"$ref":"#/components/properties/deathDate"},"fullerFormOfName":{"$ref":"#/components/properties/fullerFormOfName"},"heading":{"$ref":"#/components/properties/heading"},"name":{"$ref":"#/components/properties/personName"},"numerator":{"$ref":"#/components/properties/numerator"},"personalTitle":{"$ref":"#/components/properties/personalTitle"}}}},"schemas":{"collection":{"title":"collection","description":"An artificial accumulation of documents brought together on the basis of some characteristic (e.g. means of acquisition, creator, subject, language, medium, form, name of collector) without regard to the provenance of the documents. The Presidential libraries often organize their archival materials by collections, which primarily fall into three categories: donated historical materials (relating to all Presidencies, Hoover-Bush), Presidential records (applying to Presidencies since Reagan), and Presidential historical materials (Nixon.)","type":"object","properties":{"collectionIdentifier":{"$ref":"#/components/properties/collectionIdentifier"},"coverageEndDate":{"$ref":"#/components/properties/coverageEndDate"},"coverageStartDate":{"$ref":"#/components/properties/coverageStartDate"},"dataControlGroup":{"$ref":"#/components/properties/dataControlGroup"},"dateNote":{"$ref":"#/components/properties/dateNote"},"donors":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/organizationalDonor"},{"$ref":"#/components/properties/personalDonor"}]}},"findingAids":{"type":"array","items":{"$ref":"#/components/properties/findingAid"}},"formerlyContained":{"$ref":"#/components/properties/formerlyContained"},"inclusiveEndDate":{"$ref":"#/components/properties/inclusiveEndDate"},"inclusiveStartDate":{"$ref":"#/components/properties/inclusiveStartDate"},"levelOfDescription":{"$ref":"#/components/properties/levelOfDescription"},"naId":{"$ref":"#/components/properties/naId"},"recordType":{"$ref":"#/components/properties/recordType"},"referenceUnits":{"type":"array","items":{"$ref":"#/components/properties/referenceUnit"}},"scopeAndContentNote":{"$ref":"#/components/properties/scopeAndContentNote"},"seriesCount":{"$ref":"#/components/properties/seriesCount"},"title":{"$ref":"#/components/properties/title"},"variantControlNumbers":{"type":"array","items":{"$ref":"#/components/properties/variantControlNumber"}}},"required":["collectionIdentifier","inclusiveEndDate","inclusiveStartDate","levelOfDescription","naId","recordType","title"]},"comment":{"title":"comment","description":"A form of public contribution that allows a user to share knowledge about the records, tell other users about related records, or share what someone might expect to find in a particular item, file unit, or series.","type":"object","properties":{"contribution":{"$ref":"#/components/properties/contribution"},"contributionId":{"$ref":"#/components/properties/contributionId"},"contributionSequence":{"$ref":"#/components/properties/contributionSequence"},"contributionType":{"$ref":"#/components/properties/contributionType"},"contributor":{"$ref":"#/components/properties/publicContributor"},"createdAt":{"$ref":"#/components/properties/createdAt"},"parentContributionId":{"$ref":"#/components/properties/parentContributionId"},"recordType":{"$ref":"#/components/properties/recordType"},"target":{"$ref":"#/components/properties/contributionTarget"},"updatedAt":{"$ref":"#/components/properties/updatedAt"}}},"fileUnit":{"title":"fileUnit","description":"An organized unit (file, volume, etc.) of documents grouped together either for current use or in the process of archival arrangement. For NARA's descriptive practices, the file unit is the intellectual handling of the record item, which may or may not be the physical handling. In other words, a folder does not necessarily equal a file unit. For example, a case file may be in several physical folders, but is described as one file unit. For electronic records, the definition of a file unit level may be difficult. A file does not necessarily refer to a tape or to a particular data file.","type":"object","properties":{"accessionNumbers":{"type":"array","items":{"$ref":"#/components/properties/accessionNumber"}},"accessRestriction":{"$ref":"#/components/properties/accessRestriction"},"ancestors":{"description":"Identifiable and otherwise relevant information about archival control groups or hierarchical description levels that are parents or more distant ancestors to this file unit.","type":"array","items":{"oneOf":[{"$ref":"#/components/properties/ancestorRecordGroup"},{"$ref":"#/components/properties/ancestorCollection"},{"$ref":"#/components/properties/ancestorSeries"}]}},"arrangement":{"$ref":"#/components/properties/arrangement"},"audiovisual":{"$ref":"#/components/properties/audiovisual"},"beginCongress":{"$ref":"#/components/properties/beginCongress"},"contributors":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/organizationalContributor"},{"$ref":"#/components/properties/personalContributor"}]}},"coverageEndDate":{"$ref":"#/components/properties/coverageEndDate"},"coverageStartDate":{"$ref":"#/components/properties/coverageStartDate"},"custodialHistoryNote":{"$ref":"#/components/properties/custodialHistoryNote"},"dataControlGroup":{"$ref":"#/components/properties/dataControlGroup"},"dateNote":{"$ref":"#/components/properties/dateNote"},"digitalObjects":{"$ref":"#/components/properties/digitalObject"},"editStatus":{"$ref":"#/components/properties/editStatus"},"endCongress":{"$ref":"#/components/properties/endCongress"},"findingAids":{"type":"array","items":{"$ref":"#/components/properties/findingAid"}},"generalNotes":{"type":"array","items":{"$ref":"#/components/properties/generalNote"}},"generalRecordTypes":{"type":"array","items":{"$ref":"#/components/properties/generalRecordType"}},"internalTransferNumbers":{"type":"array","items":{"$ref":"#/components/properties/internalTransferNumber"}},"itemCount":{"$ref":"#/components/properties/itemCount"},"languages":{"type":"array","items":{"$ref":"#/components/properties/language"}},"levelOfDescription":{"$ref":"#/components/properties/levelOfDescription"},"localIdentifier":{"$ref":"#/components/properties/localIdentifier"},"naId":{"$ref":"#/components/properties/naId"},"microformPublications":{"type":"array","items":{"$ref":"#/components/properties/microformPublication"}},"onlineResources":{"type":"array","items":{"$ref":"#/components/properties/onlineResource"}},"otherTitles":{"type":"array","items":{"$ref":"#/components/properties/otherTitle"}},"partyDesignation":{"$ref":"#/components/properties/partyDesignation"},"physicalOccurrences":{"type":"array","items":{"$ref":"#/components/properties/fileUnitPhysicalOccurrence"}},"recordsCenterTransferNumbers":{"type":"array","items":{"$ref":"#/components/properties/recordsCenterTransferNumber"}},"recordType":{"$ref":"#/components/properties/recordType"},"scaleNote":{"$ref":"#/components/properties/scaleNote"},"scopeAndContentNote":{"$ref":"#/components/properties/scopeAndContentNote"},"soundType":{"$ref":"#/components/properties/soundType"},"subjects":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/geographicReference"},{"$ref":"#/components/properties/organizationalReference"},{"$ref":"#/components/properties/personalReference"},{"$ref":"#/components/properties/specificRecordsTypeReference"},{"$ref":"#/components/properties/topicalSubjectReference"}]}},"title":{"$ref":"#/components/properties/title"},"transferNote":{"$ref":"#/components/properties/transferNote"},"useRestriction":{"$ref":"#/components/properties/useRestriction"},"variantControlNumbers":{"type":"array","items":{"$ref":"#/components/properties/variantControlNumber"}}},"required":["accessRestriction","ancestor","creators","generalRecordTypes","levelOfDescription","naId","physicalOccurrences","recordType","title","useRestriction"]},"geographicPlaceName":{"title":"geographicPlaceName","description":"Describes the places represented in archival materials.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/authorityType"},"broaderTerms":{"type":"array","items":{"$ref":"#/components/properties/broaderTerm"}},"coordinates":{"$ref":"#/components/properties/coordinates"},"heading":{"$ref":"#/components/properties/heading"},"importRecordControlNumber":{"$ref":"#/components/properties/importRecordControlNumber"},"linkCounts":{"$ref":"#/components/properties/geographicPlaceNameLinkCounts"},"naId":{"$ref":"#/components/properties/naId"},"narrowerTerms":{"type":"array","items":{"$ref":"#/components/properties/narrowerTerm"}},"relatedTerms":{"type":"array","items":{"$ref":"#/components/properties/relatedTerm"}},"recordSource":{"$ref":"#/components/properties/recordSource"},"recordType":{"$ref":"#/components/properties/recordType"},"scopeNote":{"$ref":"#/components/properties/scopeNote"},"sourceNotes":{"type":"array","items":{"$ref":"#/components/properties/sourceNote"}},"useFor":{"type":"array","items":{"$ref":"#/components/properties/useFor"}}}},"item":{"title":"item","description":"The smallest indivisible archival unit (e.g. a letter, memorandum, report, leaflet, or photograph). For example, a book or record album would be described as an item, but the individual chapters of the book or the discs or songs that make up the album would not be described as items. Not used to describe motion picture films, sound recordings or video recordings.","type":"object","allOf":[{"$ref":"#/components/properties/itemCommon"}],"properties":{"physicalOccurrences":{"type":"array","items":{"$ref":"#/components/properties/itemPhysicalOccurrence"}}},"required":["accessRestriction","ancestor","creators","generalRecordTypes","levelOfDescription","naId","physicalOccurrences","recordType","title","useRestriction"]},"itemAv":{"title":"itemAv","description":"The smallest indivisible archival unit (e.g. a letter, memorandum, report, leaflet, or photograph). For example, a book or record album would be described as an item, but the individual chapters of the book or the discs or songs that make up the album would not be described as items.  Covers descriptions of audiovisual items such as motion picture films, sound recordings, and video recordings.","type":"object","allOf":[{"$ref":"#/components/properties/itemCommon"}],"properties":{"broadcastDates":{"type":"array","items":{"$ref":"#/components/properties/broadcastDate"}},"editStatus":{"$ref":"#/components/properties/editStatus"},"physicalOccurrences":{"type":"array","items":{"$ref":"#/components/properties/itemAvPhysicalOccurrence"}},"productionSeriesNumber":{"$ref":"#/components/properties/productionSeriesNumber"},"productionSeriesSubtitle":{"$ref":"#/components/properties/productionSeriesSubtitle"},"productionSeriesTitle":{"$ref":"#/components/properties/productionSeriesTitle"},"releaseDate":{"$ref":"#/components/properties/releaseDate"},"shotList":{"$ref":"#/components/properties/shotList"},"soundType":{"$ref":"#/components/properties/soundType"}},"required":["accessRestriction","ancestor","creators","generalRecordTypes","levelOfDescription","naId","physicalOccurrences","recordType","title","useRestriction"]},"organization":{"title":"organization","description":"Describes the purpose, history, function and relation to other organizations over time.","type":"object","properties":{"administrativeHistoryNote":{"$ref":"#/components/properties/administrativeHistoryNote"},"authorityType":{"$ref":"#/components/properties/authorityType"},"jurisdictions":{"type":"array","items":{"$ref":"#/components/properties/jurisdiction"}},"heading":{"$ref":"#/components/properties/heading"},"linkCounts":{"$ref":"#/components/properties/orgLinkCounts"},"naId":{"$ref":"#/components/properties/naId"},"organizationNames":{"type":"array","items":{"$ref":"#/components/properties/organizationName"}},"personalReferences":{"type":"array","items":{"$ref":"#/components/properties/authorityReference"}},"programAreas":{"type":"array","items":{"$ref":"#/components/properties/programArea"}},"recordType":{"$ref":"#/components/properties/recordType"},"sourceNotes":{"type":"array","items":{"$ref":"#/components/properties/sourceNote"}}}},"person":{"title":"person","description":"Person model description","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/authorityType"},"biographicalNote":{"$ref":"#/components/properties/biographicalNote"},"birthDate":{"$ref":"#/components/properties/birthDate"},"deathDate":{"$ref":"#/components/properties/deathDate"},"fullerFormOfName":{"$ref":"#/components/properties/fullerFormOfName"},"heading":{"$ref":"#/components/properties/heading"},"importRecordControlNumber":{"$ref":"#/components/properties/importRecordControlNumber"},"linkCounts":{"$ref":"#/components/properties/personLinkCounts"},"naId":{"$ref":"#/components/properties/naId"},"name":{"$ref":"#/components/properties/personName"},"numerator":{"$ref":"#/components/properties/numerator"},"organizationalReferences":{"$ref":"#/components/properties/authorityReference"},"personalTitle":{"$ref":"#/components/properties/personalTitle"},"recordSource":{"$ref":"#/components/properties/recordSource"},"recordType":{"$ref":"#/components/properties/recordType"},"role":{"$ref":"#/components/properties/role"},"sourceNotes":{"type":"array","items":{"$ref":"#/components/properties/sourceNote"}},"variantPersonNames":{"type":"array","items":{"$ref":"#/components/properties/variantPersonName"}}}},"recordGroup":{"title":"recordGroup","description":"A body of organizationally related records established on the basis of provenance by an archives for control purposes; A major archival unit that comprises the records of a large organization, such as a Government bureau or independent agency.","type":"object","properties":{"beginCongress":{"$ref":"#/components/properties/beginCongress"},"coverageEndDate":{"$ref":"#/components/properties/coverageEndDate"},"coverageStartDate":{"$ref":"#/components/properties/coverageStartDate"},"dataControlGroup":{"$ref":"#/components/properties/dataControlGroup"},"dateNote":{"$ref":"#/components/properties/dateNote"},"endCongress":{"$ref":"#/components/properties/endCongress"},"findingAids":{"type":"array","items":{"$ref":"#/components/properties/findingAid"}},"formerlyContained":{"$ref":"#/components/properties/formerlyContained"},"inclusiveEndDate":{"$ref":"#/components/properties/inclusiveEndDate"},"inclusiveStartDate":{"$ref":"#/components/properties/inclusiveStartDate"},"levelOfDescription":{"$ref":"#/components/properties/levelOfDescription"},"naId":{"$ref":"#/components/properties/naId"},"partyDesignation":{"$ref":"#/components/properties/partyDesignation"},"recordGroupNumber":{"$ref":"#/components/properties/recordGroupNumber"},"recordType":{"$ref":"#/components/properties/recordType"},"referenceUnits":{"type":"array","items":{"$ref":"#/components/properties/referenceUnit"}},"scopeAndContentNote":{"$ref":"#/components/properties/scopeAndContentNote"},"seriesCount":{"$ref":"#/components/properties/seriesCount"},"title":{"$ref":"#/components/properties/title"}},"required":["inclusiveEndDate","inclusiveStartDate","levelOfDescription","recordGroupNumber","recordType","title"]},"series":{"title":"series","description":"File units or documents arranged in accordance with a filing system or maintained as a unit because they result from the same accumulation or filing process, the same function, or the same activity; have a particular form; or because of some other relationship arising out of their creation, receipt, or use.","type":"object","properties":{"accessionNumbers":{"type":"array","items":{"$ref":"#/components/properties/accessionNumber"}},"accessRestriction":{"$ref":"#/components/properties/accessRestriction"},"ancestors":{"description":"Identifiable and otherwise relevant information about archival control groups that are parents or more distant ancestors to this series.","type":"array","items":{"oneOf":[{"$ref":"#/components/properties/ancestorRecordGroup"},{"$ref":"#/components/properties/ancestorCollection"}]}},"arrangement":{"$ref":"#/components/properties/arrangement"},"audiovisual":{"$ref":"#/components/properties/audiovisual"},"beginCongress":{"$ref":"#/components/properties/beginCongress"},"contributors":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/organizationalContributor"},{"$ref":"#/components/properties/personalContributor"}]}},"coverageEndDate":{"$ref":"#/components/properties/coverageEndDate"},"coverageStartDate":{"$ref":"#/components/properties/coverageStartDate"},"creators":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/creatingIndividual"},{"$ref":"#/components/properties/creatingOrganization"}]}},"custodialHistoryNote":{"$ref":"#/components/properties/custodialHistoryNote"},"dataControlGroup":{"$ref":"#/components/properties/dataControlGroup"},"dateNote":{"$ref":"#/components/properties/dateNote"},"dispositionAuthorityNumbers":{"type":"array","items":{"$ref":"#/components/properties/dispositionAuthorityNumber"}},"editStatus":{"$ref":"#/components/properties/editStatus"},"endCongress":{"$ref":"#/components/properties/endCongress"},"fileUnitCount":{"$ref":"#/components/properties/fileUnitCount"},"findingAids":{"type":"array","items":{"$ref":"#/components/properties/findingAid"}},"formerlyContainedBy":{"$ref":"#/components/properties/formerlyContainedBy"},"formerAncestors":{"description":"Identifiable and otherwise relevant information about archival control groups that at one time were parents or more distant ancestors to this description.","type":"array","items":{"oneOf":[{"$ref":"#/components/properties/ancestorRecordGroup"},{"$ref":"#/components/properties/ancestorCollection"}]}},"functionAndUse":{"$ref":"#/components/properties/functionAndUse"},"generalNotes":{"type":"array","items":{"$ref":"#/components/properties/generalNote"}},"generalRecordTypes":{"type":"array","items":{"$ref":"#/components/properties/generalRecordType"}},"inclusiveEndDate":{"$ref":"#/components/properties/inclusiveEndDate"},"inclusiveStartDate":{"$ref":"#/components/properties/inclusiveStartDate"},"internalTransferNumbers":{"type":"array","items":{"$ref":"#/components/properties/internalTransferNumber"}},"itemCount":{"$ref":"#/components/properties/itemCount"},"languages":{"type":"array","items":{"$ref":"#/components/properties/language"}},"levelOfDescription":{"$ref":"#/components/properties/levelOfDescription"},"localIdentifier":{"$ref":"#/components/properties/localIdentifier"},"microformPublications":{"type":"array","items":{"$ref":"#/components/properties/microformPublication"}},"naId":{"$ref":"#/components/properties/naId"},"numberingNote":{"$ref":"#/components/properties/numberingNote"},"onlineResources":{"type":"array","items":{"$ref":"#/components/properties/onlineResource"}},"otherTitles":{"type":"array","items":{"$ref":"#/components/properties/otherTitle"}},"partyDesignation":{"$ref":"#/components/properties/partyDesignation"},"pyhsicalOccurrences":{"type":"array","items":{"$ref":"#/components/properties/seriesPhysicalOccurrence"}},"recordsCenterTransferNumbers":{"type":"array","items":{"$ref":"#/components/properties/recordsCenterTransferNumber"}},"recordType":{"$ref":"#/components/properties/recordType"},"scaleNote":{"$ref":"#/components/properties/scaleNote"},"scopeAndContentNote":{"$ref":"#/components/properties/scopeAndContentNote"},"soundType":{"$ref":"#/components/properties/soundType"},"subjects":{"type":"array","items":{"oneOf":[{"$ref":"#/components/properties/geographicReference"},{"$ref":"#/components/properties/organizationalReference"},{"$ref":"#/components/properties/personalReference"},{"$ref":"#/components/properties/specificRecordsTypeReference"},{"$ref":"#/components/properties/topicalSubjectReference"}]}},"title":{"$ref":"#/components/properties/title"},"transferNote":{"$ref":"#/components/properties/transferNote"},"useRestriction":{"$ref":"#/components/properties/useRestriction"},"variantControlNumbers":{"type":"array","items":{"$ref":"#/components/properties/variantControlNumber"}}},"required":["accessRestriction","ancestors","creators","generalRecordTypes","levelOfDescription","naId","physicalOccurrences","recordType","title","useRestriction"]},"specificRecordsType":{"title":"specificRecordsType","description":"Describes the intellectual format of the archival materials.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/authorityType"},"broaderTerms":{"type":"array","items":{"$ref":"#/components/properties/broaderTerm"}},"heading":{"$ref":"#/components/properties/heading"},"importRecordControlNumber":{"$ref":"#/components/properties/importRecordControlNumber"},"linkCounts":{"$ref":"#/components/properties/specificRecordsTypeLinkCounts"},"naId":{"$ref":"#/components/properties/naId"},"narrowerTerms":{"type":"array","items":{"$ref":"#/components/properties/narrowerTerm"}},"recordType":{"$ref":"#/components/properties/recordType"},"recordSource":{"$ref":"#/components/properties/recordSource"},"relatedTerms":{"type":"array","items":{"$ref":"#/components/properties/relatedTerm"}},"scopeNote":{"$ref":"#/components/properties/scopeNote"},"sourceNotes":{"type":"array","items":{"$ref":"#/components/properties/sourceNote"}},"useFor":{"type":"array","items":{"$ref":"#/components/properties/useFor"}}}},"tag":{"title":"tag","description":"A form of user contribution that allows a user enter a word or phrase that describe and categorize the archival materials.","type":"object","properties":{"contribution":{"$ref":"#/components/properties/contribution"},"contributionId":{"$ref":"#/components/properties/contributionId"},"contributionType":{"$ref":"#/components/properties/contributionType"},"contributor":{"$ref":"#/components/properties/publicContributor"},"createdAt":{"$ref":"#/components/properties/createdAt"},"recordType":{"$ref":"#/components/properties/recordType"},"target":{"$ref":"#/components/properties/contributionTarget"}}},"topicalSubject":{"title":"TopicalSubject","description":"Describes the topics represented in archival materials.","type":"object","properties":{"authorityType":{"$ref":"#/components/properties/authorityType"},"broaderTerms":{"type":"array","items":{"$ref":"#/components/properties/broaderTerm"}},"heading":{"$ref":"#/components/properties/heading"},"linkCounts":{"$ref":"#/components/properties/topicalSubjectLinkCounts"},"naId":{"$ref":"#/components/properties/naId"},"narrowerTerms":{"type":"array","items":{"$ref":"#/components/properties/narrowerTerm"}},"relatedTerms":{"type":"array","items":{"$ref":"#/components/properties/relatedTerm"}},"recordType":{"$ref":"#/components/properties/recordType"},"recordSource":{"$ref":"#/components/properties/recordSource"},"scopeNote":{"$ref":"#/components/properties/scopeNote"},"sourceNotes":{"type":"array","items":{"$ref":"#/components/properties/sourceNote"}},"useFor":{"type":"array","items":{"$ref":"#/components/properties/useFor"}}}},"transcription":{"title":"transcription","description":"A form of user contribution that allows a user to put into text the words contained within an archival record in order to increase searchability and make documents easier to read.","type":"object","properties":{"contribution":{"$ref":"#/components/properties/contribution"},"contributionId":{"$ref":"#/components/properties/contributionId"},"contributionType":{"$ref":"#/components/properties/contributionType"},"contributors":{"type":"array","items":{"$ref":"#/components/properties/publicContributorHistory"}},"createdAt":{"$ref":"#/components/properties/createdAt"},"parentContributionId":{"$ref":"#/components/properties/parentContributionId"},"recordType":{"$ref":"#/components/properties/recordType"},"target":{"$ref":"#/components/properties/contributionTarget"}}},"tagBody":{"type":"object","properties":{"tag":{"type":"string","example":"some tag"},"targetNaId":{"type":"integer","example":31124739},"targetObjectId":{"type":"integer","example":31124739},"userId":{"type":"integer","example":"c2558dff-bf46-3e28-8aff-29913227beb2"},"status":{"type":"string","default":"active","example":"inactive"}},"required":["tag","targetNaId","userId"]},"commentBody":{"type":"object","properties":{"comment":{"type":"string","example":"a thoughtful comment","maximum":750},"targetNaId":{"type":"integer","example":31124739},"targetObjectId":{"type":"integer","example":77852917},"userId":{"type":"string","example":"c2558dff-bf46-3e28-8aff-29913227beb2"},"parentContributionId":{"type":"string","example":"55555555-5555-5555-5555-555555555555"},"status":{"type":"string","default":"active","example":"inactive"}},"required":["comment","targetNaId","userId"]},"commentUpdateBody":{"type":"object","properties":{"comment":{"type":"string","example":"a thoughtful edit to this comment","maximum":750},"status":{"type":"string","default":"active","example":"inactive"}}},"transcriptionBody":{"type":"object","properties":{"transcription":{"type":"string","example":"a properly encoded/escaped transcription","maximum":4294967295},"targetNaId":{"type":"integer","example":31124739},"targetObjectId":{"type":"integer","example":77852917},"userId":{"type":"string","example":"c2558dff-bf46-3e28-8aff-29913227beb2"},"status":{"type":"string","default":"active","example":"inactive"}},"required":["transcription","targetNaId","userId"]},"onlineAvailabilityBody":{"type":"object","properties":{"naId":{"type":"string","example":123456,"maximum":30},"status":{"type":"string","example":"active"},"availability":{"type":"string","example":"fullyDigitized","accepted":["fullyDigitized","unrestrictedOnly"]}},"required":["naId"]},"userUpdateBody":{"type":"object","properties":{"actionNotes":{"type":"string","example":"Changed user role to moderator","maximum":500},"adminUserId":{"type":"string","example":"12345678-abcd-efgh-1234-abcdefghigjk","maximum":36,"minimum":36},"email":{"type":"string","example":"johndoe@nara.gov","maximum":250},"justificationId":{"type":"number","example":16,"maximum":20,"minimum":1},"role":{"type":"string","example":"contributor","maximum":32,"minimum":2},"status":{"type":"string","example":"inactive","maximum":32,"minimum":2},"userName":{"type":"string","example":"jdoe1","maximum":32,"minimum":2}},"required":["adminUserId","email","justificationId"]},"usernameUpdateBody":{"type":"object","properties":{"userId":{"type":"string","example":1234,"maximum":100},"userName":{"type":"string","example":"jdoe1","maximum":32,"minimum":2}},"required":["userId"]},"contributionRecord":{"type":"object","properties":{"total":{"type":"number"},"totalWithContributions":{"type":"number"},"totalWithoutContributions":{"type":"number"},"stats":{"type":"object","properties":{"exists":{"type":"array","items":{"$ref":"#/components/schemas/ContributionStat"}},"not_exists":{"type":"array","items":{"$ref":"#/components/schemas/ContributionStat"}}}}}},"contributionStat":{"type":"object","properties":{"contributionType":{"type":"string","enum":["tag","transcription","comment"],"example":"transcription | tag | comment"},"count":{"type":"number"}}},"metaData":{"type":"object","properties":{"grandTotal":{"type":"number"},"lastUpdated":{"type":"string","format":"date-time"}}},"user":{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"email":{"type":"string"},"userName":{"type":"string"},"fullName":{"type":"string"},"role":{"type":"string"},"status":{"type":"string","enum":["active","deactivated"]}},"required":["userId","email","userName"]}},"parameters":{"paramPage":{"in":"query","name":"page","description":"Page number of the paginated result set in which to return.","required":false,"schema":{"default":1,"maximum":10000,"type":"integer"},"example":20},"paramLimit":{"in":"query","name":"limit","description":"Maximum number of results returned for each page of paginated data.","required":false,"schema":{"default":20,"maximum":1000,"type":"integer"},"example":75},"paramQuery":{"in":"query","name":"q","description":"A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (\"\").","required":true,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"trucks photos","summary":"Simple keyword","description":"Returns results which contain trucks and photos. Note that the boolean operator AND is used by default."},"bool":{"value":"John NOT Kennedy","summary":"Boolean operators","description":"Returns results which contain the word John but do not contain the word Kennedy."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns result which contain \"United\" and \"States\" together."},"stemming":{"value":"photo*","summary":"Stemming with wildcards","description":"Returns results which may contain \"photo\", \"photograph\", \"photography\", or other variations."},"jsonexist":{"value":"record.authorityType:*","summary":"JSON field exists","description":"Returns results in which the declared data field exists."},"jsoncontain":{"value":"record.authorityType:geo*","summary":"JSON field contains","description":"Returns results in which the declared data field contains the declared keyword(s)."}}},"paramTitle":{"in":"query","name":"title","description":"A title search string used to search for a record. Matches record.title fields within decsription records and record.heading fields within authority records.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"United States Constitution","summary":"Simple keyword","description":"Returns results which contain United, States, and Constitution within the title. Note that the boolean operator AND is used by default."},"bool":{"value":"John NOT Kennedy","summary":"Boolean operators","description":"Returns results which contain the word John but do not contain the word Kennedy, within in the title."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns result which contain \"United\" and \"States\" together, and within the title."},"stemming":{"value":"Photo*","summary":"Stemming with wildcards","description":"Returns results which may contain \"photo\", \"photograph\", \"photography\", or other variations within the title."}}},"paramTitleIs":{"in":"query","name":"title_is","description":"An exact title of a record. Fully matches record.title fields within description records and record.heading fields within authority records.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"full":{"value":"Truck and Truck-Tractor Registrations","summary":"Full title","description":"Returns results in which the title matches the search term(s) exactly."},"partial":{"value":"Truck and","summary":"Partial title","description":"Does not return any results for partial title matches."}}},"paramNaId":{"in":"query","name":"naId","description":"An array of NARA-specific identifiers, each of which is unique to a single record.","required":false,"schema":{"maximum":10000,"type":"string"},"example":"146919092, 146919093"},"paramAvailability":{"in":"query","name":"availability","description":"An array of online availability values","required":false,"schema":{"enum":["fullyDigitized","unrestrictedOnly"],"type":"string"},"example":"fullyDigitized, unrestrictedOnly"},"paramAvailabilityStatus":{"in":"query","name":"availabilityStatus","description":"An array of online availability status values","required":false,"schema":{"enum":["active","inactive"],"type":"string"},"example":"active, inactive"},"paramNaIdIs":{"in":"query","name":"naId_is","description":"An exact NARA-specific identifier to locate a specific record. This currently functions exactly as naId.","required":false,"schema":{"maximum":30,"type":"integer"},"example":146919092},"paramPathNaId":{"in":"path","name":"naId","description":"Unique, NARA-specific identifier given to each record.","required":false,"schema":{"maximum":30,"type":"integer"},"example":146919092},"paramPathAll":{"in":"path","name":"all","description":"Get the information for all the records with an online availability status set","required":false,"schema":{"enum":["all"],"type":"string"}},"paramObjectCount":{"in":"query","name":"digitalObjectCount","description":"Gets a count of Digital Objects","required":false,"schema":{"default":false,"type":"boolean"}},"paramOnline":{"in":"query","name":"availableOnline","description":"Refers to records at the Item and File Unit levels which contain digital objects and can be viewed online","required":false,"schema":{"default":false,"type":"boolean"}},"paramPersonOrOrg":{"in":"query","name":"personOrOrg","description":"Refers to the heading of authoity records, or headings of roles in archival descriptions. Results can be either descriptions or authority records.","required":false,"schema":{"type":"string"},"examples":{"simple":{"value":"Department of Justice","summary":"Simple keyword","description":"Returns results which contain Department, and Justice within the heading. Note that the boolean operator AND is used by default, but conjunctions are ignored."},"bool":{"value":"John NOT Kennedy","summary":"Boolean operators","description":"Returns results which contain the word John but do not contain the word Kennedy, within in the heading."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns result which contain \"United\" and \"States\" together, and within the heading."},"stemming":{"value":"Cal*","summary":"Stemming with wildcards","description":"Returns results which may contain \"cal\", \"California\", or other variations within the heading."}}},"paramLevel":{"in":"query","name":"levelOfDescription","description":"Describes the NARA-specific hierarchical level in which a record exists.","required":false,"schema":{"enum":["recordGroup","collection","series","fileUnit","item"],"type":"string"},"examples":{"recordGroup":{"value":"recordGroup","summary":"Record Group","description":"Returns records at the Record Group level of the NARA-specific hierarchy"},"collection":{"value":"collection","summary":"Collection","description":"Returns records at the Collection level of the NARA-specific hierarchy"},"series":{"value":"series","summary":"Series","description":"Returns records at the Series level of the NARA-specific hierarchy"},"fileUnit":{"value":"fileUnit","summary":"File Unit","description":"Returns records at the File Unit level of the NARA-specific hierarchy"},"item":{"value":"item","summary":"Item","description":"Returns records at the Item level of the NARA-specific hierarchy"}}},"paramSource":{"in":"query","name":"dataSource","description":"Describes the type of record as either a description or an authority.","required":false,"schema":{"enum":["description","authority"],"type":"string"},"examples":{"description":{"value":"description","summary":"Description","description":"Returns Archival Descriptions"},"authority":{"value":"authority","summary":"Authority","description":"Returns Authority Records"}}},"paramMaterials":{"in":"query","name":"typeOfMaterials","description":"Describes the type(s) of materials associated with an Archival Description","required":false,"schema":{"enum":["Photographs and other Graphic Materials","Moving Images","Textual Records","Architectural and Engineering Drawings","Data Files","Maps and Charts","Sound Recordings","Artifacts"],"type":"string"},"examples":{"photo":{"value":"Photographs and other Graphic Materials","summary":"Photographs and other Graphic Materials","description":"Returns records described as photographs and/or other graphic materials"},"video":{"value":"Moving Images","summary":"Moving Images","description":"Returns records described as moving images"},"text":{"value":"Textual Records","summary":"Textual Records","description":"Returns records described as textual records"},"drawing":{"value":"Architectural and Engineering Drawings","summary":"Architectural and Engineering Drawings","description":"Returns records described as architectural and/or engineering drawings"},"data":{"value":"Data Files","summary":"Data Files","description":"Returns records described as data files"},"maps":{"value":"Maps and Charts","summary":"Maps and Charts","description":"Returns records described as maps and charts"},"audio":{"value":"Sound Recordings","summary":"Sound Recordings","description":"Returns records described as sound recordings or other audio"},"artifacts":{"value":"Artifacts","summary":"Artifacts","description":"Returns records described as artifacts or other physical objects"}}},"paramMicroformPublicationsID":{"in":"query","name":"microformPublicationsIdentifier","description":"A search query string used to search on record.microformPublications.identifier.keyword and returns Archival Descriptions that contain the keywords in the Microform Publication Identifier field.","required":false,"schema":{"maximum":100,"type":"string"},"example":"M236, T498"},"paramMicroformPublicationsIDIs":{"in":"query","name":"microformPublicationsIdentifier_is","description":"Specifies an exact, full Microform Publications Identifier associated with an archival record and returns an Archival Description which contain this ID.","required":false,"schema":{"maximum":100,"type":"string"},"example":"M236"},"paramLocalID":{"in":"query","name":"localIdentifier","description":"A search query string used to search on record.localIdentifier.keyword and returns Archival Descriptions that contain the keywords in the Local Identifier field.","required":false,"schema":{"maximum":100,"type":"string"},"example":"21-A-1, 21-A-2"},"paramLocalIDIs":{"in":"query","name":"localIdentifier_is","description":"Specifies an exact, full Local Identifier associated with an archival record and returns an Archival Description which contain this ID.","required":false,"schema":{"maximum":100,"type":"string"},"example":"121-BA-7112C"},"paramControlNumberIs":{"in":"query","name":"variantControlNumber_is","description":"Specifies an exact, full Variant Control Number associated with an archival record and returns an Archival Description which contain this Variant Control Number.","required":false,"schema":{"maximum":100,"type":"string"},"example":"HD1-318515834"},"paramControlGroup":{"in":"query","name":"controlGroup","description":"Specifies a Control Group number associated with an archival record and returns an Archival Description or Archival Descriptions within this Control Group.","required":false,"schema":{"maximum":100,"type":"string"},"example":358},"paramControlType":{"in":"query","name":"variantControlType","description":"Specifies an type of Variant Control Number associated with archival record(s), and returns all Archival Descriptions which contain a Variant Control Type with these keywords.","required":false,"schema":{"maximum":100,"type":"string"},"example":"HMS Asset ID"},"paramControlTypeIs":{"in":"query","name":"variantControlType_is","description":"Specifies an exact type of Variant Control Number associated with archival record(s) and returns all Archival Descriptions which contain this exact Variant Control Type.","required":false,"schema":{"maximum":100,"type":"string"},"example":"HMS Asset ID"},"paramContQuery":{"in":"query","name":"q","description":"A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (\"\").","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"we the people","summary":"Simple keyword","description":"Returns results which contain one or more contributions with the words we, the, and people. Note that the boolean operator AND is used by default."},"bool":{"value":"people NOT we","summary":"Boolean operators","description":"Returns results which contain one or more contributions with the word people but do not contain the word we."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns results which contain one or more contributions with the words \"United\" and \"States\" together."},"stemming":{"value":"photo*","summary":"Stemming with wildcards","description":"Returns results which contain one or more contributions with variations of the word \"photo\", such as \"photograph\" and \"photography\"."}}},"paramContId":{"in":"query","name":"id","description":"An individual contribution's unique identifier which maps to the record.contributionId field","required":false,"schema":{"maximum":50,"type":"string"},"example":"55555555-5555-5555-5555-555555555555"},"paramCollectionIdentifier":{"in":"query","name":"collectionIdentifier","description":"A parameter which searches records against the record.collectionIdentifier and record.ancestors.collectionIdentifier fields.","required":false,"schema":{"maximum":1024,"type":"string"},"example":"DDE-1021"},"paramRecordGroupNumber":{"in":"query","name":"recordGroupNumber","description":"A parameter which searches records against the record.recordGroupNumber and record.ancestors.recordGroupNumber fields.","required":false,"schema":{"maximum":1024,"type":"string"},"example":428},"paramCreators":{"in":"query","name":"creators","description":"A parameter which searches records against the record.creators.heading fields.","required":false,"schema":{"maximum":1024,"type":"string"},"example":"Department of Defense. Department of the Navy. Naval Photographic Center. (12/1/1959 - ca. 1998)"},"paramObjectType":{"in":"query","name":"objectType","description":"A parameter which searches records against the record.digitalObjects.objectType field. Accepts multiple values separated by commas.","required":false,"schema":{"maximum":50,"type":"string"},"example":"JPG, PDF"},"paramReferenceUnits":{"in":"query","name":"referenceUnits","description":"A parameter which searches records against the record.physicalOccurrences.referenceUnits.name fields. Accepts multiple values separated by commas.","required":false,"schema":{"maximum":1024,"type":"string"},"example":"National Archives at College Park - Motion Pictures"},"paramGeographicReference":{"in":"query","name":"geographicReference","description":"A parameter which searches records against the record.subjects.heading fields where the record.subjects.authorityType field is equal to geographicPlaceName.","required":false,"schema":{"maximum":1024,"type":"string"},"example":"Katmai, Mount (Alaska)"},"paramUserName":{"in":"query","name":"userName","description":"Contributor's screen name which maps to the record.contributor.userName field","required":false,"schema":{"maximum":100,"type":"string"},"example":"johndoe1"},"paramUserId":{"in":"query","name":"userId","description":"Contributor's unique identifier which maps to the record.contributor.userId field","required":false,"schema":{"maximum":50,"type":"string"},"example":"55555555-5555-5555-5555-555555555555"},"paramParentContUuid":{"in":"path","name":"parentContributionId","description":"A contribution's parent contribution's unique uuid identifier, which maps to the parentContributorId field in the MySQL database","required":true,"schema":{"maximum":50,"type":"string"},"example":"55555555-5555-5555-5555-555555555555"},"paramContUuid":{"in":"path","name":"contributionId","description":"An individual contribution's unique uuid identifier which maps to the contributorId field in the MySQL database","required":true,"schema":{"maximum":50,"type":"string"},"example":"55555555-5555-5555-5555-555555555555"},"paramContUserId":{"in":"query","name":"userId","description":"Contributor's unique identifier which maps to the userId field in the MySQL database","required":true,"schema":{"maximum":36,"type":"string"},"example":"55555555-5555-5555-5555-555555555555"},"paramAssociatedTable":{"in":"path","name":"associatedTable","description":"The table to which a justification is associated in the MySQL database","required":false,"schema":{"maximum":30,"type":"string"},"example":"constributions"},"paramTargetNaId":{"in":"path","name":"targetNaId","description":"Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database","required":true,"schema":{"maximum":30,"type":"integer"},"example":1667758},"paramTargetObjectId":{"in":"path","name":"targetObjectId","description":"Contribution's target objects's unique identifier which maps to the targetObjectId field in the MySQL database","required":true,"schema":{"maximum":30,"type":"integer"},"example":45710028},"paramObjectId":{"in":"path","name":"objectId","description":"Unique ID given to an object","required":true,"schema":{"maximum":30,"type":"integer"},"example":152951242},"paramObjectIdInQuery":{"in":"query","name":"objectId","description":"Unique ID given to an object","required":true,"schema":{"maximum":30,"type":"integer"},"example":152951242},"paramTargetPageNum":{"in":"query","name":"targetPageNum","description":"Contribution's target page number which maps to the targetPageNum field in the MySQL database","required":false,"schema":{"maximum":30,"type":"integer"},"example":1},"paramContStatus":{"in":"query","name":"status","description":"Contribution's status which maps to the status field in the MySQL database","required":false,"schema":{"maximum":30,"type":"string"},"example":"active"},"paramContType":{"in":"query","name":"contributionType","description":"Contribution type which maps to the contributionType field in the MySQL database","required":false,"schema":{"maximum":20,"type":"string"},"example":"tag"},"updatedAfter":{"in":"query","name":"updatedAt","description":"Compares provided timestamp to records updated timestamp, which maps to the updatedAt field in the MySQL database","required":false,"schema":{"maximum":30,"type":"string"},"example":"tag"},"paramTargetNaIdFilter":{"in":"query","name":"targetNaId","description":"Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database","required":false,"schema":{"maximum":30,"type":"string"},"example":1667758},"paramCreatedAtFilter":{"in":"query","name":"createdAt","description":"Contribution's date of creation by which to filter","required":false,"schema":{"maximum":30,"type":"string"},"example":"2020-01-01 07:00:00"},"paramUpdatedAtFilter":{"in":"query","name":"updatedAt","description":"Contribution's date of modification by which to filter","required":false,"schema":{"maximum":30,"type":"string"},"example":"2020-01-02 07:00:00"},"paramSortBy":{"in":"query","name":"sortBy","required":false,"schema":{"maximum":30,"type":"string","enum":["contribution.asc","contribution.desc","createdAt.asc","createdAt.desc","updatedAt.asc","updatedAt.desc"]},"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"},"paramAncestorNaId":{"in":"query","name":"ancestorNaId","description":"Specifies the naId of an ancestor object in the hierarchy, by which to limit the search","required":false,"schema":{"maximum":30,"type":"integer"},"example":75284},"paramTagIs":{"in":"query","name":"tag_is","description":"Specifies exactly the tag by which to match the search to.","required":false,"schema":{"maximum":100,"type":"string"},"example":"Bill Clinton"},"paramDebug":{"in":"query","name":"debug","description":"Turns on debug mode, showing metadata in the response body, if set to true.","required":false,"schema":{"maximum":100,"type":"boolean"},"example":true},"paramAbbreviated":{"in":"query","name":"abbreviated","description":"Abbreviated results flag, which when true, returns a shorter version of the results.","required":false,"schema":{"maximum":100,"type":"boolean"},"example":true},"paramIngestionTimeStart":{"in":"query","name":"ingestTimeStart","description":"The ingestTimeStart parameter specifies the date or timestamp for fetching data.\n\nDate only format: YYYY-MM-DD\n    When provided in this format, the time defaults to 00:00:00.000000.\n    Example: 2025-01-13 → interpreted as 2025-01-13 00:00:00.000000\n\n Full timestamp format: YYYY-MM-DD HH:mm:ss.SSSSSS\n     When provided in this format, data will be fetched for the exact timestamp specified.\n     Example: 2025-01-13 14:30:15.123456 → data fetched at this precise datetime\n\nBehavior:\n   If both ingestTimeStart and ingestTimeEnd are provided, description records within that date/time range are retrieved.\n   If only ingestTimeStart is provided, description records on and after that date/time are retrieved.\n   If only ingestTimeEnd is provided, description records on and before that date/time are retrieved.\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"2025-01-13"},"paramIngestionTimeEnd":{"in":"query","name":"ingestTimeEnd","description":"The ingestTimeEnd parameter specifies the date or timestamp for fetching data.\n\nDate only format: YYYY-MM-DD\n    When provided in this format, the time defaults to 23:59:59.999999\n    Example: 2025-01-13 → interpreted as 2025-01-13 23:59:59.999999\n\n Full timestamp format: YYYY-MM-DD HH:mm:ss.SSSSSS\n     When provided in this format, data will be fetched for the exact timestamp specified.\n     Example: 2025-01-13 14:30:15.123456 → data fetched at this precise datetime\n\nBehavior:\n   If both ingestTimeStart and ingestTimeEnd are provided, description records within that date/time range are retrieved.\n   If only ingestTimeStart is provided, description records on and after that date/time are retrieved.\n   If only ingestTimeEnd is provided, description records on and before that date/time are retrieved.\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"2025-01-13"},"paramControlNumbers":{"in":"query","name":"controlNumbers","description":"Specifies an All Control Numbers search string used to search for an archival record and returns Archival Descriptions that contain the keywords in one of the following fields:\n\n* record.accessionNumbers.keyword\n* record.localIdentifier.keyword\n* record.importRecordControlNumber.keyword\n* record.internalTransferNumbers.keyword\n* record.naId\n* record.recordsCenterTransferNumbers.keyword\n* record.variantControlNumbers.number.keyword\n* record.microformPublications.identifier.keyword\n","required":false,"schema":{"maximum":100,"type":"string"},"example":1667751},"paramStartDate":{"in":"query","name":"startDate","description":"Date representing the start date of a range of dates. Must be in YYYY-MM-DD, YYYY-MM, or YYYY format and must be in the same format as endDate parameter, if one is provided.\nOnly ancestors with levelOfDescription as 'series' will have their date fields searched.\n\nSearches the following date fields:\n* record.productionDates.logicalDate\n* record.copyrightDates.logicalDate\n* record.releaseDates.logicalDate\n* record.broadcastDates.logicalDate\n* record.coverageStartDate.logicalDate\n* record.coverageEndDate.logicalDate\n* record.inclusiveStartDate.logicalDate\n* record.inclusiveEndDate.logicalDate\n* record.ancestors.inclusiveStartDate.logicalDate\n* record.ancestors.inclusiveEndDate.logicalDate\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"1920-01-01"},"paramEndDate":{"in":"query","name":"endDate","description":"Date representing the end date of a range of dates. Must be in YYYY-MM-DD, YYYY-MM, or YYYY format and must be in the same format as startDate parameter, if one is provided.\nOnly ancestors with levelOfDescription as 'series' will have their date fields searched.\n\nSearches the following date fields:\n* record.productionDates.logicalDate\n* record.copyrightDates.logicalDate\n* record.releaseDates.logicalDate\n* record.broadcastDates.logicalDate\n* record.coverageStartDate.logicalDate\n* record.coverageEndDate.logicalDate\n* record.inclusiveStartDate.logicalDate\n* record.inclusiveEndDate.logicalDate\n* record.ancestors.inclusiveStartDate.logicalDate\n* record.ancestors.inclusiveEndDate.logicalDate\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"2022-10-06"},"paramExactDate":{"in":"query","name":"exactDate","description":"A single date. Must be in YYYY-MM-DD format.  Cannot be used with other date search parameters.  Used to search for records with dates that match exactly or that match the year and month but do not have a day\nOnly ancestors with levelOfDescription as 'series' will have their date fields searched.\n\nSearches the following date fields:\n* record.productionDates\n* record.copyrightDates\n* record.releaseDates\n* record.broadcastDates\n* record.coverageStartDate\n* record.coverageEndDate\n* record.inclusiveStartDate\n* record.inclusiveEndDate\n* record.ancestors.inclusiveStartDate\n* record.ancestors.inclusiveEndDate\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"2022-10-06"},"paramFieldExists":{"in":"query","name":"fieldName_exists","description":"A parameter specifying any field name in the form of [fieldName]_exists where, when equal to true, returns results where that field exists with non-null data. If false, returns results where the field does not exist. Accepts nested fields at any level, for example `ancestors.inclusiveEndDate_exists=true`","required":false,"schema":{"maximum":1024,"type":"boolean"},"example":"levelOfDescription_exists=true"},"paramExcludeField":{"in":"query","name":"fieldName_is_not","description":"A parameter specifying any field name in the form of [fieldName]_is_not where, when equal to the given value, will be excluded from the search results. Including nonexistent/invalid fields will return an appropriate error response.","required":false,"schema":{"maximum":1024,"type":"string"},"example":"title_is_not=1974%20Ottawa%20NWR"},"paramContributionsExist":{"in":"query","name":"contributions_exist","description":"When equal to true, returns results which have contributions. If false, returns results which do not have any contributions.","required":false,"schema":{"type":"boolean"}},"paramTagsExist":{"in":"query","name":"tags_exist","description":"When equal to true, returns results which have tags. If false, returns results which do not have any tags.","required":false,"schema":{"type":"boolean"}},"paramTranscriptionsExist":{"in":"query","name":"transcriptions_exist","description":"When equal to true, returns results which have transcriptions. If false, returns results which do not have any transcriptions.","required":false,"schema":{"type":"boolean"}},"paramCommentsExist":{"in":"query","name":"comments_exist","description":"When equal to true, returns results which have comments. If false, returns results which do not have any comments.","required":false,"schema":{"type":"boolean"}},"paramRecurringDateDay":{"in":"query","name":"recurringDateDay","description":"A day in DD format. Often used with recurringDateMonth. Used to search for records with date fields that match the day, regardless of the year.\nOnly ancestors with levelOfDescription as 'series' will have their date fields searched.\n\nSearches the following date fields:\n* record.productionDates.day\n* record.copyrightDates.day\n* record.releaseDates.day\n* record.broadcastDates.day\n* record.coverageStartDate.day\n* record.coverageEndDate.day\n* record.inclusiveStartDate.day\n* record.inclusiveEndDate.day\n* record.ancestors.inclusiveStartDate.day\n* record.ancestors.inclusiveEndDate.day\n","required":false,"schema":{"maximum":100,"type":"string"},"example":31},"paramRecurringDateMonth":{"in":"query","name":"recurringDateMonth","description":"A month in MM format. Often used with recurringDateDay. Used to search for recorrds with date fields that match the month, regardless of the year.\nOnly ancestors with levelOfDescription as 'series' will have their date fields searched.\n\nSearches the following date fields\n* record.productionDates.month\n* record.copyrightDates.month\n* record.releaseDates.month\n* record.broadcastDates.month\n* record.coverageStartDate.month\n* record.coverageEndDate.month\n* record.inclusiveStartDate.month\n* record.inclusiveEndDate.month\n* record.ancestors.inclusiveStartDate.month\n* record.ancestors.inclusiveEndDate.month\n","required":false,"schema":{"maximum":100,"type":"string"},"example":12},"paramBeginCongress":{"in":"query","name":"beginCongress","description":"Filters search results to just those from this congress or later. Based on `record.beginCongress` field.","required":false,"schema":{"maximum":4,"type":"integer"},"example":2},"paramEndCongress":{"in":"query","name":"endCongress","description":"Filters search results to just those from this congress or earlier. Based on `record.endCongress` field.","required":false,"schema":{"maximum":4,"type":"integer"},"example":100},"paramCongressNumber":{"in":"query","name":"congressNumber","description":"Filters search results to whose range of congresses includes this value. Based on `record.beginCongress` and `record.endCongress`. Cannot be used with other congress parameters.","required":false,"schema":{"maximum":4,"type":"integer"},"example":55},"paramTagContribution":{"in":"query","name":"tagContribution","description":"A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (\"\") and searches for a tag contribution.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"spacecraft test","summary":"Simple keyword","description":"Returns results which contain one or more contributions with the words spacecraft, test. Note that the boolean operator AND is used by default."},"bool":{"value":"spacecraft NOT test","summary":"Boolean operators","description":"Returns results which contain one or more contributions with the word spacecraft but do not contain the word test."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns results which contain one or more contributions with the words \"spacecraft\" and \"test\" together."},"stemming":{"value":"space*","summary":"Stemming with wildcards","description":"Returns results which contain one or more contributions with variations of the word \"space\", such as \"spacecraft\" and \"spaces\"."}}},"paramCommentContribution":{"in":"query","name":"commentContribution","description":"A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (\"\") and searches for a comment contribution.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"spacecraft test","summary":"Simple keyword","description":"Returns results which contain one or more contributions with the words spacecraft, test. Note that the boolean operator AND is used by default."},"bool":{"value":"spacecraft NOT test","summary":"Boolean operators","description":"Returns results which contain one or more contributions with the word spacecraft but do not contain the word test."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns results which contain one or more contributions with the words \"spacecraft\" and \"test\" together."},"stemming":{"value":"space*","summary":"Stemming with wildcards","description":"Returns results which contain one or more contributions with variations of the word \"space\", such as \"spacecraft\" and \"spaces\"."}}},"paramTranscriptionContribution":{"in":"query","name":"transcriptionContribution","description":"A search query string which accepts boolean operators (AND, OR, NOT), wildcards (*), and exact phrases (\"\") and searches for a transcription contribution.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"spacecraft test","summary":"Simple keyword","description":"Returns results which contain one or more contributions with the words spacecraft, test. Note that the boolean operator AND is used by default."},"bool":{"value":"spacecraft NOT test","summary":"Boolean operators","description":"Returns results which contain one or more contributions with the word spacecraft but do not contain the word test."},"exact":{"value":"United States","summary":"Exact phrase","description":"Returns results which contain one or more contributions with the words \"spacecraft\" and \"test\" together."},"stemming":{"value":"space*","summary":"Stemming with wildcards","description":"Returns results which contain one or more contributions with variations of the word \"space\", such as \"spacecraft\" and \"spaces\"."}}},"paramExtractedTextContribution":{"in":"query","name":"extractedTextContribution","description":"A contribution search string used to search for a record. Matches the otherExtractedText.contribution or extractedText fields within digitalObjects.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"United States Constitution","summary":"Simple keyword","description":"Returns results which contain United, States, and Constitution within the title. Note that the boolean operator AND is used by default."}}},"paramOtherExtractedTextContribution":{"in":"query","name":"otherExtractedTextContribution","description":"A contribution search string used to search for a record. Matches the otherExtractedText.contribution or extractedText fields within digitalObjects.","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"United States Constitution","summary":"Simple keyword","description":"Returns results which contain United, States, and Constitution within the title. Note that the boolean operator AND is used by default."}}},"paramIncludeExtractedText":{"in":"query","name":"includeExtractedText","description":"Allows for the inclusion of OCR text extracted from the digital object in `record.digitalObjects.extractedText` to be included in the response if any exists. Defaults to false.","required":false,"schema":{"maximum":100,"type":"boolean"},"example":true},"paramIngestTimeStart":{"in":"query","name":"ingestTimeStart","description":"The ingestTimeStart parameter specifies the date or timestamp for fetching data.\n\nDate only format: YYYY-MM-DD\n    When provided in this format, the time defaults to 00:00:00.000000.\n    Example: 2025-01-13 → interpreted as 2025-01-13 00:00:00.000000\n\n Full timestamp format: YYYY-MM-DD HH:mm:ss.SSSSSS\n     When provided in this format, data will be fetched for the exact timestamp specified.\n     Example: 2025-01-13 14:30:15.123456 → data fetched at this precise datetime\n\nBehavior:\n   If both ingestTimeStart and ingestTimeEnd are provided, description records within that date/time range are retrieved.\n   If only ingestTimeStart is provided, description records on and after that date/time are retrieved.\n   If only ingestTimeEnd is provided, description records on and before that date/time are retrieved.\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"2025-01-13"},"paramIngestTimeEnd":{"in":"query","name":"ingestTimeEnd","description":"The ingestTimeEnd parameter specifies the date or timestamp for fetching data.\n\nDate only format: YYYY-MM-DD\n    When provided in this format, the time defaults to 23:59:59.999999\n    Example: 2025-01-13 → interpreted as 2025-01-13 23:59:59.999999\n\n Full timestamp format: YYYY-MM-DD HH:mm:ss.SSSSSS\n     When provided in this format, data will be fetched for the exact timestamp specified.\n     Example: 2025-01-13 14:30:15.123456 → data fetched at this precise datetime\n\nBehavior:\n   If both ingestTimeStart and ingestTimeEnd are provided, description records within that date/time range are retrieved.\n   If only ingestTimeStart is provided, description records on and after that date/time are retrieved.\n   If only ingestTimeEnd is provided, description records on and before that date/time are retrieved.\n","required":false,"schema":{"maximum":100,"type":"string"},"example":"2025-01-13"},"paramIncludeOtherExtractedText":{"in":"query","name":"includeOtherExtractedText","description":"Allows for the inclusion of other extracted text contributed by NARA partners in `record.digitalObjects.otherExtractedText` to be included in the response if any exists. Defaults to false.","required":false,"schema":{"maximum":100,"type":"boolean"},"example":true},"paramIncludeTotalCount":{"in":"query","name":"includeTotalCount","description":"Returns the total count of results in each result.","required":false,"schema":{"maximum":100,"type":"boolean"},"example":true},"paramSearchAfterRecord":{"in":"query","name":"searchAfter","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","required":false,"schema":{"maximum":100,"type":"integer"},"example":12345},"paramSearchAfterContribution":{"in":"query","name":"searchAfter","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","required":false,"schema":{"maximum":100,"type":"string"},"example":"55555555-5555-5555-5555-555555555555"},"paramSourceIncludes":{"in":"query","name":"sourceIncludes","description":"Limits the response by specifying which fields from `_source.record` should be included in the response.","required":false,"schema":{"type":"string"},"example":"naId,title,digitalObjects.objectUrl"},"paramOETQuery":{"in":"query","name":"q","description":"A search query string which accepts exact phrases or similar matches (\"\").","required":false,"schema":{"maximum":1024,"type":"string"},"examples":{"simple":{"value":"we the people","summary":"Simple keyword","description":"Returns results which contain one or more contributions with the words we, the, and people."}}}}},"tags":[{"name":"Records","description":"Record description search and data retrieval"},{"name":"Contributions","description":"Contribution search and data retrieval; Contributions include Tags, Transcriptions, and Comments - search/retrieve contributions when you want to return any contribution type."},{"name":"Tags","description":"Tag search and data retrieval"},{"name":"Transcriptions","description":"Transcription search and data retrieval"},{"name":"Comments","description":"Comment search and data retrieval"},{"name":"Online Availability","description":"Information about record online availability"},{"name":"Announcements","description":"For important announcements"}]}