GET groups

Back

GET groups

Web group list

Intro version: 8.01.0002

Request

URL parameters

None.

Response

GroupsResult

Name	Description	Type
group	Web group list	Collection of Group
returncode	Return code: 0 for success	integer
returnmsg	Return message	string
warnings	Warnings (the instruction worked but you need to pay attention to warnings. May cause partial data loss (Truncation))	Collection of string
version	API version	string

Return format

application/json, text/json, application/x-www-form-urlencoded

Sample:

{
  "group": [
    {
      "seq": 1,
      "groupid_1": 2,
      "parentgroupid": 3,
      "code": "sample string 4",
      "shortdesc_fr": "sample string 5",
      "shortdesc_en": "sample string 6",
      "desc_fr": "sample string 7",
      "desc_en": "sample string 8",
      "longdesc_fr": "sample string 9",
      "longdesc_en": "sample string 10",
      "isgroupevedette": 11,
      "isactiveweb": 12
    },
    {
      "seq": 1,
      "groupid_1": 2,
      "parentgroupid": 3,
      "code": "sample string 4",
      "shortdesc_fr": "sample string 5",
      "shortdesc_en": "sample string 6",
      "desc_fr": "sample string 7",
      "desc_en": "sample string 8",
      "longdesc_fr": "sample string 9",
      "longdesc_en": "sample string 10",
      "isgroupevedette": 11,
      "isactiveweb": 12
    }
  ],
  "returncode": 1,
  "returnmsg": "sample string 2",
  "warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "version": "sample string 3"
}

application/xml, text/xml

Sample:

<result returncode="1" returnmsg="sample string 2" version="sample string 3">
  <warnings>sample string 1</warnings>
  <warnings>sample string 2</warnings>
  <group seq="1" groupid_1="2" parentgroupid="3" code="sample string 4" shortdesc_fr="sample string 5" shortdesc_en="sample string 6" desc_fr="sample string 7" desc_en="sample string 8" longdesc_fr="sample string 9" longdesc_en="sample string 10" isgroupevedette="11" isactiveweb="12" />
  <group seq="1" groupid_1="2" parentgroupid="3" code="sample string 4" shortdesc_fr="sample string 5" shortdesc_en="sample string 6" desc_fr="sample string 7" desc_en="sample string 8" longdesc_fr="sample string 9" longdesc_en="sample string 10" isgroupevedette="11" isactiveweb="12" />
</result>