HoldingsGenerateLID (Method)

Description

This method allows the user to generate a state LID for a specified CoreOne Premises.

Request (HoldingsGenerateLID)

Below are the required parameters to successfully generate a state LID for a CoreOne Premises. If any required 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 Holding id. This is the premises that the user wishes to generate a state LID for.

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

xml:int

send_state_lid

If "yes" this will send the generated LID to USDA.

xml:string

Response (HoldingsGenerateLID_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 a state LID was successfully generated for the premises a message "Update successful." will be returned. If however a state LID was not successfully updated for the premises a message "Update Failed." will be returned.	xml:string

Remarks