Reference

Subscriberactivity

The subscriberactivity object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this subscriberactivity
ActiviyType: Nexudus.Coworking.Core.Enums.eActiviyType optional
Data: string required
NewsLetterId: Id optional
NewsLetterSubscriberId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this subscriberactivity
SystemId: string optional api-only
User defined data about this subscriberactivity. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ActiviyType": 1,
  "Data": "Joe",
  "NewsLetterId": 12345678,
  "NewsLetterSubscriberId": 12345678,
  "UniqueId": "9834e388-0ee9-4deb-99d4-8974ee526a83",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a SubscriberActivity

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

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

๐Ÿ”’ Requires role "SubscriberActivity-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 subscriberactivity records based on their different properties.
Id number
?Id=12345678
SubscriberActivity_ActiviyType Nexudus.Coworking.Core.Enums.eActiviyType
?SubscriberActivity_ActiviyType=...
SubscriberActivity_Data string
?SubscriberActivity_Data=...
SubscriberActivity_NewsLetter NewsLetter
?SubscriberActivity_NewsLetter=...
SubscriberActivity_NewsLetterSubscriber NewsLetterSubscriber
?SubscriberActivity_NewsLetterSubscriber=...

Range search querystring parameters
Lets you search subscriberactivity records based on a range of date or numeric values.
To_SubscriberActivity_CreatedOn date
?To_SubscriberActivity_CreatedOn=2010-01-01T20:32
From_SubscriberActivity_CreatedOn date
?From_SubscriberActivity_CreatedOn=2010-01-01T20:32
To_SubscriberActivity_UpdatedOn date
?To_SubscriberActivity_UpdatedOn=2010-01-01T20:32
From_SubscriberActivity_UpdatedOn date
?From_SubscriberActivity_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "NewsLetterSubscriber": ,
        "NewsLetter": ,
        "ActiviyType": 1,
        "Data": "Joe",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "65b339a1-6bce-44c7-8669-4b81daa04d89",
        "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 SubscriberActivities by IDs

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

๐Ÿ”’ Requires role "SubscriberActivity-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "NewsLetterSubscriber": ,
        "NewsLetter": ,
        "ActiviyType": 1,
        "Data": "Joe",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "0d68c27d-f32f-4f07-ba00-b03d652f72e2",
        "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 SubscriberActivity by Id

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

๐Ÿ”’ Requires role "SubscriberActivity-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ActiviyType": 1,
  "Data": "Joe",
  "NewsLetterId": 12345678,
  "NewsLetterSubscriberId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "5d26bbbf-506c-4bcf-a63d-eef4ae0c3c25",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new SubscriberActivity

Creates a new subscriberactivity.
POST https://spaces.nexudus.com/api/content/subscriberactivities

๐Ÿ”’ Requires role "SubscriberActivity-Create"

Body parameters
NewsLetterSubscriberId: number required
NewsLetterId: number optional
ActiviyType: Nexudus.Coworking.Core.Enums.eActiviyType optional
Data: string required

Example request

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

{
    "NewsLetterSubscriberId": 12345678,
    "NewsLetterId": 12345678,
    "ActiviyType": 1, //(check Enumerated values section below)
    "Data": "Joe",
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more subscriberactivity 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 subscriberactivity records.
GET https://spaces.nexudus.com/api/content/subscriberactivities/commands

Example request

GET https://spaces.nexudus.com/api/content/subscriberactivities/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 subscriberactivity record IDs.
POST https://spaces.nexudus.com/api/content/subscriberactivities/runacommand
๐Ÿ”’ Requires role "SubscriberActivity-Edit"

Example request

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

ActiviyType

GET /api/utils/enums?name=eActiviyType

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.