Bookmark

Method: get

Authorization is required. Bookmarks are links to web pages that the group administrators consider of interest to the community

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/bookmark/{bookmarkId}

Parameters

propertyvaluedescription
bookmarkId integer The bookmark'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": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": {},
  "object": {
    "id": 1,
    "type": "bookmark",
    "group": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "fugiat",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "description": "ex minim",
    "url": "http://www.microsoft.com",
    "targetBlank": true,
    "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 bookmark Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
url string the record's URL field
description string The record's description field.
targetBlank boolean How to set up the target attribute of the bookmark link. If true, the link will be opened in a new browser's tab (target = "_blank")

Method: list

Authorization is required. Bookmarks are links to web pages that the group administrators consider of interest to the community

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The bookmarks 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": "Esse anim incididunt duis nostrud veniam nisi ut non in duis dolor cupidatat enim.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": {},
  "object": {
    "offset": 969,
    "bookmarks": [
      {
        "id": 1,
        "type": "bookmark",
        "group": {
          "id": "83acbf0f-b920-4ecb-a61e-e85bbfaaa52f",
          "name": "ea",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        },
        "description": "quis dolor",
        "url": "http://www.microsoft.com",
        "targetBlank": true,
        "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 bookmark Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
url string the record's URL field
description string The record's description field.
targetBlank boolean How to set up the target attribute of the bookmark link. If true, the link will be opened in a new browser's tab (target = "_blank")

Method: create

Authorization is required.

Request

HTTP request

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

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupId guid In which group to create the record
description string The bookmarks description field
url string The URL address of the bookmark - static or relative
targetBlank boolean How to set up the target attribute of the bookmark link. If true, the link will be opened in a new browser's tab (target = "_blank")

Response

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

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": false,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "url",
      "value": "",
      "message": "URL cannot be blank"
    },
    {
      "key": "targetBlank",
      "value": "",
      "message": "some sample error"
    }
  ],
  "object": {
    "id": 1,
    "type": "bookmark",
    "group": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "fugiat",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "description": "ex minim",
    "url": "http://www.microsoft.com",
    "targetBlank": true,
    "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.
id integer The bookmark Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
url string the record's URL field
description string The record's description field.
targetBlank boolean How to set up the target attribute of the bookmark link. If true, the link will be opened in a new browser's tab (target = "_blank")

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/bookmark/{bookmarkId}

Parameters

propertyvaluedescription
bookmarkId integer The bookmark's ID

Request body

propertyvaluedescription
groupId guid In which group to create the record
description string The bookmarks description field
url string The URL address of the bookmark - static or relative
targetBlank boolean How to set up the target attribute of the bookmark link. If true, the link will be opened in a new browser's tab (target = "_blank")

Response

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

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": false,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "url",
      "value": "",
      "message": "URL cannot be blank"
    },
    {
      "key": "targetBlank",
      "value": "",
      "message": "some sample error"
    }
  ],
  "object": {
    "id": 1,
    "type": "bookmark",
    "group": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "fugiat",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "description": "ex minim",
    "url": "http://www.microsoft.com",
    "targetBlank": true,
    "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 the object 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.
id integer The bookmark Id
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
url string the record's URL field
description string The record's description field.
targetBlank boolean How to set up the target attribute of the bookmark link. If true, the link will be opened in a new browser's tab (target = "_blank")

Method: delete

Authorization is required.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/bookmark/{bookmarkId}

Parameters

propertyvaluedescription
bookmarkId integer The bookmark'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:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": false,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "url",
      "value": "",
      "message": "URL cannot be blank"
    },
    {
      "key": "targetBlank",
      "value": "",
      "message": "some sample error"
    }
  ],
  "object": {
    "id": 1,
    "type": "bookmark",
    "group": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "fugiat",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "description": "ex minim",
    "url": "http://www.microsoft.com",
    "targetBlank": true,
    "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