FBI API 🥳

GraphQL Schema [changes]

Here, you will find a detailed type comparison between the current and future versions of the FBI-API. If you're looking for the complete future schema, you can find it here.

So, what's actually changed?

Unused scalar types have been removed from the schema.
All current and previously deprecated fields have been removed.
All types are now written in PascalCase.
All enum value fields are now written in UPPERCASE.
All field names are now unique regardless of casing.
All input types now have the suffix 'Input'.
All scalar types now have the suffix 'Scalar'.
All union types now have the suffix 'Union'.
All interface types now have the suffix 'Interface'.

Reduce changelog

Typenames used solely as internal references are marked with strikethrough by default. To view the full changelog without any strikethrough lines, you can disable this option here.

✔ Enabled

Deprecated fields that were removed. The type/field after the arrow refer to alternative options.

SortOrder.asc ➡️ SortOrderEnum.ASC
SortOrder.desc ➡️ SortOrderEnum.DESC
ComplexSearchResponse.solrQuery was removed
ComplexSearchResponse.solrFilter was removed
ComplexSearchResponse.tokenizerDurationInMs was removed
ComplexSearchResponse.solrExecutionDurationInMs was removed
Branch.userIsBlocked was removed
Mutation.submitPeriodicaArticleOrder ➡️ Elba.placeCopyRequest
Fields affected due to the above field deprecation
- PeriodicaArticleOrder.pid ➡️ CopyRequestInput.pid
- PeriodicaArticleOrder.pickUpBranch ➡️ CopyRequestInput.pickUpAgencySubdivision
- PeriodicaArticleOrder.userName ➡️ CopyRequestInput.userName
- PeriodicaArticleOrder.userMail ➡️ CopyRequestInput.userMail
- PeriodicaArticleOrder.publicationDateOfComponent ➡️ CopyRequestInput.publicationDateOfComponent
- PeriodicaArticleOrder.volume ➡️ CopyRequestInput.volumeOfComponent
- PeriodicaArticleOrder.authorOfComponent ➡️ CopyRequestInput.authorOfComponent
- PeriodicaArticleOrder.titleOfComponent ➡️ CopyRequestInput.titleOfComponent
- PeriodicaArticleOrder.pagination ➡️ CopyRequestInput.pagesOfComponent
- PeriodicaArticleOrderResponse.status ➡️ CopyRequestResponse.status
- PeriodicaArticleOrderStatus.OK ➡️ CopyRequestStatusEnum.OK
- PeriodicaArticleOrderStatus.ERROR_UNAUTHORIZED_USER ➡️ CopyRequestStatusEnum.ERROR_UNAUTHENTICATED_USER
- PeriodicaArticleOrderStatus.ERROR_AGENCY_NOT_SUBSCRIBED ➡️ CopyRequestStatusEnum.ERROR_AGENCY_NOT_SUBSCRIBED
- PeriodicaArticleOrderStatus.ERROR_INVALID_PICKUP_BRANCH ➡️ CopyRequestStatusEnum.ERROR_INVALID_PICKUP_BRANCH
- PeriodicaArticleOrderStatus.ERROR_PID_NOT_RESERVABLE ➡️ CopyRequestStatusEnum.ERROR_PID_NOT_RESERVABLE
- PeriodicaArticleOrderStatus.ERROR_NO_NAME_OR_EMAIL ➡️ CopyRequestStatusEnum.UNKNOWN_USER
BibliotekDkOrder.closed was removed
BibliotekDkOrder.autoForwardResult was removed
BibliotekDkOrder.placeOnHold was removed
BibliotekDkOrder.pickupAgencyId was removed
BibliotekDkOrder.pid was removed
BibliotekDkOrder.pidOfPrimaryObject ➡️ Work.workId
BibliotekDkOrder.author ➡️ Work.creators
BibliotekDkOrder.title ➡️ Work.title
BibliotekDkOrder.errorMessage was removed
AccessTypeCode.NOT_SPECIFIED was removed
Manifestation.physicalDescriptions ➡️ Manifestation.physicalDescription
Fields affected due to the above field deprecation
- PhysicalDescription.summary ➡️ UnitDescription.summary
- PhysicalDescription.accompanyingMaterial ➡️ PhysicalUnitDescription.accompanyingMaterial
- PhysicalDescription.additionalDescription ➡️ UnitDescription.additionalDescription
- PhysicalDescription.extent ➡️ UnitDescription.extent
- PhysicalDescription.numberOfPages ➡️ PhysicalUnitDescription.numberOfPages
- PhysicalDescription.numberOfUnits ➡️ PhysicalUnitDescription.materialUnits
- PhysicalDescription.playingTime ➡️ UnitDescription.extent
- PhysicalDescription.requirements ➡️ Note.display type TECHNICAL_REQUIREMENTS
- PhysicalDescription.size ➡️ UnitDescription.size
- PhysicalDescription.technicalInformation ➡️ UnitDescription.technicalInformation
- PhysicalDescription.textVsIllustrations ➡️ LevelForAudience.illustrationsLevel
Manifestation.universe ➡️ Manifestation.universes
Series.numberInSeries ➡️ Series.numberInSeries String
MaterialType.general ➡️ MaterialType.materialTypeGeneral
MaterialType.specific ➡️ MaterialType.materialTypeSpecific
Work.seriesMembers ➡️ Work.series
Work.universe ➡️ Work.universes

Enum types whose VALUES were changed from lowercase to UPPERCASE.

ComplexSuggestionType.values ➡️ ComplexSuggestionTypeEnum.VALUES UPPERCASED
FacetField.values ➡️ FacetFieldEnum.VALUES UPPERCASED
CategoryFilters.values ➡️ CategoryFiltersEnum.VALUES UPPERCASED
FeedbackThumb.values ➡️ FeedbackThumbEnum.VALUES UPPERCASED
LanguageCode.values ➡️ LanguageCodeEnum.VALUES UPPERCASED
VipUserParameter.values ➡️ VipUserParameterEnum.VALUES UPPERCASED
MoodSuggest.values ➡️ MoodSuggestEnum.VALUES UPPERCASED
HoldingsStatus.values ➡️ HoldingsStatusEnum.VALUES UPPERCASED
BookMarkOrderBy.values ➡️ BookMarkOrderByEnum.VALUES UPPERCASED

Types that were changed to PascalCase.

localSuggestResponse ➡️ LocalSuggestResponse
holdingAgency ➡️ HoldingAgency
moodQueries ➡️ MoodQueries

Types that were renamed and changed to PascalCase.

complexSearchFacets ➡️ ComplexSearchFacetsInput
holdingsItem ➡️ LocalizationsHoldingsItem
moodSuggestResponse ➡️ MoodSuggestItem
BookmarkResponse ➡️ AddBookMarkResponse

Input types that have had the suffix 'Input' added.

complexSearchFacets ➡️ ComplexSearchFacetsInput
ComplexSearchFilters ➡️ ComplexSearchFiltersInput
Sort ➡️ SortInput
CreateAccountTokens ➡️ CreateAccountTokensInput
DataCollectSearchRequest ➡️ DataCollectSearchRequestInput
CategoryFilter ➡️ CategoryFilterInput
KidRecommenderTags ➡️ KidRecommenderTagsInput
MoodKidsRecommendFilters ➡️ MoodKidsRecommendFiltersInput
SubmitOrderUserParameters ➡️ SubmitOrderUserParametersInput
Material ➡️ MaterialInput
PeriodicaArticleOrder was removed
SearchQuery ➡️ SearchQueryInput

Scalar types that have had the suffix 'Scalar' added.

PaginationLimit ➡️ PaginationLimitScalar
CustomDateFormat was removed

Interface types that have had the suffix 'Interface' added.

Creator ➡️ CreatorInterface
Subject ➡️ SubjectInterface

Union types that have had the suffix 'Union' added.

UniverseContent ➡️ UniverseContentUnion
Access ➡️ AccessUnion

Enum types that have had the suffix 'Enum' added.

OrderPossibleReason ➡️ OrderPossibleReasonEnum
SortOrder ➡️ SortOrderEnum
GetAccountsType ➡️ GetAccountsTypeEnum
CreateAccountStatus ➡️ CreateAccountStatusEnum
DeleteAccountStatus ➡️ DeleteAccountStatusEnum
ComplexSearchFacets ➡️ ComplexSearchFacetsEnum
HoldingsResponseStatus ➡️ HoldingsResponseStatusEnum
AccessTypeCode ➡️ AccessTypeCodeEnum
AccessUrlType ➡️ AccessUrlTypeEnum
LinkStatus ➡️ LinkStatusEnum
SubjectType ➡️ SubjectTypeEnum
SuggestionType ➡️ SuggestionTypeEnum
ComplexSuggestionType ➡️ ComplexSuggestionTypeEnum
FictionNonfictionCode ➡️ FictionNonfictionCodeEnum
WorkType ➡️ WorkTypeEnum
CopyRequestStatus ➡️ CopyRequestStatusEnum
InfomediaError ➡️ InfomediaErrorEnum
AccessStatus was removed
NoteType ➡️ NoteTypeEnum
ChildOrAdultCode ➡️ ChildOrAdultCodeEnum
SchoolUseCode ➡️ SchoolUseCodeEnum
ManifestationPartType ➡️ ManifestationPartTypeEnum
IdentifierType ➡️ IdentifierTypeEnum
EntryType ➡️ EntryTypeEnum
GeneralMaterialTypeCode ➡️ GeneralMaterialTypeCodeEnum
ReviewElementType ➡️ ReviewElementTypeEnum
CategoryFilters ➡️ CategoryFiltersEnum
LanguageCode ➡️ LanguageCodeEnum
LibraryStatus ➡️ LibraryStatusEnum
VipUserParameter ➡️ VipUserParameterEnum
AgencyType ➡️ AgencyTypeEnum
LinkCheckStatus ➡️ LinkCheckStatusEnum
MoodSuggest ➡️ MoodSuggestEnum
SubmitOrderStatus ➡️ SubmitOrderStatusEnum
OrderType ➡️ OrderTypeEnum
MoodSearchFieldValues ➡️ MoodSearchFieldValuesEnum
FeedbackThumb ➡️ FeedbackThumbEnum
OrderStatus ➡️ OrderStatusEnum
BookMarkOrderBy ➡️ BookMarkOrderByEnum
HoldingsStatus ➡️ HoldingsStatusEnum
FacetField ➡️ FacetFieldEnum
PeriodicaArticleOrderStatus was removed

Other changes

"Nice to know" fields added