Reference

Newsletter

The newsletter object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this newsletter
BusinessId: Id required
Language: Nexudus.Coworking.Core.Enums.eLanguage optional
LastSent: DateTime? optional
Name: string required
NewsLetterContents: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this newsletter
SystemId: string optional api-only
User defined data about this newsletter. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Language": 1,
  "LastSent": ,
  "Name": "00001",
  "NewsLetterContents": "NewsLetterContents",
  "UniqueId": "1534d242-ad99-4647-90be-dc5c918ee171",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a NewsLetter

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

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

πŸ”’ Requires role "NewsLetter-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 newsletter records based on their different properties.
Id number
?Id=12345678
NewsLetter_Business Business
?NewsLetter_Business=...
NewsLetter_Language Nexudus.Coworking.Core.Enums.eLanguage
?NewsLetter_Language=...
NewsLetter_LastSent DateTime?
?NewsLetter_LastSent=...
NewsLetter_Name string
?NewsLetter_Name=...
NewsLetter_NewsLetterContents string
?NewsLetter_NewsLetterContents=...

Range search querystring parameters
Lets you search newsletter records based on a range of date or numeric values.
To_NewsLetter_CreatedOn date
?To_NewsLetter_CreatedOn=2010-01-01T20:32
From_NewsLetter_CreatedOn date
?From_NewsLetter_CreatedOn=2010-01-01T20:32
To_NewsLetter_UpdatedOn date
?To_NewsLetter_UpdatedOn=2010-01-01T20:32
From_NewsLetter_UpdatedOn date
?From_NewsLetter_UpdatedOn=2010-01-01T20:32
To_NewsLetter_LastSent date
?To_NewsLetter_LastSent=2010-01-01T20:32
From_NewsLetter_LastSent date
?From_NewsLetter_LastSent=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "LastSent": ,
        "Language": 1,
        "NewsLetterContents": "NewsLetterContents",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e16d2933-8292-4bec-85e6-ea5df8659cd7",
        "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 NewsLetters by IDs

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

πŸ”’ Requires role "NewsLetter-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "LastSent": ,
        "Language": 1,
        "NewsLetterContents": "NewsLetterContents",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "2ecefbf6-2f90-4841-a8b8-d426abcd29bc",
        "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 NewsLetter by Id

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

πŸ”’ Requires role "NewsLetter-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Language": 1,
  "LastSent": ,
  "Name": "00001",
  "NewsLetterContents": "NewsLetterContents",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "794bfe52-54b6-4c55-91cf-f8254eca1d5d",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new NewsLetter

Creates a new newsletter.
POST https://spaces.nexudus.com/api/content/newsletters

πŸ”’ Requires role "NewsLetter-Create"

Body parameters
BusinessId: number required
Name: string required
LastSent: DateTime? optional
Language: Nexudus.Coworking.Core.Enums.eLanguage optional
NewsLetterContents: string optional

Example request

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

{
    "BusinessId": 12345678,
    "Name": "00001",
    "LastSent": ,
    "Language": 1, //(check Enumerated values section below)
    "NewsLetterContents": "NewsLetterContents",
}


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 NewsLetter

Updates an existing newsletter.
PUT https://spaces.nexudus.com/api/content/newsletters

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

πŸ”’ Requires role "NewsLetter-Edit"

Body parameters
Id: number required
The unique Id of the newsletter to update.
BusinessId: number cleared if missing
Name: string cleared if missing
LastSent: DateTime? cleared if missing
Language: Nexudus.Coworking.Core.Enums.eLanguage cleared if missing
NewsLetterContents: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "00001",
    "LastSent": ,
    "Language": 1, //(check Enumerated values section below)
    "NewsLetterContents": "NewsLetterContents",
}


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 NewsLetter

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

πŸ”’ Requires role "NewsLetter-Delete"

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

Example request

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

Example request

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

Example request

POST https://spaces.nexudus.com/api/content/newsletters/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
}


Enumerated values

Language

GET /api/utils/enums?name=eLanguage

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.