Planfix API: projectGroup.add: Difference between revisions
From Planfix
								
												
				No edit summary  | 
				 (→Go To)  | 
				||
| Line 58: | Line 58: | ||
== Go To ==  | == Go To ==  | ||
*[[Planfix API:Project groups|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>