/
instance_discover ()

instance_discover ()

Function prototype

instance_discover (session)

API Version

All

Supported interfaces

SOAP, REST (from API Version 2.7.26)

Returns a list of Linkcare instance endpoints.

Note that the endpoint you get from the output parameters can be totally different to the one used to call this function, and you should use the retrieved one for every new calls to the desired instance

Input

parameters:

  • session: (optional) a token obtained by calling session_init ()

    • If a valid session is provided, only those instances where the user associated to the session exists will be returned.

    • If no session is provided, all Linkcare available instances will be returned

Output

parameters:

  • instances: A list of web service endpoint

    • endpoint: URL of the instance

    • name: Name of the instance

  • ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced

  • ErrorCode: the code of the error (if any)

Request example

instance_discover ('')

Reponse

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

 



Related content