POST /api/groups

Adds an independent group to the platform.

Authorization Roles/Permissions: Must be logged in.The user who adds the group automatically becomes the first group member. Must have Add permission for the resource.

Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/groups

Back to top

Sample Request

The example below shows a new group being added.

Request URL

https://{hostname}/api/groups

Sample request headers

POST /api/groups HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Group":{
    "Name":"LEAD",
    "Description":"League of Extraordinary Application Developers",
    "GroupType":"com.soa.group.type.independent",
    "Visibility":"Limited",
    "Tag":[
      "brilliant",
      "advanced",
      "innovative",
      "league"
    ],
    "PictureID":"1520"
  }
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
addGroupRequest Body addGroupRequest Required Contains information about a request to add a group, including information about the group and the list of users who will be Administrators for the group. Required properties: Name, Description, GroupType.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the group, including the GroupID assigned to the new group.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 10 Jun 2013 22:46:07 GMT
Set-Cookie: AtmoAuthToken_acmepaymentscorp=TokenID%3D8a2f4931-d21f-11e2-a8ac-cbfcc05f2607%2Cclaimed_id%3Durn
%3Aacme%3Auser%3Aacmepaymentscorp%3Auser12262%2CissueTime%3D1370904367894%2CexpirationTime%3D1370906167871
%2CAttributesIncluded%3Dfalse%2CUserFDN%3Duser12262%252Eopen%2CUserName%3Dacmepaymentscorp-JaneSaoirse%2Csig%3D
OVX-XWv7XRRyslthf8c7MmZRFNvBj_XzeZ90MGUSAdWZHdwq1ALn9CNFVfbdCmDpinGS7azEf0luXwZ-QQJrU7ZThWixkggVMWx47R9ZK0XVPtlW6O
CDdDkj6edeWYa4QUP7e9qYNqnr9OxXcqvyuQAxoZftBga3-iwbt1yQTMg;path=/;expires=Mon, 10-Jun-2013 23:11:07 GMT;HttpOnly

Sample response body: application/json

{
  "GroupID" : "group24385.acmepaymentscorp",
  "Name" : "LEAD",
  "Description" : "League of Extraordinary Application Developers",
  "Tag" : [ "brilliant", "advanced", "innovative", "league" ],
  "Visibility" : "Limited",
  "PictureID" : 1520,
  "GroupType" : "com.soa.group.type.independent"
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Date: Mon, 10 Jun 2013 23:52:04 GMT
Set-Cookie: AtmoAuthToken_acmepaymentscorp=TokenID%3Dc0ba5d62-d228-11e2-a8ac-cbfcc05f2607%2Cclaimed_id%3Durn%3Aacme
%3Auser%3Aacmepaymentscorp%3Auser12 262%2CissueTime%3D1370908324871%2CexpirationTime%3D1370910124850%2CAttributesIncluded
%3Dfalse%2CUserFDN%3Duser12262%252E open%2CUserName%3Dacmepaymentscorp-JaneSaoirse%2Csig%3DNHlX_eIXSexfNRgvkXw_S8MUf6Dnh
nEXP9z_W3dU82o5qdrF9s96yf0aC1MF07FbNGq6yZeDmcSyTDJsIBvQncuzdTrTdraurzNVMC8JUEHRvZbB04FKdsoHObyvMQzAZ4_RSXUsKFfTylfm
OxPiMT1ylqPba-vB9WW4XvDTssk

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<Group xmlns="http://soa.com/xsd/group/1.0" xmlns:ns2="http://soa.com/xsd/resource/1.0">
  <GroupID>group24386.acmepaymentscorp</GroupID>
  <Name>LEAD</Name>
  <Description>League of Extraordinary Application Developers</Description>
  <Tag>brilliant</Tag>
  <Tag>advanced</Tag>
  <Tag>innovative</Tag>
  <Tag>league</Tag>
  <Visibility>Limited</Visibility>
  <PictureID>1520</PictureID>
  <GroupType>com.soa.group.type.independent</GroupType>
</Group>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Set-Cookie The set-cookie response header sets, updates, or expires the platform cookie to reflect changes made by the operation.

Back to top

Response Body

Name Type Description
Group Group Contains information about a group on the platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics