Reference

Blogpost

The blogpost object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this blogpost
AllowComments: bool optional
BusinessId: Id required
CommentsCount: int required
FullText: string optional
LanguageId: Id optional
PostedById: Id optional
PublishDate: DateTime? optional
ShowInHomeBanner: bool optional
ShowInHomePage: bool optional
SummaryText: string optional
Title: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this blogpost
SystemId: string optional api-only
User defined data about this blogpost. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AllowComments": false,
  "BusinessId": 12345678,
  "CommentsCount": ,
  "FullText": "LongText",
  "LanguageId": 12345678,
  "PostedById": 12345678,
  "PublishDate": ,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "SummaryText": "ShortText",
  "Title": "Title",
  "UniqueId": "1b0691a0-06ca-42f7-a6d5-f7030b31e26e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a BlogPost

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

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

πŸ”’ Requires role "BlogPost-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 blogpost records based on their different properties.
Id number
?Id=12345678
BlogPost_AllowComments bool
?BlogPost_AllowComments=...
BlogPost_Business Business
?BlogPost_Business=...
BlogPost_CommentsCount int
?BlogPost_CommentsCount=...
BlogPost_FullText string
?BlogPost_FullText=...
BlogPost_Language Language
?BlogPost_Language=...
BlogPost_PostedBy User
?BlogPost_PostedBy=...
BlogPost_PublishDate DateTime?
?BlogPost_PublishDate=...
BlogPost_ShowInHomeBanner bool
?BlogPost_ShowInHomeBanner=...
BlogPost_ShowInHomePage bool
?BlogPost_ShowInHomePage=...
BlogPost_SummaryText string
?BlogPost_SummaryText=...
BlogPost_Title string
?BlogPost_Title=...
BlogPost_PostedByFullName string
?BlogPost_PostedByFullName=...
BlogPost_BlogCategories List of BlogCategory
?BlogPost_BlogCategories=...

Range search querystring parameters
Lets you search blogpost records based on a range of date or numeric values.
To_BlogPost_CreatedOn date
?To_BlogPost_CreatedOn=2010-01-01T20:32
From_BlogPost_CreatedOn date
?From_BlogPost_CreatedOn=2010-01-01T20:32
To_BlogPost_UpdatedOn date
?To_BlogPost_UpdatedOn=2010-01-01T20:32
From_BlogPost_UpdatedOn date
?From_BlogPost_UpdatedOn=2010-01-01T20:32
To_BlogPost_PublishDate date
?To_BlogPost_PublishDate=2010-01-01T20:32
From_BlogPost_PublishDate date
?From_BlogPost_PublishDate=2010-01-01T20:32
To_BlogPost_CommentsCount number
?To_BlogPost_CommentsCount=0
From_BlogPost_CommentsCount number
?From_BlogPost_CommentsCount=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Language": ,
        "PostedBy": ,
        "Title": "Title",
        "SummaryText": "ShortText",
        "FullText": "LongText",
        "PublishDate": ,
        "ShowInHomeBanner": false,
        "ShowInHomePage": false,
        "AllowComments": false,
        "CommentsCount": ,
        "BlogPostPostedByFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e51d3c7b-b18c-42bc-b0df-c79e2ab48148",
        "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 BlogPosts by IDs

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

πŸ”’ Requires role "BlogPost-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Language": ,
        "PostedBy": ,
        "Title": "Title",
        "SummaryText": "ShortText",
        "FullText": "LongText",
        "PublishDate": ,
        "ShowInHomeBanner": false,
        "ShowInHomePage": false,
        "AllowComments": false,
        "CommentsCount": ,
        "BlogPostPostedByFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "3401fe38-e515-41b3-a138-1e7df2e30d75",
        "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 BlogPost by Id

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

πŸ”’ Requires role "BlogPost-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "AllowComments": false,
  "BusinessId": 12345678,
  "CommentsCount": ,
  "FullText": "LongText",
  "LanguageId": 12345678,
  "PostedById": 12345678,
  "PublishDate": ,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "SummaryText": "ShortText",
  "Title": "Title",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "94ffc407-10e3-4795-8544-7625cf2d8d54",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new BlogPost

Creates a new blogpost.
POST https://spaces.nexudus.com/api/content/blogposts

πŸ”’ Requires role "BlogPost-Create"

Body parameters
BusinessId: number required
LanguageId: number optional
PostedById: number optional
Title: string required
SummaryText: string optional
FullText: string optional
PublishDate: DateTime? optional
ShowInHomeBanner: bool optional
ShowInHomePage: bool optional
AllowComments: bool optional
CommentsCount: int required

Example request

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

{
    "BusinessId": 12345678,
    "LanguageId": 12345678,
    "PostedById": 12345678,
    "Title": "Title",
    "SummaryText": "ShortText",
    "FullText": "LongText",
    "PublishDate": ,
    "ShowInHomeBanner": false,
    "ShowInHomePage": false,
    "AllowComments": false,
    "BlogCategories": [12345678, 87654321],
    "CommentsCount": ,
}


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 BlogPost

Updates an existing blogpost.
PUT https://spaces.nexudus.com/api/content/blogposts

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

πŸ”’ Requires role "BlogPost-Edit"

Body parameters
Id: number required
The unique Id of the blogpost to update.
BusinessId: number cleared if missing
LanguageId: number cleared if missing
PostedById: number cleared if missing
Title: string cleared if missing
SummaryText: string cleared if missing
FullText: string cleared if missing
PublishDate: DateTime? cleared if missing
ShowInHomeBanner: bool cleared if missing
ShowInHomePage: bool cleared if missing
AllowComments: bool cleared if missing
CommentsCount: int cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "LanguageId": 12345678,
    "PostedById": 12345678,
    "Title": "Title",
    "SummaryText": "ShortText",
    "FullText": "LongText",
    "PublishDate": ,
    "ShowInHomeBanner": false,
    "ShowInHomePage": false,
    "AllowComments": false,
    "BlogCategories": [12345678, 87654321],
    "CommentsCount": ,
}


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 BlogPost

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

πŸ”’ Requires role "BlogPost-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/content/blogposts/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 blogpost 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 blogpost records.
GET https://spaces.nexudus.com/api/content/blogposts/commands

Example request

GET https://spaces.nexudus.com/api/content/blogposts/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 blogpost record IDs.
POST https://spaces.nexudus.com/api/content/blogposts/runacommand
πŸ”’ Requires role "BlogPost-Edit"

Example request

POST https://spaces.nexudus.com/api/content/blogposts/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/blogposts/getimage/:id
URL parameters
Id: number required
The id of the BlogPost to get the image for.

LargeImage

GET https://spaces.nexudus.com/api/content/blogposts/getlargeimage/:id
URL parameters
Id: number required
The id of the BlogPost 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.