Planfix API: projectGroup.add: Difference between revisions
From Planfix
(Created page with "{{#seo: |title=Planfix API: projectGroup.add |titlemode=append |keywords=Planfix, Planfix API, projectGroup.add, project |description=Planfix API: projectGroup.add }} This function is a request to create a project group. Only users with admin rights can execute this function. The function looks as follows: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="projectGroup.add"> <account></account> <sid></sid> <projectGroup> <name></name>...") |
(→Go To) |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 28: | Line 28: | ||
|- | |- | ||
|} | |} | ||
Response when project group creation is successful: | Response when project group creation is successful: | ||
| Line 39: | Line 40: | ||
</source> | </source> | ||
{| class="wikitable" style="margin-top: 1em; width:100% " | {| class="wikitable" style="margin-top: 1em; width:100% " | ||
!width="150"| | !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Notes | ||
Name !!width="200"| Type !!width="50%"| Value !! Notes | |||
|- | |- | ||
|projectGroup.id ||int ||identifier of the project group created || | |projectGroup.id ||int ||identifier of the project group created || | ||
|- | |- | ||
|} | |} | ||
Otherwise, an error response will be returned: | Otherwise, an error response will be returned: | ||
| Line 56: | Line 57: | ||
== Go To == | == Go To == | ||
*[[Planfix API: Project groups]] | *[[Planfix API:Project groups|Project groups]] | ||
*[[Error codes]] | *[[Error codes XML API v1|Error codes]] | ||
*[[List of functions]] | *[[List of functions]] | ||
Latest revision as of 09:33, 6 March 2024
This function is a request to create a project group. Only users with admin rights can execute this function.
The function looks as follows:
<?xml version="1.0" encoding="UTF-8"?>
<request method="projectGroup.add">
<account></account>
<sid></sid>
<projectGroup>
<name></name>
</projectGroup>
<signature></signature>
</request>| Name | Type | Value | Notes |
|---|---|---|---|
| sid | string(32) | session key | created as a result of passing authentication |
| name | string | Project group name |
Response when project group creation is successful:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<projectGroup>
<id></id>
</projectGroup>
</response>| Name | Type | Value | Notes |
|---|---|---|---|
| projectGroup.id | int | identifier of the project group created |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>