POST api/group/create/{id}

create individual, corp group by users

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

object representing the details that need to create or update group.

integer

Required

Body Parameters

object representing the details that need to add/update guardian info.

CreateGroupReq
NameDescriptionTypeAdditional information
group_id

group id is required when user create group in corp

integer

None.

title

chosen title for group by user

string

Required

String length: inclusive between 0 and 100

description

chosen title for group by user

string

String length: inclusive between 0 and 200

group_image

group image when it select from his/her devices. It is a base64 image

string

None.

no_of_members

number of participants required in group or challange. Minimum 3 or maximum 10 participants can join

integer

Matching regular expression pattern: ^([3-9]|10)$

no_of_days

group challange for number of days

integer

None.

prize

prize for challange like pizza party, movie etc

string

String length: inclusive between 0 and 1000

org_id

org id is required when user create group in corp

integer

None.

org_branch_id

org branch id is required when user create group in corp

integer

None.

org_member_id

org member id is required when user create group in corp

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "group_id": 1,
  "title": "sample string 1",
  "description": "sample string 2",
  "group_image": "sample string 3",
  "no_of_members": 1,
  "no_of_days": 1,
  "prize": "sample string 4",
  "org_id": 1,
  "org_branch_id": 1,
  "org_member_id": 1
}

application/xml, text/xml

Sample:
<create_group_req xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LifetronsPhoneApi.Domain.RequestAgg.v5">
  <description>sample string 2</description>
  <group_id>1</group_id>
  <group_image>sample string 3</group_image>
  <no_of_days>1</no_of_days>
  <no_of_members>1</no_of_members>
  <org_branch_id>1</org_branch_id>
  <org_id>1</org_id>
  <org_member_id>1</org_member_id>
  <prize>sample string 4</prize>
  <title>sample string 1</title>
</create_group_req>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

On success, return recently created or updated group info. On failure, return null with Lifetrons response code.

GroupsResp
NameDescriptionTypeAdditional information
groups

list of groups with group members

Collection of Group

None.

resp_code

Lifetrons response code

string

None.

resp_msg

Lifetrons response message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "groups": [
    {
      "group_id": 1,
      "uid": "sample string 2",
      "title": "sample string 3",
      "description": "sample string 4",
      "group_type": "sample string 5",
      "invite_code": "sample string 6",
      "user_id": 1,
      "created_on": 8.1,
      "updated_on": 10.1,
      "is_active": true,
      "org_id": 1,
      "org_branch_id": 1,
      "org_member_id": 1,
      "image_url": "sample string 12",
      "invite_url": "sample string 13",
      "minimum_req_member": 14,
      "no_of_members": 1,
      "no_of_days": 1,
      "prize": "sample string 15",
      "start_date": 1.1,
      "end_date": 1.1,
      "is_deleted": true,
      "is_started": true,
      "is_dropped": true,
      "dropped_on": 1.1,
      "members": [
        {
          "group_member_id": 1,
          "group_id": 2,
          "user_id": 3,
          "uid": "sample string 4",
          "display_name": "sample string 5",
          "country_code": "sample string 6",
          "mobile_number": "sample string 7",
          "is_leader": true,
          "goals_updated": true,
          "inserted_on": 11.1,
          "updated_on": 13.1,
          "is_removed": true,
          "removed_on": 1.1,
          "removed_by_id": 15,
          "is_left": true,
          "left_on": 1.1,
          "image_url": "sample string 17",
          "is_dropped": true,
          "dropped_on": 1.1,
          "goal": {
            "goal_id": 1,
            "group_id": 2,
            "user_id": 3,
            "goal_type": "sample string 4",
            "steps": 5,
            "weight": 6.0,
            "starting_weight": 1.0,
            "water_intake": 7.0,
            "calories": 8,
            "distance": 9.0,
            "bodyfat": 1,
            "no_of_days_goal": 10,
            "avg_weight_per_week": 11.0,
            "inserted_on": 12.1,
            "updated_on": 13.1
          }
        },
        {
          "group_member_id": 1,
          "group_id": 2,
          "user_id": 3,
          "uid": "sample string 4",
          "display_name": "sample string 5",
          "country_code": "sample string 6",
          "mobile_number": "sample string 7",
          "is_leader": true,
          "goals_updated": true,
          "inserted_on": 11.1,
          "updated_on": 13.1,
          "is_removed": true,
          "removed_on": 1.1,
          "removed_by_id": 15,
          "is_left": true,
          "left_on": 1.1,
          "image_url": "sample string 17",
          "is_dropped": true,
          "dropped_on": 1.1,
          "goal": {
            "goal_id": 1,
            "group_id": 2,
            "user_id": 3,
            "goal_type": "sample string 4",
            "steps": 5,
            "weight": 6.0,
            "starting_weight": 1.0,
            "water_intake": 7.0,
            "calories": 8,
            "distance": 9.0,
            "bodyfat": 1,
            "no_of_days_goal": 10,
            "avg_weight_per_week": 11.0,
            "inserted_on": 12.1,
            "updated_on": 13.1
          }
        }
      ]
    },
    {
      "group_id": 1,
      "uid": "sample string 2",
      "title": "sample string 3",
      "description": "sample string 4",
      "group_type": "sample string 5",
      "invite_code": "sample string 6",
      "user_id": 1,
      "created_on": 8.1,
      "updated_on": 10.1,
      "is_active": true,
      "org_id": 1,
      "org_branch_id": 1,
      "org_member_id": 1,
      "image_url": "sample string 12",
      "invite_url": "sample string 13",
      "minimum_req_member": 14,
      "no_of_members": 1,
      "no_of_days": 1,
      "prize": "sample string 15",
      "start_date": 1.1,
      "end_date": 1.1,
      "is_deleted": true,
      "is_started": true,
      "is_dropped": true,
      "dropped_on": 1.1,
      "members": [
        {
          "group_member_id": 1,
          "group_id": 2,
          "user_id": 3,
          "uid": "sample string 4",
          "display_name": "sample string 5",
          "country_code": "sample string 6",
          "mobile_number": "sample string 7",
          "is_leader": true,
          "goals_updated": true,
          "inserted_on": 11.1,
          "updated_on": 13.1,
          "is_removed": true,
          "removed_on": 1.1,
          "removed_by_id": 15,
          "is_left": true,
          "left_on": 1.1,
          "image_url": "sample string 17",
          "is_dropped": true,
          "dropped_on": 1.1,
          "goal": {
            "goal_id": 1,
            "group_id": 2,
            "user_id": 3,
            "goal_type": "sample string 4",
            "steps": 5,
            "weight": 6.0,
            "starting_weight": 1.0,
            "water_intake": 7.0,
            "calories": 8,
            "distance": 9.0,
            "bodyfat": 1,
            "no_of_days_goal": 10,
            "avg_weight_per_week": 11.0,
            "inserted_on": 12.1,
            "updated_on": 13.1
          }
        },
        {
          "group_member_id": 1,
          "group_id": 2,
          "user_id": 3,
          "uid": "sample string 4",
          "display_name": "sample string 5",
          "country_code": "sample string 6",
          "mobile_number": "sample string 7",
          "is_leader": true,
          "goals_updated": true,
          "inserted_on": 11.1,
          "updated_on": 13.1,
          "is_removed": true,
          "removed_on": 1.1,
          "removed_by_id": 15,
          "is_left": true,
          "left_on": 1.1,
          "image_url": "sample string 17",
          "is_dropped": true,
          "dropped_on": 1.1,
          "goal": {
            "goal_id": 1,
            "group_id": 2,
            "user_id": 3,
            "goal_type": "sample string 4",
            "steps": 5,
            "weight": 6.0,
            "starting_weight": 1.0,
            "water_intake": 7.0,
            "calories": 8,
            "distance": 9.0,
            "bodyfat": 1,
            "no_of_days_goal": 10,
            "avg_weight_per_week": 11.0,
            "inserted_on": 12.1,
            "updated_on": 13.1
          }
        }
      ]
    }
  ],
  "resp_code": "sample string 1",
  "resp_msg": "sample string 2"
}

application/xml, text/xml

Sample:
<groups_resp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LifetronsPhoneApi.Domain.ResponseAgg.v5">
  <resp_code xmlns="http://schemas.datacontract.org/2004/07/LifetronsPhoneApi.Models">sample string 1</resp_code>
  <resp_msg xmlns="http://schemas.datacontract.org/2004/07/LifetronsPhoneApi.Models">sample string 2</resp_msg>
  <groups xmlns:d2p1="http://schemas.datacontract.org/2004/07/CommonClasses.user">
    <d2p1:group>
      <d2p1:created_on>8.1</d2p1:created_on>
      <d2p1:description>sample string 4</d2p1:description>
      <d2p1:dropped_on>1.1</d2p1:dropped_on>
      <d2p1:end_date>1.1</d2p1:end_date>
      <d2p1:group_id>1</d2p1:group_id>
      <d2p1:group_type>sample string 5</d2p1:group_type>
      <d2p1:image_url>sample string 12</d2p1:image_url>
      <d2p1:invite_code>sample string 6</d2p1:invite_code>
      <d2p1:invite_url>sample string 13</d2p1:invite_url>
      <d2p1:is_active>true</d2p1:is_active>
      <d2p1:is_deleted>true</d2p1:is_deleted>
      <d2p1:is_dropped>true</d2p1:is_dropped>
      <d2p1:is_started>true</d2p1:is_started>
      <d2p1:members>
        <d2p1:group_member>
          <d2p1:country_code>sample string 6</d2p1:country_code>
          <d2p1:display_name>sample string 5</d2p1:display_name>
          <d2p1:dropped_on>1.1</d2p1:dropped_on>
          <d2p1:goal>
            <d2p1:avg_weight_per_week>11</d2p1:avg_weight_per_week>
            <d2p1:bodyfat>1</d2p1:bodyfat>
            <d2p1:calories>8</d2p1:calories>
            <d2p1:distance>9</d2p1:distance>
            <d2p1:goal_id>1</d2p1:goal_id>
            <d2p1:goal_type>sample string 4</d2p1:goal_type>
            <d2p1:group_id>2</d2p1:group_id>
            <d2p1:inserted_on>12.1</d2p1:inserted_on>
            <d2p1:no_of_days_goal>10</d2p1:no_of_days_goal>
            <d2p1:starting_weight>1</d2p1:starting_weight>
            <d2p1:steps>5</d2p1:steps>
            <d2p1:updated_on>13.1</d2p1:updated_on>
            <d2p1:user_id>3</d2p1:user_id>
            <d2p1:water_intake>7</d2p1:water_intake>
            <d2p1:weight>6</d2p1:weight>
          </d2p1:goal>
          <d2p1:goals_updated>true</d2p1:goals_updated>
          <d2p1:group_id>2</d2p1:group_id>
          <d2p1:group_member_id>1</d2p1:group_member_id>
          <d2p1:image_url>sample string 17</d2p1:image_url>
          <d2p1:inserted_on>11.1</d2p1:inserted_on>
          <d2p1:is_dropped>true</d2p1:is_dropped>
          <d2p1:is_leader>true</d2p1:is_leader>
          <d2p1:is_left>true</d2p1:is_left>
          <d2p1:is_removed>true</d2p1:is_removed>
          <d2p1:left_on>1.1</d2p1:left_on>
          <d2p1:mobile_number>sample string 7</d2p1:mobile_number>
          <d2p1:removed_by_id>15</d2p1:removed_by_id>
          <d2p1:removed_on>1.1</d2p1:removed_on>
          <d2p1:uid>sample string 4</d2p1:uid>
          <d2p1:updated_on>13.1</d2p1:updated_on>
          <d2p1:user_id>3</d2p1:user_id>
        </d2p1:group_member>
        <d2p1:group_member>
          <d2p1:country_code>sample string 6</d2p1:country_code>
          <d2p1:display_name>sample string 5</d2p1:display_name>
          <d2p1:dropped_on>1.1</d2p1:dropped_on>
          <d2p1:goal>
            <d2p1:avg_weight_per_week>11</d2p1:avg_weight_per_week>
            <d2p1:bodyfat>1</d2p1:bodyfat>
            <d2p1:calories>8</d2p1:calories>
            <d2p1:distance>9</d2p1:distance>
            <d2p1:goal_id>1</d2p1:goal_id>
            <d2p1:goal_type>sample string 4</d2p1:goal_type>
            <d2p1:group_id>2</d2p1:group_id>
            <d2p1:inserted_on>12.1</d2p1:inserted_on>
            <d2p1:no_of_days_goal>10</d2p1:no_of_days_goal>
            <d2p1:starting_weight>1</d2p1:starting_weight>
            <d2p1:steps>5</d2p1:steps>
            <d2p1:updated_on>13.1</d2p1:updated_on>
            <d2p1:user_id>3</d2p1:user_id>
            <d2p1:water_intake>7</d2p1:water_intake>
            <d2p1:weight>6</d2p1:weight>
          </d2p1:goal>
          <d2p1:goals_updated>true</d2p1:goals_updated>
          <d2p1:group_id>2</d2p1:group_id>
          <d2p1:group_member_id>1</d2p1:group_member_id>
          <d2p1:image_url>sample string 17</d2p1:image_url>
          <d2p1:inserted_on>11.1</d2p1:inserted_on>
          <d2p1:is_dropped>true</d2p1:is_dropped>
          <d2p1:is_leader>true</d2p1:is_leader>
          <d2p1:is_left>true</d2p1:is_left>
          <d2p1:is_removed>true</d2p1:is_removed>
          <d2p1:left_on>1.1</d2p1:left_on>
          <d2p1:mobile_number>sample string 7</d2p1:mobile_number>
          <d2p1:removed_by_id>15</d2p1:removed_by_id>
          <d2p1:removed_on>1.1</d2p1:removed_on>
          <d2p1:uid>sample string 4</d2p1:uid>
          <d2p1:updated_on>13.1</d2p1:updated_on>
          <d2p1:user_id>3</d2p1:user_id>
        </d2p1:group_member>
      </d2p1:members>
      <d2p1:minimum_req_member>14</d2p1:minimum_req_member>
      <d2p1:no_of_days>1</d2p1:no_of_days>
      <d2p1:no_of_members>1</d2p1:no_of_members>
      <d2p1:org_branch_id>1</d2p1:org_branch_id>
      <d2p1:org_id>1</d2p1:org_id>
      <d2p1:org_member_id>1</d2p1:org_member_id>
      <d2p1:prize>sample string 15</d2p1:prize>
      <d2p1:start_date>1.1</d2p1:start_date>
      <d2p1:title>sample string 3</d2p1:title>
      <d2p1:uid>sample string 2</d2p1:uid>
      <d2p1:updated_on>10.1</d2p1:updated_on>
      <d2p1:user_id>1</d2p1:user_id>
    </d2p1:group>
    <d2p1:group>
      <d2p1:created_on>8.1</d2p1:created_on>
      <d2p1:description>sample string 4</d2p1:description>
      <d2p1:dropped_on>1.1</d2p1:dropped_on>
      <d2p1:end_date>1.1</d2p1:end_date>
      <d2p1:group_id>1</d2p1:group_id>
      <d2p1:group_type>sample string 5</d2p1:group_type>
      <d2p1:image_url>sample string 12</d2p1:image_url>
      <d2p1:invite_code>sample string 6</d2p1:invite_code>
      <d2p1:invite_url>sample string 13</d2p1:invite_url>
      <d2p1:is_active>true</d2p1:is_active>
      <d2p1:is_deleted>true</d2p1:is_deleted>
      <d2p1:is_dropped>true</d2p1:is_dropped>
      <d2p1:is_started>true</d2p1:is_started>
      <d2p1:members>
        <d2p1:group_member>
          <d2p1:country_code>sample string 6</d2p1:country_code>
          <d2p1:display_name>sample string 5</d2p1:display_name>
          <d2p1:dropped_on>1.1</d2p1:dropped_on>
          <d2p1:goal>
            <d2p1:avg_weight_per_week>11</d2p1:avg_weight_per_week>
            <d2p1:bodyfat>1</d2p1:bodyfat>
            <d2p1:calories>8</d2p1:calories>
            <d2p1:distance>9</d2p1:distance>
            <d2p1:goal_id>1</d2p1:goal_id>
            <d2p1:goal_type>sample string 4</d2p1:goal_type>
            <d2p1:group_id>2</d2p1:group_id>
            <d2p1:inserted_on>12.1</d2p1:inserted_on>
            <d2p1:no_of_days_goal>10</d2p1:no_of_days_goal>
            <d2p1:starting_weight>1</d2p1:starting_weight>
            <d2p1:steps>5</d2p1:steps>
            <d2p1:updated_on>13.1</d2p1:updated_on>
            <d2p1:user_id>3</d2p1:user_id>
            <d2p1:water_intake>7</d2p1:water_intake>
            <d2p1:weight>6</d2p1:weight>
          </d2p1:goal>
          <d2p1:goals_updated>true</d2p1:goals_updated>
          <d2p1:group_id>2</d2p1:group_id>
          <d2p1:group_member_id>1</d2p1:group_member_id>
          <d2p1:image_url>sample string 17</d2p1:image_url>
          <d2p1:inserted_on>11.1</d2p1:inserted_on>
          <d2p1:is_dropped>true</d2p1:is_dropped>
          <d2p1:is_leader>true</d2p1:is_leader>
          <d2p1:is_left>true</d2p1:is_left>
          <d2p1:is_removed>true</d2p1:is_removed>
          <d2p1:left_on>1.1</d2p1:left_on>
          <d2p1:mobile_number>sample string 7</d2p1:mobile_number>
          <d2p1:removed_by_id>15</d2p1:removed_by_id>
          <d2p1:removed_on>1.1</d2p1:removed_on>
          <d2p1:uid>sample string 4</d2p1:uid>
          <d2p1:updated_on>13.1</d2p1:updated_on>
          <d2p1:user_id>3</d2p1:user_id>
        </d2p1:group_member>
        <d2p1:group_member>
          <d2p1:country_code>sample string 6</d2p1:country_code>
          <d2p1:display_name>sample string 5</d2p1:display_name>
          <d2p1:dropped_on>1.1</d2p1:dropped_on>
          <d2p1:goal>
            <d2p1:avg_weight_per_week>11</d2p1:avg_weight_per_week>
            <d2p1:bodyfat>1</d2p1:bodyfat>
            <d2p1:calories>8</d2p1:calories>
            <d2p1:distance>9</d2p1:distance>
            <d2p1:goal_id>1</d2p1:goal_id>
            <d2p1:goal_type>sample string 4</d2p1:goal_type>
            <d2p1:group_id>2</d2p1:group_id>
            <d2p1:inserted_on>12.1</d2p1:inserted_on>
            <d2p1:no_of_days_goal>10</d2p1:no_of_days_goal>
            <d2p1:starting_weight>1</d2p1:starting_weight>
            <d2p1:steps>5</d2p1:steps>
            <d2p1:updated_on>13.1</d2p1:updated_on>
            <d2p1:user_id>3</d2p1:user_id>
            <d2p1:water_intake>7</d2p1:water_intake>
            <d2p1:weight>6</d2p1:weight>
          </d2p1:goal>
          <d2p1:goals_updated>true</d2p1:goals_updated>
          <d2p1:group_id>2</d2p1:group_id>
          <d2p1:group_member_id>1</d2p1:group_member_id>
          <d2p1:image_url>sample string 17</d2p1:image_url>
          <d2p1:inserted_on>11.1</d2p1:inserted_on>
          <d2p1:is_dropped>true</d2p1:is_dropped>
          <d2p1:is_leader>true</d2p1:is_leader>
          <d2p1:is_left>true</d2p1:is_left>
          <d2p1:is_removed>true</d2p1:is_removed>
          <d2p1:left_on>1.1</d2p1:left_on>
          <d2p1:mobile_number>sample string 7</d2p1:mobile_number>
          <d2p1:removed_by_id>15</d2p1:removed_by_id>
          <d2p1:removed_on>1.1</d2p1:removed_on>
          <d2p1:uid>sample string 4</d2p1:uid>
          <d2p1:updated_on>13.1</d2p1:updated_on>
          <d2p1:user_id>3</d2p1:user_id>
        </d2p1:group_member>
      </d2p1:members>
      <d2p1:minimum_req_member>14</d2p1:minimum_req_member>
      <d2p1:no_of_days>1</d2p1:no_of_days>
      <d2p1:no_of_members>1</d2p1:no_of_members>
      <d2p1:org_branch_id>1</d2p1:org_branch_id>
      <d2p1:org_id>1</d2p1:org_id>
      <d2p1:org_member_id>1</d2p1:org_member_id>
      <d2p1:prize>sample string 15</d2p1:prize>
      <d2p1:start_date>1.1</d2p1:start_date>
      <d2p1:title>sample string 3</d2p1:title>
      <d2p1:uid>sample string 2</d2p1:uid>
      <d2p1:updated_on>10.1</d2p1:updated_on>
      <d2p1:user_id>1</d2p1:user_id>
    </d2p1:group>
  </groups>
</groups_resp>