Reference

Surveyrun

The surveyrun object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this surveyrun
CoworkerId: Id required
MailingDate: DateTime? optional
Submitted: bool optional
SurveyId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this surveyrun
SystemId: string optional api-only
User defined data about this surveyrun. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "CoworkerId": 12345678,
  "MailingDate": ,
  "Submitted": false,
  "SurveyId": 12345678,
  "UniqueId": "38b57c5c-bd49-4644-aa72-9510d54e5c88",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a SurveyRun

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

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

πŸ”’ Requires role "SurveyRun-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 surveyrun records based on their different properties.
Id number
?Id=12345678
SurveyRun_Coworker Coworker
?SurveyRun_Coworker=...
SurveyRun_MailingDate DateTime?
?SurveyRun_MailingDate=...
SurveyRun_Submitted bool
?SurveyRun_Submitted=...
SurveyRun_Survey Survey
?SurveyRun_Survey=...

Range search querystring parameters
Lets you search surveyrun records based on a range of date or numeric values.
To_SurveyRun_CreatedOn date
?To_SurveyRun_CreatedOn=2010-01-01T20:32
From_SurveyRun_CreatedOn date
?From_SurveyRun_CreatedOn=2010-01-01T20:32
To_SurveyRun_UpdatedOn date
?To_SurveyRun_UpdatedOn=2010-01-01T20:32
From_SurveyRun_UpdatedOn date
?From_SurveyRun_UpdatedOn=2010-01-01T20:32
To_SurveyRun_MailingDate date
?To_SurveyRun_MailingDate=2010-01-01T20:32
From_SurveyRun_MailingDate date
?From_SurveyRun_MailingDate=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Survey": ,
        "MailingDate": ,
        "Submitted": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "1838f162-f43c-4932-a308-ad3e8924f0f4",
        "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 SurveyRuns by IDs

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

πŸ”’ Requires role "SurveyRun-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Survey": ,
        "MailingDate": ,
        "Submitted": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "7bd06c7b-7b36-46ee-936b-ac11aed7cb88",
        "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 SurveyRun by Id

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

πŸ”’ Requires role "SurveyRun-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CoworkerId": 12345678,
  "MailingDate": ,
  "Submitted": false,
  "SurveyId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "81cff7d4-2acf-4a1e-9314-48a74acdb69e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new SurveyRun

Creates a new surveyrun.
POST https://spaces.nexudus.com/api/content/surveyruns

πŸ”’ Requires role "SurveyRun-Create"

Body parameters
CoworkerId: number required
SurveyId: number required
MailingDate: DateTime? optional
Submitted: bool optional

Example request

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

{
    "CoworkerId": 12345678,
    "SurveyId": 12345678,
    "MailingDate": ,
    "Submitted": false,
}


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 SurveyRun

Updates an existing surveyrun.
PUT https://spaces.nexudus.com/api/content/surveyruns

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

πŸ”’ Requires role "SurveyRun-Edit"

Body parameters
Id: number required
The unique Id of the surveyrun to update.
CoworkerId: number cleared if missing
SurveyId: number cleared if missing
MailingDate: DateTime? cleared if missing
Submitted: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "CoworkerId": 12345678,
    "SurveyId": 12345678,
    "MailingDate": ,
    "Submitted": false,
}


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 SurveyRun

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

πŸ”’ Requires role "SurveyRun-Delete"

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

Example request

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

Example request

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

Example request

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


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.