User

Method: user list

Authorization is required. Group administrator's privileges required.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The elements 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
role integer Id of the role. Alternatives are:
  • 0 - all roles
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
target string Where to look for the filter. Alternatives are:
  • name
  • email

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": "Qui Lorem velit laborum aute duis sunt.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": "bec18635-4897-4e41-8012-8658e007df7e",
    "members": [
      {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 5,
        "roleName": "administrator",
        "blocked": false,
        "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 guid The user Id
alias string The user's screen name
email string The email of the user
photoUrl string path to the user's photo
memberSince date When he became member of this group in UTC time zone and ISO 8601 format string
roleId integer The user role in this group. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
roleName string The user role's name
blocked boolean Is this account blocked or not in this group and its subgroups

Method: unapproved registrations list

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/user/list/unapproved?offset={offset}&pageSize={pageSize}&filter={filter}&target={target}

Parameters

propertyvaluedescription
groupId guid The elements 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
target string Where to look for the filter. Alternatives are:
  • name
  • email

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": "Qui Lorem velit laborum aute duis sunt.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": "bec18635-4897-4e41-8012-8658e007df7e",
    "members": [
      {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 2,
        "roleName": "regular",
        "blocked": false,
        "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 guid The user Id
alias string The user's screen name
email string The email of the user
photoUrl string path to the user's photo
memberSince date When he became member of this group in UTC time zone and ISO 8601 format string
roleId integer The user role in this group. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
roleName string The user role's name
blocked boolean Is this account blocked or not in this group and its subgroups

Method: denied registrations list

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/user/list/denied?offset={offset}&pageSize={pageSize}&filter={filter}&target={target}

Parameters

propertyvaluedescription
groupId guid The elements 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
target string Where to look for the filter. Alternatives are:
  • name
  • email

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": "Qui Lorem velit laborum aute duis sunt.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": "bec18635-4897-4e41-8012-8658e007df7e",
    "members": [
      {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 2,
        "roleName": "regular",
        "blocked": false,
        "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 guid The user Id
alias string The user's screen name
email string The email of the user
photoUrl string path to the user's photo
memberSince date When he became member of this group in UTC time zone and ISO 8601 format string
roleId integer The user role in this group. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
roleName string The user role's name
blocked boolean Is this account blocked or not in this group and its subgroups

Method: registrations with unverified emails list

Authorization is required. Group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/user/list/unverified/group/?offset={offset}&pageSize={pageSize}&filter={filter}&target={target}

Parameters

propertyvaluedescription
groupId guid The elements 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
target string Where to look for the filter. Alternatives are:
  • name
  • email

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": "Qui Lorem velit laborum aute duis sunt.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": "bec18635-4897-4e41-8012-8658e007df7e",
    "members": [
      {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 2,
        "roleName": "regular",
        "blocked": false,
        "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 guid The user Id
alias string The user's screen name
email string The email of the user
photoUrl string path to the user's photo
memberSince date When he became member of this group in UTC time zone and ISO 8601 format string
roleId integer The user role in this group. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
roleName string The user role's name
blocked boolean Is this account blocked or not in this group and its subgroups

Method: get

Authorization is required. Group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}?group={groupId}

Parameters

propertyvaluedescription
userId guid The users's ID
groupId guid The group for which you want to get the user's details

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": [],
  "object": {
    "id": "bec18635-4897-4e41-8012-8658e007df7e",
    "type": "member",
    "alias": "Boz Zashev",
    "email": "lottrobinson@isoplex.com",
    "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
    "memberSince": "2014-03-03T23:20:23Z",
    "roleId": 5,
    "roleName": "administrator",
    "blocked": false,
    "profile": [],
    "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 guid The user Id
alias string The user's screen name
email string The email of the user
photoUrl string path to the user's photo
memberSince date When he became member of this group in UTC time zone and ISO 8601 format string
roleId integer The user role in this group. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
roleName string The user role's name
blocked boolean Is this account blocked or not in this group and its subgroups
profile list (object) the user's profile fields according to the Profile fields object schema

Method: get roles of user

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/role

Parameters

propertyvaluedescription
userId guid The user'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": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [],
  "object": {
    "id": "bec18635-4897-4e41-8012-8658e007df7e",
    "type": "memberGroups",
    "email": "lottrobinson@isoplex.com",
    "accessWarnings": [],
    "groups": [
      {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "name": "Home",
        "slug": "home",
        "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
        "url": "http://demo.hivesocialnow.com/Home/",
        "parent": {},
        "roleId": 5,
        "roleName": "administrator",
        "blocked": false
      }
    ]
  }
}

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

Method: check if user has right

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/right/{rightKey}/list

Parameters

propertyvaluedescription
userId guid The user's ID
rightKey integer The Id of the user right that you want to be checked, for which group the user has it

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": "Ad tempor cupidatat irure aliqua duis officia voluptate dolor aliquip.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "groups": [
      {
        "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
        "type": "group",
        "createdOn": "2014-03-03T23:20:23Z",
        "author": {
          "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
          "alias": "proident est",
          "extendedAlias": "Lorem eiusmod sint aliquip do",
          "slug": "Home",
          "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
          "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
        },
        "slug": "home",
        "url": "http://demo.hivesocialnow.com/Home/",
        "name": "Home",
        "description": "Sunt sint excepteur ullamco elit consequat et.",
        "parent": {},
        "typeId": 39,
        "typeName": "ea",
        "private": false,
        "premiumPackages": [],
        "logoUrl": "http://localhost/HS4/ContentServer/logo/78_635267293401000000.gif",
        "logoAltText": "nisi ipsum consequat reprehenderit enim",
        "logoLinkUrl": "/Home/",
        "logoVisible": true,
        "thumbUrl": "http://southviewchurch.com/wp-content/uploads/2013/07/Lead-a-Small-Group-Button.png",
        "thumbAltText": "duis mollit velit ea culpa",
        "favIconUrl": "http://localhost/HS4/ContentServer/logo/78_635267293401000000.gif",
        "themeName": "Default",
        "groupEmail": "admin@admin.com",
        "groupEmailName": "reprehenderit",
        "groupEmailNewsletterName": "excepteur",
        "layoutId": 4,
        "layoutName": "two columns",
        "commentsViewTypeId": 2,
        "commentsViewTypeName": "nisi",
        "invisibleInGroupListModule": false,
        "postVoteControlVisible": false,
        "postTweetControlVisible": false,
        "postShareControlVisible": true,
        "postStatusVisible": true,
        "pollId": 43,
        "accessWarnings": []
      }
    ]
  }
}

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

Method: update

Authorization is required. Group administrator's privileges required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}

Parameters

propertyvaluedescription
userId guid In id of the updated record

Request body

propertyvaluedescription
groupId guid For which group to update the record
roleId integer The new role for this group. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
blocked boolean Whether the user account is blocked for this group and its subgroups

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": [],
  "object": {
    "id": "bec18635-4897-4e41-8012-8658e007df7e",
    "type": "member",
    "alias": "in consequat",
    "email": "lottrobinson@isoplex.com",
    "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
    "memberSince": "2014-03-03T23:20:23Z",
    "roleId": 5,
    "roleName": "administrator",
    "blocked": false,
    "accessWarnings": []
  }
}

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

Method: bulk user roles update

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/bulk-roles

Parameters

propertyvaluedescription
userId guid In id of the user

Request body

propertyvaluedescription
roleId integer The new role for the selected groups. Alternatives are:
  • 2 - regular
  • 3 - member
  • 4 - moderator
  • 5 - administrator
groups list (guid) For which groups to change the role as a guid list

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":"roleId",
		"value":"",
		"message": "Role cannot be blank"
		}],
	"object": {
	}
}

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

Method: approve user registration

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/approve

Parameters

propertyvaluedescription
userId guid The user account id that needs to be approved

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":[],
	"object": {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 5,
        "roleName": "administrator",
        "blocked": false,
        "accessWarnings": []
	}
}

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

Method: deny user registration

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/deny

Parameters

propertyvaluedescription
userId guid The user account id that needs to be denied

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":[],
	"object": {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 5,
        "roleName": "administrator",
        "blocked": false,
        "accessWarnings": []
	}
}

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

Method: resend verification email

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/resend-verification

Parameters

propertyvaluedescription
userId guid The user account id that needs to have its verification email resend

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":[],
	"object": {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 5,
        "roleName": "administrator",
        "blocked": false,
        "accessWarnings": []
	}
}

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

Method: verify email

Authorization is required. Root group administrator's privileges required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/user/{userId}/verify-email

Parameters

propertyvaluedescription
userId guid The user account id that needs to have its email verified

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":[],
	"object": {
        "id": "bec18635-4897-4e41-8012-8658e007df7e",
        "type": "member",
        "alias": "in consequat",
        "email": "lottrobinson@isoplex.com",
        "photoUrl": "/HS4/ContentServer/avatar/786499b2-1499-48ac-ab7e-09b1247361c9.jpg",
        "memberSince": "2014-03-03T23:20:23Z",
        "roleId": 5,
        "roleName": "administrator",
        "blocked": false,
        "accessWarnings": []
	}
}

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