V3_UserLineAccess_Get (Get)
- Last UpdatedNov 06, 2025
- 1 minute read
| Get | V3_UserLineAccess_Get |
Resource Path:/api/V3/UserLineAccess
| Name | Description | Data Type |
|---|---|---|
| lineId | The ID of the line for which to retrieve access status. If an ID is not supplied, the user's access status for all lines is returned. | integer |
| userId | The ID of the user for whom to retrieve line access status. If this parameter is not included in the endpoint, line access status for the current user is returned. The current user is the user entered in the Authentication window that appears when accessing the Web API. | string |
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
| max_rows | Used to supply the maximum number of rows that will be returned by the get. |
The response body is of type Array[Generated.Models.V3_UserLineAccess_Get].
OKUse this endpoint to see if a user has access to a specific line or their access information for all lines. The endpoint retrieves one or more user-line link records from the Grp_Line_Link table, as specified by the filter parameters. Passing no filter parameters will retrieve all user-line links for the user entered in the Authentication window that appears when accessing the Web API.