GetUserTaskRedirectionTo
# GetUserTaskRedirectionTo API
Returns the task redirection that is currently configured for a user — i.e., the user to whom all new tasks assigned to the specified user are being forwarded.
If no redirection is active, the response contains no <TaskRedirection> element.
Endpoint¶
Methods¶
- GET
/srv.asmx/GetUserTaskRedirectionTo?authenticationTicket=...&userName=... - POST
/srv.asmx/GetUserTaskRedirectionTo(form data) - SOAP Action:
http://tempuri.org/GetUserTaskRedirectionTo
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser. |
userName |
string | Yes | Login name of the user whose redirection to retrieve. |
Response¶
Success Response — redirection active¶
<root success="true">
<TaskRedirection>
<UserId>15</UserId>
<UserName>alice.jones</UserName>
<FullName>Alice Jones</FullName>
<Email>alice.jones@example.com</Email>
<StartDate>2024-03-01</StartDate>
<EndDate>2024-03-31</EndDate>
</TaskRedirection>
</root>
Success Response — no redirection configured¶
Error Response¶
Response Field Reference¶
The <TaskRedirection> element describes the destination user (the person tasks are being redirected to):
| Element | Description |
|---|---|
UserId |
Numeric user ID of the redirect target. |
UserName |
Login name of the redirect target. |
FullName |
Full display name of the redirect target. |
Email |
Email address of the redirect target. |
StartDate |
Date from which the redirection is active. Empty string if open-ended. |
EndDate |
Date on which the redirection expires. Empty string if open-ended. |
Required Permissions¶
Any authenticated user may call this API.
Example¶
GET Request¶
GET /srv.asmx/GetUserTaskRedirectionTo
?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
&userName=john.smith
HTTP/1.1
Host: yourserver
POST Request¶
POST /srv.asmx/GetUserTaskRedirectionTo HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded
authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&userName=john.smith
Notes¶
- A task redirection causes all new tasks assigned to
userNameto be forwarded to another user for the duration of the active date range. - If the redirection's
StartDateandEndDatewindow has passed or has not yet started, the redirection may exist in the database but not be actively applied. The API returns the stored redirection record regardless. - To check which users are redirecting tasks to a given user, use GetUserTaskRedirectionsFrom.
- To configure a redirection, use SetUserTaskRedirection.
- To remove a redirection, use RemoveUserTaskRedirection.
Related APIs¶
- GetUserTaskRedirectionsFrom – List all users who are redirecting their tasks to a given user.
- SetUserTaskRedirection – Set or update a task redirection for a user.
- RemoveUserTaskRedirection – Remove a user's task redirection.
- RerouteUserTaskRedirection – Change the target of an existing task redirection.
Error Codes¶
| Error | Description |
|---|---|
[900] |
Authentication failed — invalid credentials. |
[901] |
Session expired or invalid authentication ticket. |
| User not found | The specified userName does not exist. |