Planfix API: projectGroup.getList: Difference between revisions
From Planfix
(Created page with "{{#seo: |title=Planfix API: projectGroup.getList |titlemode=append |keywords=Planfix, Planfix API, API, projectGroup.getList, getList project |description=Planfix API: projectGroup.getList }} Function for getting a list of project groups Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="projectGroup.getList"> <account></account> <sid></sid> <signature></signature> </request> </source> {| class="wikitable" style="margin-top:...") |
No edit summary |
||
Line 20: | Line 20: | ||
|- | |- | ||
|} | |} | ||
Response: | Response: | ||
Line 57: | Line 56: | ||
</response> | </response> | ||
</source> | </source> | ||
Otherwise, an error response will be returned: | Otherwise, an error response will be returned: |
Revision as of 12:53, 2 August 2023
Function for getting a list of project groups Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="projectGroup.getList">
<account></account>
<sid></sid>
<signature></signature>
</request>
Name | Type | Value | Notes |
---|---|---|---|
signature | string(32) | signature |
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<projectGroups totalCount="totalCount">
<projectGroup>
<id></id>
<name></name>
</projectGroup>
<!-- ... -->
</projectGroups>
</response>
Name | Type | Value | Notes |
---|---|---|---|
projectGroups | root element, contains a list of project groups | ||
projectGroups totalCount | int | number of project groups | |
projectGroup | root element that describes a project group in the list | ||
id | int | project group identifier | |
name | string | project group name |
An empty response will not generate an error. If there are no project groups in the resulting selection, the response will look as follows:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<projectGroups totalCount="0"></projectGroups>
</response>
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>