Address Search: Prepare for Direct Mode
/api/v3/address/preparefind
Address Preparefind
This endpoint implements text-based searches in Direct Mode. In direct mode, we provide a set of credentials to the client, which then uses these to access the third-party servers directly. (This is the recommended mode. Indirect Mode, with /find, is slower.) This endpoint provides meta-information to authorized users. After retrieving this information, the client (for example, JavaScript code running in a Web browser) can use this information to directly access a third-party cluster, bypassing the OPC Data Service AV API altogether to implement a type-ahead search.
The output is a JSON map. It contains the parameter "Key" which is used to call the third-party servers directly. The endpoint parameter contains a fully qualified URL pointing to the endpoint on the third-party servers.
Example Response { "Key": "M48BN-SA23445-ASDFASD", "endpoint": "https://third-party-server.com/api/my/Find1.0" }
Here is the actual find request that could be assembled from this response: https://third-party-server.com/api/my/Find1.0?Key=M48BN-SA23445-ASDFASD&Text=941
The next step is to narrow down results. For more information, see here.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
- application/json; charset=UTF-8
200 Response
object