Page

The page element in HiveSocial provides an easy way to place some static content within your groups.

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/page/list/{groupId}?offset={offset}&pageSize={pageSize}&filter={filter}

Parameters

propertyvaluedescription
groupId guid The pages group's ID
offset integer Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response.
pageSize integer How many records to be returned by the system. Usually 15
filter string Query string to be looked for when filtering the records

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Pariatur occaecat dolor anim voluptate qui.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 26,
    "pages": [
      {
        "id": 1,
        "type": "page",
        "group": {
          "id": "7a8102c3-109c-4e9b-9656-7aa4f70d69f2",
          "name": "laborum",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        },
        "title": "Proident dolore nostrud Lorem eu irure nostrud adipisicing.",
        "content": "Consectetur ipsum sunt culpa nostrud. Labore in labore veniam ut labore elit culpa consequat nostrud non fugiat. Mollit cupidatat veniam enim laboris adipisicing deserunt nulla. Qui consectetur est consequat cupidatat culpa. Velit adipisicing consequat proident aliquip exercitation excepteur. Proident et adipisicing non proident. Incididunt occaecat eiusmod in labore dolor culpa qui ipsum mollit quis ut irure in.\r\nEiusmod fugiat enim incididunt laborum anim. Sit nisi pariatur consequat id aliqua dolor adipisicing id occaecat et aliquip consectetur proident est. Magna cupidatat exercitation labore aliqua reprehenderit officia tempor occaecat laborum mollit aute. Velit mollit consectetur ullamco eiusmod.\r\n",
        "locations": [
          {
            "id": 2,
            "name": "top",
            "position": 1
          }
        ],
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
id integer The page's Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
title string the page title
content string The page content
locations list (object) List of the locations this page should be included in. The location object properties are:
  • id - The Id of the location (0,1,2,3)
  • name - The name of the location (none,bottom,top,both)
  • position - what is the page position within the location

Method: top location list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/page/list/top/{groupId}

Parameters

propertyvaluedescription
groupId guid The pages group's ID

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Pariatur occaecat dolor anim voluptate qui.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 26,
    "pages": [
      {
        "id": 1,
        "type": "page",
        "group": {
          "id": "7a8102c3-109c-4e9b-9656-7aa4f70d69f2",
          "name": "laborum",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        },
        "title": "Proident dolore nostrud Lorem eu irure nostrud adipisicing.",
        "content": "Consectetur ipsum sunt culpa nostrud. Labore in labore veniam ut labore elit culpa consequat nostrud non fugiat. Mollit cupidatat veniam enim laboris adipisicing deserunt nulla. Qui consectetur est consequat cupidatat culpa. Velit adipisicing consequat proident aliquip exercitation excepteur. Proident et adipisicing non proident. Incididunt occaecat eiusmod in labore dolor culpa qui ipsum mollit quis ut irure in.\r\nEiusmod fugiat enim incididunt laborum anim. Sit nisi pariatur consequat id aliqua dolor adipisicing id occaecat et aliquip consectetur proident est. Magna cupidatat exercitation labore aliqua reprehenderit officia tempor occaecat laborum mollit aute. Velit mollit consectetur ullamco eiusmod.\r\n",
        "locations": [
          {
            "id": 2,
            "name": "top",
            "position": 1
          }
        ],
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
id integer The page's Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
title string the page title
content string The page content
locations list (object) List of the locations this page should be included in. The location object properties are:
  • id - The Id of the location (0,1,2,3)
  • name - The name of the location (none,bottom,top,both)
  • position - what is the page position within the location

Method: bottom location list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/page/list/bottom/{groupId}

Parameters

propertyvaluedescription
groupId guid The pages group's ID

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Pariatur occaecat dolor anim voluptate qui.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 26,
    "pages": [
      {
        "id": 1,
        "type": "page",
        "group": {
          "id": "7a8102c3-109c-4e9b-9656-7aa4f70d69f2",
          "name": "laborum",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        },
        "title": "Proident dolore nostrud Lorem eu irure nostrud adipisicing.",
        "content": "Consectetur ipsum sunt culpa nostrud. Labore in labore veniam ut labore elit culpa consequat nostrud non fugiat. Mollit cupidatat veniam enim laboris adipisicing deserunt nulla. Qui consectetur est consequat cupidatat culpa. Velit adipisicing consequat proident aliquip exercitation excepteur. Proident et adipisicing non proident. Incididunt occaecat eiusmod in labore dolor culpa qui ipsum mollit quis ut irure in.\r\nEiusmod fugiat enim incididunt laborum anim. Sit nisi pariatur consequat id aliqua dolor adipisicing id occaecat et aliquip consectetur proident est. Magna cupidatat exercitation labore aliqua reprehenderit officia tempor occaecat laborum mollit aute. Velit mollit consectetur ullamco eiusmod.\r\n",
        "locations": [
          {
            "id": 2,
            "name": "top",
            "position": 1
          }
        ],
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
id integer The page's Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
title string the page title
content string The page content
locations list (object) List of the locations this page should be included in. The location object properties are:
  • id - The Id of the location (0,1,2,3)
  • name - The name of the location (none,bottom,top,both)
  • position - what is the page position within the location

Method: get

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/page/{pageId}

Parameters

propertyvaluedescription
pageId integer The page's ID

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
    "success": true,
    "message": "Amet reprehenderit ad duis ad irure qui id ut minim minim culpa officia.",
    "timestamp": "2014-03-03T23:20:23Z",
    "errors": [],
    "object": 
	{
        "id": 1,
        "type": "page",
        "group": {
            "id": "f1c3d9d7-dbbb-4796-948d-742c6b0801e9",
            "name": "qui",
            "slug": "Home",
            "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
            "url": "http://demo.hivesocialnow.com/Home/"
        },
        "title": "Non quis officia in dolore cillum mollit enim fugiat ad voluptate.",
        "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur. Do eu voluptate veniam velit tempor consequat eu dolor excepteur duis. Commodo veniam ex aliquip anim aliqua duis in sunt exercitation incididunt. Adipisicing ullamco aute est ea amet minim ipsum irure ut et nisi.\r\nAnim reprehenderit proident tempor aliqua in ex dolore amet occaecat Lorem magna id veniam. Consectetur laboris amet irure pariatur. Eiusmod dolore incididunt est irure mollit anim ullamco consequat consequat labore ex est incididunt. Labore magna sunt minim ex pariatur. Reprehenderit cupidatat proident aliqua aliquip commodo in in qui culpa labore minim consequat ex velit. Amet et officia adipisicing anim eiusmod amet exercitation est ut enim laborum ex duis. Laboris incididunt laborum sunt sunt eiusmod enim.\r\n",
        "locations": [
            {
                "id": 2,
                "name": "top",
                "position": 1
            }
        ],
        "accessWarnings": []
    }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
id integer The page's Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
title string the page title
content string The page content
locations list (object) List of the locations this page should be included in. The location object properties are:
  • id - The Id of the location (0,1,2,3)
  • name - The name of the location (none,bottom,top,both)
  • position - what is the page position within the location

Method: create

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/page

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupId guid In which group to create the page
title string The page title value
content string The page content value
locations object The selected location alternative. The properties of the object are:
  • id - The Id of the location (0,1,2,3) this ids correspond to (none,bottom,top,both)
  • position - if you want the page to be appended on the bottom of the location page list, provide null as value. If not, provide the position integer you need.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "title",
      "value": "",
      "message": "Title cannot be blank"
    }
  ],
  "object": {
    "id": 1,
    "type": "page",
    "group": {
      "id": "f1c3d9d7-dbbb-4796-948d-742c6b0801e9",
      "name": "qui",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "title": "Non quis officia in dolore cillum mollit enim fugiat ad voluptate.",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "locations": [
      {
        "id": 2,
        "name": "ullamco",
        "position": 0
      }
    ],
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/page/{pageId}

Parameters

propertyvaluedescription
pageId integer In id of the updated record

Request body

propertyvaluedescription
groupId guid To which group the page should be associated to
title string The page title value
content string The page content value
locations object The selected location alternative. The properties of the object are:
  • id - The Id of the location (0,1,2,3) this ids correspond to (none,bottom,top,both)
  • position - if you want the page to be appended on the bottom of the location page list, provide null as value. If not, provide the position integer you need.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "title",
      "value": "",
      "message": "Title cannot be blank"
    }
  ],
  "object": {
    "id": 1,
    "type": "page",
    "group": {
      "id": "f1c3d9d7-dbbb-4796-948d-742c6b0801e9",
      "name": "qui",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "title": "Non quis officia in dolore cillum mollit enim fugiat ad voluptate.",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "locations": [
      {
        "id": 2,
        "name": "ullamco",
        "position": 0
      }
    ],
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: delete

Authorization is required.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/page/{pageId}

Parameters

propertyvaluedescription
pageId integer In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "title",
      "value": "",
      "message": "Title cannot be blank"
    }
  ],
  "object": {
    "id": 1,
    "type": "page",
    "group": {
      "id": "f1c3d9d7-dbbb-4796-948d-742c6b0801e9",
      "name": "qui",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "title": "Non quis officia in dolore cillum mollit enim fugiat ad voluptate.",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "locations": [
      {
        "id": 2,
        "name": "ullamco",
        "position": 0
      }
    ],
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted