Wise API Release notes 8.0.2

Laatst bijgewerkt op
Als PDF opslaan

Wise API v8.0.2

This update includes new features, performance improvements, and bug fixes to enhance your experience. This document contains some highlights of key changes, a list of deprecated endpoints, and a full changelog of the Wise API.

Deprecation strategy

From Wise version 8.0.2 we’ll be following a better documented deprecation process. During the API release notes we’ll be sharing a list of endpoints, fields, and transfer objects that are marked as deprecated. When one of these is marked as deprecated, they are to be removed after two full release cycles. A second reminder will follow in the next release notes. During this deprecation window, the deprecated endpoint/field will receive full support, and if applicable, both the deprecated as the replacement version are available.

IP allow-listing removed for certain endpoints (ATIW-7527)

We’ve removed the allow-listing requirement for the following domains:

Discovery
Metadata
Myaccount

If you rely on authenticating via allow-listing for any endpoint within these domains, please use the /login endpoint instead.

Deprecation in 8.0.2 (to be removed in 8.0.4)

In this section we’ll cover all the deprecation in the Wise API. This deprecation knows three different areas: endpoints, fields, and transfer objects. A lot of these endpoints were already marked as deprecated but will receive two more versions of support until they will be removed in Wise version 8.0.4.

Endpoints:

Endpoint	Note
GET /campaign/{campaignId}
GET /collection/booking
GET /collection/plannable-topic
GET /collection/plannable-topic/{topicCode}/booking
POST /collection/plannable-topic/{topicCode}/booking
GET /dgc/{dgcId}/set/{profileId}	Use endpoint /titlelist/tac/{tacId}/profile/{profileId} instead
POST /econtent/library/{libraryId}/patron/{patronSystemId}/title/{titleId}/formats
POST /logon-at-session/{sessionId}	Use endpoint `/login` instead
POST /patron/delegate
PUT /patron/delegate/{delegateId}/annulment
PUT /patron/delegate/{delegateId}/annulment/cancel
PUT /patron/delegate/{delegateId}/annulment/confirm
PUT /patron/delegate/{delegateId}/cancel
PUT /patron/delegate/{delegateId}/confirm
GET /patron/delegated
GET /patron/delegatedby
GET /patron/external/library/{libraryId}	Use endpoint /library/{libraryId}/externalpatron instead
POST /patron/{patronSystemId}/item/{itemIds}/loanrenewal	Use endpoint /patron/{patronSystemId}/library/{libraryId}/loan instead
POST /patron/{patronSystemId}/library/{libraryId}/hold	Use endpoint /patron/{patronSystemId}/hold instead
GET /patron/{patronSystemId}/membership	Use endpoint /patron/{patronSystemId}/subscription instead G
GET /patron/{patronSystemId}/title/{titleId}/review	Use endpoint /cwise/title/{titleId}/review instead
GET /patronmanagement/library/{libraryId}/patronduplicate	Use POST endpoint instead
GET /title/availability/branch/{branch}/idtype/{idType}/ids/{titles}/branchcatgrps/{branchCatGrps}/sid/{sid}
GET /title/{titleId}/myrating	Use endpoint /cwise/title/{titleId}/rating instead
POST /title/{titleId}/myrating	Use endpoint /cwise/title/{titleId}/rating instead
PUT /title/{titleId}/myrating	Use endpoint /cwise/title/{titleId}/rating instead
GET /title/{titleId}/rating	Use endpoint /cwise/title/{titleId}/rating instead
GET /title/{titleId}/review	Use endpoint /cwise/title/{titleId}/review instead
POST /title/{titleId}/review	Use endpoint /cwise/title/{titleId}/review instead
DELETE /title/{titleId}/review/{reviewId}	Use endpoint /cwise/title/{titleId}/review instead
PUT /title/{titleId}/review/{reviewId}	Use endpoint /cwise/title/{titleId}/review instead
GET /title/{titleId}/tag	Use endpoint /cwise/title/{titleId}/tag instead
POST /title/{titleId}/tag	Use endpoint /cwise/title/{titleId}/tag instead
DELETE /title/{titleId}/tag/{tagId}	Use endpoint /cwise/title/{titleId}/tag instead
GET /user/{userId}/about
GET /user/{userId}/review
GET /user/{userId}/tag	Use endpoint /cwise/user/{cwiseUserId}/tag instead
POST /user/{userId}/tag	Use endpoint /wise/title/{titleId}/tag instead
DELETE /user/{userId}/tag/{tagId}	Use endpoint /wise/title/{titleId}/tag/{tagId} instead.
GET /user/{userId}/uuid

Parameters

Endpoint	Deprecated Parameter	Note
/patronmanagement/patron/library/{libraryId}/updatedpatron	date	Use query parameter `since` instead.
/patronmanagement/patron/library/{libraryId}/deletedpatron	date	Use query parameter `since` instead.
/circulation/customercheckoutdetails/{patronSystemId}	doChecks	Use query parameter `performWithConfirmation` instead.
/circulation/loan/{loanId}	action	Use query parameter `performWithConfirmation` instead.

Transfer Objects

Schema Name	Field Name	Note
NewsletterSubscriptionTO	startDatum	Replaced by `startDate`
NewsletterSubscriptionTO	eindDatum	Replaced by `endDate`
LibraryCardTO	type
PatronInformationTO	membershipExpirationDate	Collect subscription information via endpoint /patron/{patronSystemId}/subscription The expiry date of the membership of the patron
PatronInformationTO	preferredLanguage	Collect subscription information via endpoint /patron/{patronSystemId}/subscription Preferred language of the patron
PatronInformationTO	membershipDescription	Collect subscription information via endpoint /patron/{patronSystemId}/subscription
Credentials	wiseRollen	No description
PatronAuthenticationTO	patronId	Use username instead. Authentication-id of the patron (not the technical id). Mandatory in request if there is no username
CirculationLoanResponseTO	notificationNumber	Replaced by `notifications` Notification number
CirculationLoanResponseTO	notificationText	Replaced by `notifications` Text corresponding to notification number
CirculationLoanResponseTO	remarks	Replaced by `notifications` Messages containing information regarding action
CirculationLoanResponseTO	resultCode	Replaced by `performedCirculationActionStatus` Result code which influences further actions
CirculationLoanRequestTO	actionCode	Use query parameter `performWithConfirmation` instead. When `actionCode` has value `1`, this end-point behaves as if `performWithConfirmation` has value `true`. Otherwise this end-point behaves as if `performWithConfirmation` has value `false`.
EnrichedItemInformationTO	library	The id of the library.
PatronManagementLoanedItemTO	itemRenewable	Replaced by `numberOfRenewalsAllowed > 0`. To check whether an item is eligible to renew
HoldInformationTO	magILL	Use isIllAllowed field instead
PatronNoticeTO	noticeLine2	All notices are provided in noticeLine1 as separate notices.
PatronNoticeTO	noticeLine3	All notices are provided in noticeLine1 as separate notices.
PatronNoticeTO	noticeLine4	All notices are provided in noticeLine1 as separate notices.
PatronLoanedItemTO	bibliographicRecordId	Replaced by `titleId`
PatronLoanedItemTO	branchId	Replaced by `loanBranchId`
PatronLoanedItemTO	costOfRenewal	Replaced by `renewalCosts` `costOfRenewal` = `renewalCosts.lendingFee` + `renewalCosts.renewalFee` + `renewalCosts.exceedMaxLoanedItemsFee` + `renewalCosts.holdFee`.
PatronLoanedItemTO	fine	Replaced by `renewalCosts.overdueFine`
PatronLoanedItemTO	itemRenewable	Replaced by `canBeRenewed`
PatronLoanedItemTO	medium	Replaced by `materialTypeCode`
PatronLoanedItemTO	message	Deprecated. Use `nokNotification` instead.
PatronLoanedItemTO	messageCode	Replaced by `nokNotification.number`
PatronLoanedItemTO	messageParameters	Deprecated. Use `nokNotification` instead.
PatronLoanedItemTO	notificationNr	Replaced by `nokNotification.number`
PatronLoanedItemTO	notificationText	Replaced by `nokNotification.text`
PatronHoldResultTO	success	Always true regardless of result; check HTTP response status code for success
MetadataResultTO	success	Always true regardless of result; check HTTP response status code for success
TitleTO	shelfLocation	Replaced by 'signature' Shelf location. Deprecated because there could be multiple values.
CirculationPatronBasicsResponseTO	resultCode	Replaced by `checkoutDetailsResult` Result code which influences further actions (OK (0), NOK_OVERRULABLE_MESSAGES (1), NOK (2) (all other problems), NOK_MULTIPLE_ACTORS_SAME_CARD (3))
CirculationPatronBasicsResponseTO	serviceDeskNotification	Replaced by `notifications` Patron related service desk message
CirculationPatronBasicsResponseTO	remarks	Replaced by `notifications` Remarks and questions for the user

API Changelog

Please refer to: https://oclc.hostedwise.nl/restapi/swagger-ui/index.html for detailed information regarding endpoints.

Legend:

🆕 = New endpoint available from version 8.0.2

⚠ = Potential change to an existing endpoint which could cause an implementation to break

GET /branch

• added the new enum value ‘PPL’ to the ‘query’ request parameter ‘branchGroupType’

GET /branch/{branchId}/perspective/{perspectiveId}/titlesummary

• added the new optional ‘query’ request parameter ‘filterAvailableTitles’

GET /circulation/loan

• ⚠ added the new ‘HOLD_DECISION’ enum value to the ‘/items/circulationResult’ response property for the response status ‘200’

• added the optional property ‘/items/holdCustomerBarcode’ to the response with the ‘200’ status

• added the optional property ‘/items/holdCustomerPreferredName’ to the response with the ‘200’ status

• added the optional property ‘/items/holdPlacedDate’ to the response with the ‘200’ status

• added the optional property ‘/items/message’ to the response with the ‘200’ status

• added the optional property ‘/items/messagedDate’ to the response with the ‘200’ status

• added the optional property ‘/items/telephoneNumber’ to the response with the ‘200’ status

POST /circulation/loan

• ⚠ added the new ‘HOLD_DECISION’ enum value to the ‘circulationResult’ response property for the response status ‘200’

• added the optional property ‘holdCustomerBarcode’ to the response with the ‘200’ status

• added the optional property ‘holdCustomerPreferredName’ to the response with the ‘200’ status

• added the optional property ‘holdPlacedDate’ to the response with the ‘200’ status

• added the optional property ‘message’ to the response with the ‘200’ status

• added the optional property ‘messagedDate’ to the response with the ‘200’ status

• added the optional property ‘telephoneNumber’ to the response with the ‘200’ status

GET /cwise/title/{cwiseTitleId}/rating

• the response optional property ‘resourceLink’ became not read-only for the status ‘200’

GET /discovery/author/{thesaurusNumber}/recommended/title

• added the optional property ‘items/items/childTitleIds’ to the response with the ‘200’ status

GET /discovery/title/{titleId}

• added the optional property ‘childTitleIds’ to the response with the ‘200’ status

GET /infopoint/{profileId}/full

• api tag ‘Items’ added

• added the optional property ‘shelfs/items/items/items/childTitleIds’ to the response with the ‘200’ status

GET /item

• api tag ‘Items’ added

• the response property ‘/items/originBranch’ became required for the status ‘200’

• the response property ‘/items/placementBranch’ became required for the status ‘200’

• the ‘/items/copyNumber’ response’s property pattern ‘^’ was added for the status ‘200’

GET /item/{itemIds}

• api tag ‘Items’ added

• the response property ‘/items/originBranch’ became required for the status ‘200’

• the response property ‘/items/placementBranch’ became required for the status ‘200’

• the ‘/items/copyNumber’ response’s property pattern ‘^’ was added for the status ‘200’

PUT /item/{itemId}/availability

• ⚠ added the new ‘SOMEWHERE_ELSE’ enum value to the ‘availabilityStatus’ response property for the response status ‘200’

• ⚠ added the new ‘UNKNOWN_STATUS’ enum value to the ‘availabilityStatus’ response property for the response status ‘200’

• api tag ‘Items’ added

• added the new ‘SOMEWHERE_ELSE’ enum value to the request property ‘availabilityStatus’

• added the new ‘UNKNOWN_STATUS’ enum value to the request property ‘availabilityStatus’

GET /library/{libraryId}/patron

• added the new enum value ‘ADDRESSLINE1_ASC’ to the ‘query’ request parameter ‘orderBy’

• added the new enum value ‘ADDRESSLINE1_DESC’ to the ‘query’ request parameter ‘orderBy’

• added the optional property ‘customers/items/addressLine1’ to the response with the ‘200’ status

• added the optional property ‘customers/items/addressLine2’ to the response with the ‘200’ status

POST /library/{libraryId}/patron

• added the new optional request property ‘bccEmailAddresses’

• added the new optional request property ‘preferredPickupLocation’

• added the optional property ‘bccEmailAddresses’ to the response with the ‘201’ status

• added the optional property ‘preferredPickupLocation’ to the response with the ‘201’ status

GET /library/{libraryId}/patron/{patronSystemId}

• added the optional property ‘bccEmailAddresses’ to the response with the ‘200’ status

• added the optional property ‘preferredPickupLocation’ to the response with the ‘200’ status

PUT /library/{libraryId}/patron/{patronSystemId}

• added the new optional request property ‘bccEmailAddresses’

• added the new optional request property ‘preferredPickupLocation’

• added the optional property ‘bccEmailAddresses’ to the response with the ‘200’ status

• added the optional property ‘preferredPickupLocation’ to the response with the ‘200’ status

POST /patron/{patronSystemId}/hold

• ⚠ added the new ‘TOTAL_COUNT’ enum value to the ‘holdType’ response property for the response status ‘200’

• api operation id ‘placeHold_1’ removed and replaced with ‘placeHold’

• added the new ‘TOTAL_COUNT’ enum value to the request property ‘holdType’

• added the non-success response with the status ‘409’

GET /patron/{patronSystemId}/library/{libraryId}/hold

• added the new enum value ‘TOTAL_COUNT’ to the ‘query’ request parameter ‘reservationType’

• added the optional property ‘items/items/titleSummary/childTitleIds’ to the response with the ‘200’ status

POST /patron/{patronSystemId}/library/{libraryId}/hold

• api operation id ‘placeHold’ removed and replaced with ‘placeHold_2’

GET /patron/{patronSystemId}/library/{libraryId}/message

• ⚠ api path removed without deprecation

GET /patron/{patronSystemId}/library/{libraryId}/message/{messageId}

• ⚠ api path removed without deprecation

GET /patron/{patronSystemId}/library/{libraryId}/patroninformation

• endpoint reactivated

• added the optional property ‘bccEmailAddresses’ to the response with the ‘200’ status

• added the optional property ‘preferredPickupLocation’ to the response with the ‘200’ status

PUT /patron/{patronSystemId}/library/{libraryId}/patroninformation

• endpoint reactivated

• added the new optional request property ‘bccEmailAddresses’

• added the new optional request property ‘preferredPickupLocation’

• added the optional property ‘bccEmailAddresses’ to the response with the ‘200’ status

• added the optional property ‘preferredPickupLocation’ to the response with the ‘200’ status

POST /patronmanagement/duplicate

• api operation id ‘getDuplicatePatrons’ removed and replaced with ‘getDuplicatePatrons_1’

GET /redirect/{branchId}/titleredirect/{ppnString}

• ⚠ added ‘#/components/schemas/DefaultHttpStatusCode, #/components/schemas/HttpStatus’ to the ‘status’ response property ‘oneOf’ list for the response status ‘302’

• ⚠ removed the optional property ‘status/error’ from the response with the ‘302’ status

• ⚠ removed the optional property ‘status/is1xxInformational’ from the response with the ‘302’ status

• ⚠ removed the optional property ‘status/is2xxSuccessful’ from the response with the ‘302’ status

• ⚠ removed the optional property ‘status/is3xxRedirection’ from the response with the ‘302’ status

• ⚠ removed the optional property ‘status/is4xxClientError’ from the response with the ‘302’ status

• ⚠ removed the optional property ‘status/is5xxServerError’ from the response with the ‘302’ status

GET /title/{titleId}/iteminformation

• api tag ‘Items’ added

• added the optional property ‘/items/groupLabelDescription’ to the response with the ‘200’ status

GET /branch/{branchId}/searchsuggestion

• 🆕 endpoint added

GET /education/branch/{branchId}/patron