Holdings Web Service
MethodHoldingsCreate
Description
This method allows a user to create a new CoreOne Premises by entering in the relevant information.
Request (HoldingsCreate)

Below are the parameters to successfully create a CoreOne Premises. If any required 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
holdingThese are the Premises input parameters necessary for a successful creation of a premises.ws_holding_c
holding_speciesThis is an array of CoreOne Species id. These are the species that are in the premises.
More than one species id can be entered.
xml:int
generate_state_lidIf "yes" this will generate a state LID for the premises.xml:string
send_state_lidIf "yes" this will send the generated LID to USDA.
xml:string
Response (HoldingsCreate_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 Premises was successfully created a message "Create Successful." will be returned. If however the Premises was not successfully created a message "Create Failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupHoldings Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.