Restrictions Web Service
MethodRestrictionsCreateHolding
Description
This method allows the user to create a CoreOne Restriction at a premises level.
Request (RestrictionsCreateHolding)

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

Request Body Parameters

NameDescriptionData 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
id

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

These can be retrieved through using the HoldingsIndex (Method).
xml:int
master_restrictionThese are the input parameters necessary for a successful creation of a Restriction.ws_master_restriction_c
Response (RestrictionsCreateHolding_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

NameDescriptionData Type
statusIf the creation of a restriction was successful a message "Create successful." will be returned. If the creation of a restriction was not successful a message "Create Failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupRestrictions Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.