API Docs

Rest Partner

Overview

Resource Sharing Partners represent the system(s) that Alma communicates in order to supply Resource Sharing services.
A partner can be defined as one of the supported communication profiles: NCIP, ART_EMAIL, ISO, BLDSS, FULFILLMENT_NETWORK or EMAIL.

Data Dictionary

Click here to download rest_partner.xsd

partner

Description: Resource Sharing Partner Object.

Field	Type	Description
partner_details	partner_details	The partner's general details.
contact_info	contact_info	The partner's Contact information.
notes	notes	The partner's related notes.

 

partner_details

Description: The partner's general details.

Field	Type	Description
code	string	The partner's code. Mandatory. Must be unique for each partner. The partner's code cannot be changed in the PUT action.
name	string	The partner's name. Mandatory.
profile_details	profile_details	The partner's profile details. Mandatory.
status	status	The status of the partner. Mandatory. Possible values are:ACTIVE, INACTIVE.
system_type	string with attr.	The type of the partner's system. Mandatory. This field is used for information purposes only. Possible codes are listed in 'PartnerSystemTypes' code table. The valid values for this parameter are controlled by the code-table: PartnerSystemTypes. These are the currently defined values for your institution: Code Description
avg_supply_time	int	The average number of days that it takes the partner to supply the material. Mandatory.
delivery_delay	int	The delivery delay number of days. Optional.
currency	string	The partner's currency. Optional.
borrowing_supported	boolean	Information whether the partner sends borrowing requests to Alma.
borrowing_workflow	string	The partner's borrowing workflow. Relevant when borrowing_workflow is true.
lending_supported	boolean	Information whether the partner receives lending requests from Alma.
lending_workflow	string	The partner's lending workflow. Relevant when lending_workflow is true.
auto_cancel_supported	boolean	Whether the partner activates the auto cancel job.
auto_cancel_reason	string	The partner's cancel reason when activated from the auto cancel/claim job.
auto_cancel_time	int	The partner's delay time (in days) before automatically send cancellation request.
auto_claim_supported	boolean	Whether the partner activates the auto claim job.
auto_claim_time	int	The partner's delay time (in days) before automatically send claim request.
locate_profile	string with attr.	The partner's locate profile. Must match an existing locate profile.
institution_code	string	The institution to be searched as part of locate. Relevant if locate_profile is not empty.
holding_code	string	The library or campus to be searched as part of locate. Relevant if locate_profile is not empty.

 

profile_details

Description: The partner's profile details.

Field	Type	Description
profile_type	profile_type	The type of request/receive communication that takes place between Alma and a resource sharing system. Mandatory. Possible values are: NCIP, ART_EMAIL, ISO, ISO_18626, EMAIL, NCIP_P2P, SLNP, EXTERNAL_SYSTEM, BLDSS, FULFILLMENT_NETWORK, RAPID, INNREACH.
art_email_details	art_email_details	ARTEmail related details. Relevant and mandatory only if profile_type = ART_EMAIL.
ncip_details	ncip_details	NCIP related details. Relevant and mandatory only if profile_type = NCIP.
iso_details	iso_details	ISO related details. Relevant and mandatory only if profile_type = ISO.
iso_18626_details	iso_18626_details	ISO related details. Relevant and mandatory only if profile_type = ISO.
email_details	email_details	Email related details. Relevant and mandatory only if profile_type = EMAIL.
ncip_p2p_details	ncip_p2p_details	NCIP P2P related details. Relevant and mandatory only if profile_type = NCIP_P2P.
bldss_details	bldss_details	BLDSS related details. Relevant and mandatory only if profile_type = BLDSS.
fulfillment_network_details	fulfillment_network_details	fulfillment network related details. Relevant and mandatory only if profile_type = FULFILLMENT_NETWORK.
rapid_details	rapid_details	RapidILL related details. Relevant and mandatory only if profile_type = RAPID.
innreach_details	innreach_details	INN-Reach API related details. Relevant and mandatory only if profile_type = INNREACH.

 

art_email_details

Description: ARTEmail related details. Relevant and mandatory only if profile_type = ART_EMAIL.

Field	Type	Description
email_address	string	The email address to which the ARTEmail message will be sent. Mandatory.
alternative_document_delivery	boolean	Indication whether the ability to send requests to an alternate physical location or email address is supported. By default, it is not supported.
customer_ids	customer_ids	List of British Library customer IDs. At least one customer id should be defined.
keywords_service	keywords_service	List of British Library services that are supported. At least one service should be defined.
keywords_delivery	keywords_delivery	List of British Library delivery formats that are supported. Optional.
keywords_queries	keywords_queries	List of British Library query codes that are supported. Optional.

 

keywords_service

Description: List of British Library services that are supported. At least one service should be defined.

Field	Type	Description
service	string with attr.	The British Library relevant service. Possible codes are listed in 'ARTEmailServiceKeywords' code table. The valid values for this parameter are controlled by the code-table: ARTEmailServiceKeywords. These are the currently defined values for your institution: Code Description

 

keywords_delivery

Description: List of British Library delivery formats that are supported. Optional.

Field	Type	Description
delivery	string with attr.	The British Library relevant delivery format. Possible codes are listed in 'ARTEmailDeliveryKeywords' code table. The valid values for this parameter are controlled by the code-table: ARTEmailDeliveryKeywords. These are the currently defined values for your institution: Code Description

 

keywords_queries

Description: List of British Library query codes that are supported. Optional.

Field	Type	Description
queries	string with attr.	The British Library relevant query code. Possible codes are listed in 'ARTEmailQueriesKeywords' code table. The valid values for this parameter are controlled by the code-table: ARTEmailQueriesKeywords. These are the currently defined values for your institution: Code Description

 

customer_ids

Description: List of British Library customer IDs. At least one customer id should be defined.

Field	Type	Description
customer_id	customer_id	Specific customer id.

 

customer_id

Description: Specific customer id.

Field	Type	Description
code	string	The customer code. Mandatory.
password	string	The customer password. Mandatory.

 

ncip_details

Description: NCIP related details. Relevant and mandatory only if profile_type = NCIP.

Field	Type	Description
general_user_id_type	general_user_id_type
general_loan_period	string	The amount of time the user has before having to return the item to the resource sharing library(This may be seen by patrons in Primo). Optional.
general_pushing_method	string	The type of link that will be used to push the request into the resource sharing system. Mandatory. Possible values: openURL, Link.
generalURL_template	string	The URL that is used to send patrons from Primo to the resource sharing library's Web site. Optional.
general_broker_systemURL	string	The URL that is used to send request from Alma to NCIP broker. Optional.
general_library_owner	string with attr.	The resource sharing library code that is supported for all actions. Mandatory.
general_enable_service_without_login	string	Indication whether service is enabled for guest user. Possible values: true, false.
request_item_bib_type	string	The index that will be used to match the record that is described in the incoming RequestItem message. Optional indexes: OCLC, MMS_ID, LCCN, ISBN_ISSN, TAKEN_FROM_MESSAGE.
request_item_support_borrowing	boolean	Indicates if patron support borrowing for Request Item.
request_item_pickup_library	string with attr.	Request Item pickup location library for borrowing request.
request_item_location	string with attr.	Request Item location for borrowing request.
check_out_location	string with attr.	The temporary location at the resource sharing library that will be assigned to an item that is shipped to a resource sharing borrower. Mandatory.
check_out_item_policy	string with attr.	The policy that will be attached to an item that is shipped to a resource sharing borrower. Mandatory. Possible codes are listed in 'ItemPolicy' code table. Note that the policy should match the organization unit. The valid values for this parameter are controlled by the code-table: ItemPolicy. These are the currently defined values for your institution: Code Description
accept_item_location	string with attr.	The temporary location at the resource sharing library that will be assigned to an item that is recieved for a borrowing request. Mandatory.
accept_item_pickup_library	string with attr.	The default pickup location to which temporary items are transferred when an item arrives for a borrowing request.
accept_item_automatic_receive	boolean	Indicates if automatic receive is supported or not.
accept_item_receive_desk	string	The desk from which the automatic receive will be done, if automatic receive is supported.
look_up_user_authentication	string	Indication whether authentication should or should not be required for the resource sharing library's Web site. Possible values: true, false.
export_to_third_party	string	Indication whether ILLiad partner will be used in Rota. Possible values: NO, USING_EMAIL, USING_API.
export_email_address	string	ILLiad partner email address to send the request details.
export_url	string	ILLiad partner API URL.
export_api_key	string	ILLiad partner API key.
export_request_id_name_tag	string	ILLiad partner request external ID name tag.
close_request_on_export	boolean	Indication whether to mark resource sharing request as closed when send the request to ILLiad partner. Possible values: true or false.
create_user_on_export	boolean	Indication whether to push new users to ILLiad partner. Possible values: true or false.
export_user_identifier	string with attr.	The identification type that will be used to match users when a message contains a user ID. Mandatory. Possible codes are listed in 'UserIdentifierTypes' code table. In addition, the user_name can be used in order to match based on the primary identifier. The valid values for this parameter are controlled by the code-table: UserIdentifierTypes. These are the currently defined values for your institution: Code Description
NVTGC	string	NVTGC
status	string	Status
notification_preferences	string	Notification preferences
notification_method	string	The type of notification method that will be used to push the user into the resource sharing system. Possible values: ELECTRONIC, PHONE, MAIL.
delivery_method	string	The type of delivery method that will be used to push the user into the resource sharing system. Possible values: HOLD_FOR_PICKUP, MAIL_TO_ADDRESS.
loan_delivery_method	string	The type of loan delivery method that will be used to push the user into the resource sharing system. Possible values: HOLD_FOR_PICKUP, MAIL_TO_ADDRESS.
electronic_delivery	string	Whether to use electronic delivery. Possible values: YES, NO.
auth_type	string	The type of authentiction that will be used to push the user into the resource sharing system. Possible values: DEFAULT, ILLIAD.
request_agency_id	string	The requesting agency id.Mandatory for Worldshare/Tipasa
transfer_server	string	URL for sending transfer requests to Worldshare/Tipasa.Mandatory for Worldshare/Tipasa
ncip_send_requester_info	boolean	Indicates if to send patron information on the borrowing request. Optional.

 

innreach_details

Description: INN-Reach related details. Relevant and mandatory only if profile_type = INNREACH.

Field	Type	Description
general_user_id_type	general_user_id_type
general_loan_period	string	The amount of time the user has before having to return the item to the resource sharing library(This may be seen by patrons in Primo). Optional.
general_pushing_method	string	The type of link that will be used to push the request into the resource sharing system. Mandatory. Possible values: openURL, Link.
generalURL_template	string	The URL that is used to send patrons from Primo to the resource sharing library's Web site. Optional.
general_library_owner	string with attr.	The resource sharing library code that is supported for all actions. Mandatory.
general_enable_service_without_login	string	Indication whether service is enabled for guest user. Possible values: true, false.
request_item_support_borrowing	boolean	Indicates if patron support borrowing for Request Item. Always true for InnReach
request_item_pickup_library	string with attr.	Request Item pickup location library for borrowing request.
request_item_location	string with attr.	Request Item location for borrowing request.
shared_barcodes	boolean	Indicates if local institution shares barcodes with the partner. Default is false.
check_out_location	string with attr.	The temporary location at the resource sharing library that will be assigned to an item that is shipped to a resource sharing borrower. Mandatory.
check_out_item_policy	string with attr.	The policy that will be attached to an item that is shipped to a resource sharing borrower. Mandatory. Possible codes are listed in 'ItemPolicy' code table. Note that the policy should match the organization unit. The valid values for this parameter are controlled by the code-table: ItemPolicy. These are the currently defined values for your institution: Code Description
look_up_user_authentication	string	Indication whether authentication should or should not be required for the resource sharing library's Web site. Possible values: true, false.
innreach_integration_profile	string with attr.	The INN-Reach integration profile Hibernate id
share_patron_information	string	Indication whether the verify patron action should include patron information. Possible values: true, false.

 

email_details

Description: Email related details. Relevant and mandatory only if profile_type = Email.

Field	Type	Description
email	string	The email address to which resource sharing borrowing requests are to be sent. The entered address must be added to the Email Include List Mapping Table (General Configuration - Configuration menu - External Systems - Allowed Emails). Mandatory.
resending_overdue_message_interval	int	The Interval (In days) that overdue message will be sent to partner. Must be a number

 

iso_details

Description: ISO related details. Relevant and mandatory only if profile_type = ISO.

Field	Type	Description
alternative_document_delivery	boolean	Indication whether to include the requester's email in the lending request, enabling the lending partner to send the shipped resource directly to the requester. Optional. Default value is false.
ill_server	string	The partner's server name (or IP address). Mandatory.
ill_port	int	the partner's ILL port number. Mandatory.
iso_symbol	string	the symbol by which the ILL partner is referred. Mandatory.
request_expiry_type	request_expiry_type
expiry_time	int	If EXPIRY_TIME was selected as the expiry_type, this field should hold the relevant number of days. Optional.
send_requester_information	boolean	Indicates if to send patron information on the borrowing request. Optional.
shared_barcodes	boolean	Indicates if local institution shares barcodes with the partner. Default is false.
ignore_shipping_cost_override	boolean	Indicates if local institution ignores the lender shipping cost. Default is false.
email_address	string	The email address to which the Overdue email will be sent - Relvants only for SLNP type.
resending_overdue_message_interval	int	The Interval (In days) that the overdue message will be sent to partner. Must be a number

 

iso_18626_details

Description: ISO 18626 related details. Relevant and mandatory only if profile_type = ISO_18626.

Field	Type	Description
alternative_document_delivery	boolean	Indication whether to include the requester's email in the lending request, enabling the lending partner to send the shipped resource directly to the requester. Optional. Default value is false.
ill_server	string	The partner's server name (or IP address). Mandatory.
iso_symbol	string	the symbol by which the ILL partner is referred. Mandatory.
send_requester_information	boolean	Indicates if to send patron information on the borrowing request. Optional.
shared_barcodes	boolean	Indicates if local institution shares barcodes with the partner. Default is false.
return_info	boolean	Determines whether the shipping message to this ISO 18626 partner will include the Returninfo field, containing the ISIL code for the item's owning library, as well as the supplyingAgencyId (ISIL code of the resource sharing library). If set to "false", only the supplyingAgencyId is provided to the partner.
resending_overdue_message_interval	int	The Interval (In days) that the overdue message will be sent to partner. Must be a number

 

ncip_p2p_details

Description: NCIP_P2P related details. Relevant and mandatory only if profile_type = NCIP_P2P.

Field	Type	Description
alternative_document_delivery	boolean	Indication whether to include the requester's email in the lending request, enabling the lending partner to send the shipped resource directly to the requester. Optional. Default value is false.
general_user_id_type	general_user_id_type
ill_server	string	The partner's server name (or IP address). Mandatory.
institution_code	string	the partner's Institution Symbol
partner_symbol	string	the symbol by which the ILL partner is referred. Mandatory.
request_expiry_type	request_expiry_type
expiry_time	int	If EXPIRY_TIME was selected as the expiry_type, this field should hold the relevant number of days. Optional.
send_requester_information	boolean	Indicates if to send patron information on the borrowing request. Optional.
email_address	string	The email address to which the Overdue email will be sent
resending_overdue_message_interval	int	The Interval (In days) that the overdue message will be sent to partner. Must be a number

 

bldss_details

Description: BLDSS related details. Relevant and mandatory only if profile_type = BLDSS.

Field	Type	Description
bldss_base_url	string	The BLDSS URL. Mandatory.
bldss_base_account	string	The BLDSS account name. Mandatory.
bldss_base_password	string	The BLDSS password. Mandatory.
bldss_digital_format	string with attr.	The BLDSS digital format. Possible codes are listed in the 'BLDSSDigitalFormats' code table. The valid values for this parameter are controlled by the code-table: BLDSSDigitalFormats. These are the currently defined values for your institution: Code Description
bldss_send_requester_info	boolean	The BLDSS send requester Info.

 

fulfillment_network_details

Description: FULFILLMENT_NETWORK related details. Relevant and mandatory only if profile_type = FULFILLMENT_NETWORK.

Field	Type	Description
fulfillment_network_customer_code	string	The FULFILLMENT_NETWORK customer code. Mandatory.
fulfillment_network_url	string	The FULFILLMENT_NETWORK URL.
request_expiry_type	request_expiry_type
expiry_time	int	If EXPIRY_TIME was selected as the expiry_type, this field should hold the relevant number of days. Optional.

 

rapid_details

Description: RapidILL related details. Relevant and mandatory only if profile_type = RapidILL.

Field	Type	Description
rapid_url	string	RapidILL URL.
rapid_user_name	string	RapidILL User Name. Mandatory.
rapid_password	string	RapidILL password. Mandatory.
requesting_rapid_code	string	RapidILL Requesting Rapid Code. Mandatory.
rapid_requesting_branch_name	string	RapidILL Requesting Branch Name. Mandatory.
close_request_on_export	boolean	Indication whether to mark resource sharing request as closed when send the request to RapidILL partner. Possible values: true or false.
rapid_default_library_owner	string with attr.	The resource sharing library code that is supported for all actions. Mandatory.

 

general_user_id_type

Description: The identification type that will be used to match users when a message contains a user ID. Mandatory. Possible codes are listed in 'UserIdentifierTypes' code table. In addition, the user_name can be used in order to match based on the primary identifier.

Field	Type	Description

 

request_expiry_type

Description: The expiry option of the request: NO_EXPIRY, INTEREST_DATE or EXPIRY_TIME. Optional. Default: NO_EXPIRY Possible codes are listed in ExpiryType code table.

Field	Type	Description

 

status

status is a xs:string with xs:restriction - see XSD for details.

profile_type

profile_type is a xs:string with xs:restriction - see XSD for details.

Samples

XML

JSON

__