Reference

Communityperk

The communityperk object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this communityperk
Active: bool optional
BusinessId: Id required
ClickCount: int required
DisplayOrder: int required
FullText: string optional
GroupName: string optional
PerkUrl: string required
ShowInHomePage: bool optional
SummaryText: string optional
Title: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this communityperk
SystemId: string optional api-only
User defined data about this communityperk. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "ClickCount": ,
  "DisplayOrder": ,
  "FullText": "LongText",
  "GroupName": "Short",
  "PerkUrl": "Url",
  "ShowInHomePage": false,
  "SummaryText": "ShortText",
  "Title": "Title",
  "UniqueId": "242aa099-b5aa-46ca-a34a-eb35b76d91c7",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CommunityPerk

This endpoint allows you to GET a list of communityperks based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/content/communityperks?...

πŸ”’ Requires role "CommunityPerk-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search communityperk records based on their different properties.
Id number
?Id=12345678
CommunityPerk_Active bool
?CommunityPerk_Active=...
CommunityPerk_Business Business
?CommunityPerk_Business=...
CommunityPerk_ClickCount int
?CommunityPerk_ClickCount=...
CommunityPerk_DisplayOrder int
?CommunityPerk_DisplayOrder=...
CommunityPerk_FullText string
?CommunityPerk_FullText=...
CommunityPerk_GroupName string
?CommunityPerk_GroupName=...
CommunityPerk_PerkUrl string
?CommunityPerk_PerkUrl=...
CommunityPerk_ShowInHomePage bool
?CommunityPerk_ShowInHomePage=...
CommunityPerk_SummaryText string
?CommunityPerk_SummaryText=...
CommunityPerk_Title string
?CommunityPerk_Title=...

Range search querystring parameters
Lets you search communityperk records based on a range of date or numeric values.
To_CommunityPerk_CreatedOn date
?To_CommunityPerk_CreatedOn=2010-01-01T20:32
From_CommunityPerk_CreatedOn date
?From_CommunityPerk_CreatedOn=2010-01-01T20:32
To_CommunityPerk_UpdatedOn date
?To_CommunityPerk_UpdatedOn=2010-01-01T20:32
From_CommunityPerk_UpdatedOn date
?From_CommunityPerk_UpdatedOn=2010-01-01T20:32
To_CommunityPerk_DisplayOrder number
?To_CommunityPerk_DisplayOrder=0
From_CommunityPerk_DisplayOrder number
?From_CommunityPerk_DisplayOrder=10
To_CommunityPerk_ClickCount number
?To_CommunityPerk_ClickCount=0
From_CommunityPerk_ClickCount number
?From_CommunityPerk_ClickCount=10

Example request

GET https://spaces.nexudus.com/api/content/communityperks?CommunityPerk_Title=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Title": "Title",
        "PerkUrl": "Url",
        "SummaryText": "ShortText",
        "FullText": "LongText",
        "Active": false,
        "GroupName": "Short",
        "DisplayOrder": ,
        "ShowInHomePage": false,
        "ClickCount": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "31beee88-d8e0-407c-9811-c41dc1646fed",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find CommunityPerks by IDs

Gets one or more communityperk records based on their Id.
GET https://spaces.nexudus.com/api/content/communityperks?CommunityPerk_Id=[:id1,:id2,...]

πŸ”’ Requires role "CommunityPerk-List"

Querystring parameters
CommunityPerk_Id: array requried
?CommunityPerk_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/content/communityperks?CommunityPerk_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Title": "Title",
        "PerkUrl": "Url",
        "SummaryText": "ShortText",
        "FullText": "LongText",
        "Active": false,
        "GroupName": "Short",
        "DisplayOrder": ,
        "ShowInHomePage": false,
        "ClickCount": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b33f51c8-8d64-4daa-b438-4a05445efc50",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CommunityPerk by Id

Gets one communityperk record by its Id.
GET https://spaces.nexudus.com/api/content/communityperks/:Id

πŸ”’ Requires role "CommunityPerk-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/content/communityperks/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "ClickCount": ,
  "DisplayOrder": ,
  "FullText": "LongText",
  "GroupName": "Short",
  "PerkUrl": "Url",
  "ShowInHomePage": false,
  "SummaryText": "ShortText",
  "Title": "Title",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "40056be4-0e14-42a5-b6a9-d013c6a5e1ba",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CommunityPerk

Creates a new communityperk.
POST https://spaces.nexudus.com/api/content/communityperks

πŸ”’ Requires role "CommunityPerk-Create"

Body parameters
BusinessId: number required
Title: string required
PerkUrl: string required
SummaryText: string optional
FullText: string optional
Active: bool optional
GroupName: string optional
DisplayOrder: int required
ShowInHomePage: bool optional
ClickCount: int required

Example request

POST https://spaces.nexudus.com/api/content/communityperks
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Title": "Title",
    "PerkUrl": "Url",
    "SummaryText": "ShortText",
    "FullText": "LongText",
    "Active": false,
    "GroupName": "Short",
    "DisplayOrder": ,
    "ShowInHomePage": false,
    "ClickCount": ,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update CommunityPerk

Updates an existing communityperk.
PUT https://spaces.nexudus.com/api/content/communityperks

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "CommunityPerk-Edit"

Body parameters
Id: number required
The unique Id of the communityperk to update.
BusinessId: number cleared if missing
Title: string cleared if missing
PerkUrl: string cleared if missing
SummaryText: string cleared if missing
FullText: string cleared if missing
Active: bool cleared if missing
GroupName: string cleared if missing
DisplayOrder: int cleared if missing
ShowInHomePage: bool cleared if missing
ClickCount: int cleared if missing

Example request

PUT https://spaces.nexudus.com/api/content/communityperks
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Title": "Title",
    "PerkUrl": "Url",
    "SummaryText": "ShortText",
    "FullText": "LongText",
    "Active": false,
    "GroupName": "Short",
    "DisplayOrder": ,
    "ShowInHomePage": false,
    "ClickCount": ,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete CommunityPerk

Deletes an existing communityperk by its Id.
DELETE https://spaces.nexudus.com/api/content/communityperks/:Id

πŸ”’ Requires role "CommunityPerk-Delete"

URL parameters
Id: number required
The unique Id of the communityperk to update.

Example request

DELETE https://spaces.nexudus.com/api/content/communityperks/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more communityperk records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for communityperk records.
GET https://spaces.nexudus.com/api/content/communityperks/commands

Example request

GET https://spaces.nexudus.com/api/content/communityperks/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more communityperk record IDs.
POST https://spaces.nexudus.com/api/content/communityperks/runacommand
πŸ”’ Requires role "CommunityPerk-Edit"

Example request

POST https://spaces.nexudus.com/api/content/communityperks/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

Image

GET https://spaces.nexudus.com/api/content/communityperks/getimage/:id
URL parameters
Id: number required
The id of the CommunityPerk to get the image for.

LargeImage

GET https://spaces.nexudus.com/api/content/communityperks/getlargeimage/:id
URL parameters
Id: number required
The id of the CommunityPerk to get the largeimage for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.