RestrictionsAddHolding (Method)

Description

This method allows the user to add a premises to an already existing CoreOne Restriction.

Request (RestrictionsAddHolding)

Below are the required parameters to successfully add a premises to a specified CoreOne Restriction. If any parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

Name

Description

Data Type

token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.

xml:string

This is an internal CoreOne Master Restriction id

These can be retrieved through using the RestrictionsIndex (Method).

xml:int

holding_id

This is an internal CoreOne Holding id. It is the premises the user wishes to add to the restriction.

These can be retrieved through using the HoldingsIndex (Method).

xml:int

Response (RestrictionsAddHolding_response)

This is the returned status message to tell the user the result of the method.

An error message will be displayed instead of the status message if any of the input parameters fail any validation rule. For example if the user's token is invalid or the record doesn't exist. It will alert the user on what parameter failed validation and the reason why.

Response Body Parameters

Name	Description	Data Type
status	If the premises was successfully added to the restriction a message "Add successful." will be returned. If the premises was not successfully added to the restriction a message "Add failed." will be returned.	xml:string

Remarks