GetProjectListByProjectName
Description
Get info about your projects by project name. Token-based, ie. you get pages of projects at a time along with a token that can be sent in the next request to get the next projects.
Signature
ProjectListResultSet GetProjectListByProjectName(string key, ProjectType projectType, bool allProjects, ProjectListToken token, int topN, string projectName)Parameters
| Name | Data Type | Description |
|---|---|---|
key |
string required |
The authentication key |
projectType |
ProjectType required |
Production or Test |
allProjects |
bool required |
true means all your projects, false means favorites |
token |
ProjectListToken optional |
Use null on initial call, when iterating use the token from the result |
topN |
int optional |
Will return the top N results. If token.LastId is set, the results will be relative to that id. |
projectName |
string required |
Name of the project to search for. Use '*' to match not exact names |
Example
var projectNames = new ArrayList();
ProjectListToken token = null;
bool atEnd = false;
while (!atEnd)
{
var plr = authoring.GetProjectListByProjectName(key,ProjectType.ProjectAndPanel,false, token, 10, "name of survey");
foreach (Project p in plr.List.Projects)
projectNames.Add(p.Name);
token = plr.Token;
atEnd = plr.Token.AtEnd;
}