Reference

Surveyquestion

The surveyquestion object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this surveyquestion
Active: bool optional
AllowMultipleOptions: bool optional
AvailableOptions: string optional
Description: string required
DisplayOrder: int required
QuestionType: Nexudus.Coworking.Core.Enums.eQuestionType optional
SurveyId: Id required
Text: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this surveyquestion
SystemId: string optional api-only
User defined data about this surveyquestion. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "AllowMultipleOptions": false,
  "AvailableOptions": "Abc123456",
  "Description": "Abc123456",
  "DisplayOrder": ,
  "QuestionType": 1,
  "SurveyId": 12345678,
  "Text": "Abc123456",
  "UniqueId": "32d3c745-8739-488d-83eb-d943116d9944",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a SurveyQuestion

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

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

πŸ”’ Requires role "SurveyQuestion-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 surveyquestion records based on their different properties.
Id number
?Id=12345678
SurveyQuestion_Active bool
?SurveyQuestion_Active=...
SurveyQuestion_AllowMultipleOptions bool
?SurveyQuestion_AllowMultipleOptions=...
SurveyQuestion_AvailableOptions string
?SurveyQuestion_AvailableOptions=...
SurveyQuestion_Description string
?SurveyQuestion_Description=...
SurveyQuestion_DisplayOrder int
?SurveyQuestion_DisplayOrder=...
SurveyQuestion_QuestionType Nexudus.Coworking.Core.Enums.eQuestionType
?SurveyQuestion_QuestionType=...
SurveyQuestion_Survey Survey
?SurveyQuestion_Survey=...
SurveyQuestion_Text string
?SurveyQuestion_Text=...
SurveyQuestion_SurveyName string
?SurveyQuestion_SurveyName=...

Range search querystring parameters
Lets you search surveyquestion records based on a range of date or numeric values.
To_SurveyQuestion_CreatedOn date
?To_SurveyQuestion_CreatedOn=2010-01-01T20:32
From_SurveyQuestion_CreatedOn date
?From_SurveyQuestion_CreatedOn=2010-01-01T20:32
To_SurveyQuestion_UpdatedOn date
?To_SurveyQuestion_UpdatedOn=2010-01-01T20:32
From_SurveyQuestion_UpdatedOn date
?From_SurveyQuestion_UpdatedOn=2010-01-01T20:32
To_SurveyQuestion_DisplayOrder number
?To_SurveyQuestion_DisplayOrder=0
From_SurveyQuestion_DisplayOrder number
?From_SurveyQuestion_DisplayOrder=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Survey": ,
        "Text": "Abc123456",
        "Description": "Abc123456",
        "AvailableOptions": "Abc123456",
        "Active": false,
        "DisplayOrder": ,
        "AllowMultipleOptions": false,
        "QuestionType": 1,
        "SurveyQuestionSurveyName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "f0335af7-3e08-4655-a2d1-a9d10ba8cae7",
        "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 SurveyQuestions by IDs

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

πŸ”’ Requires role "SurveyQuestion-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Survey": ,
        "Text": "Abc123456",
        "Description": "Abc123456",
        "AvailableOptions": "Abc123456",
        "Active": false,
        "DisplayOrder": ,
        "AllowMultipleOptions": false,
        "QuestionType": 1,
        "SurveyQuestionSurveyName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "fa589ac2-9f5a-42cc-b236-b6c30b7dbf03",
        "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 SurveyQuestion by Id

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

πŸ”’ Requires role "SurveyQuestion-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Active": false,
  "AllowMultipleOptions": false,
  "AvailableOptions": "Abc123456",
  "Description": "Abc123456",
  "DisplayOrder": ,
  "QuestionType": 1,
  "SurveyId": 12345678,
  "Text": "Abc123456",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "2b64cbd1-59bc-4960-b4a7-28f458977e03",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new SurveyQuestion

Creates a new surveyquestion.
POST https://spaces.nexudus.com/api/content/surveyquestions

πŸ”’ Requires role "SurveyQuestion-Create"

Body parameters
SurveyId: number required
Text: string required
Description: string required
AvailableOptions: string optional
Active: bool optional
DisplayOrder: int required
AllowMultipleOptions: bool optional
QuestionType: Nexudus.Coworking.Core.Enums.eQuestionType optional

Example request

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

{
    "SurveyId": 12345678,
    "Text": "Abc123456",
    "Description": "Abc123456",
    "AvailableOptions": "Abc123456",
    "Active": false,
    "DisplayOrder": ,
    "AllowMultipleOptions": false,
    "QuestionType": 1, //(check Enumerated values section below)
}


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 SurveyQuestion

Updates an existing surveyquestion.
PUT https://spaces.nexudus.com/api/content/surveyquestions

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

πŸ”’ Requires role "SurveyQuestion-Edit"

Body parameters
Id: number required
The unique Id of the surveyquestion to update.
SurveyId: number cleared if missing
Text: string cleared if missing
Description: string cleared if missing
AvailableOptions: string cleared if missing
Active: bool cleared if missing
DisplayOrder: int cleared if missing
AllowMultipleOptions: bool cleared if missing
QuestionType: Nexudus.Coworking.Core.Enums.eQuestionType cleared if missing

Example request

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

{
    "Id": 12345678,
    "SurveyId": 12345678,
    "Text": "Abc123456",
    "Description": "Abc123456",
    "AvailableOptions": "Abc123456",
    "Active": false,
    "DisplayOrder": ,
    "AllowMultipleOptions": false,
    "QuestionType": 1, //(check Enumerated values section below)
}


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 SurveyQuestion

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

πŸ”’ Requires role "SurveyQuestion-Delete"

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

Example request

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

Example request

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

Example request

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

QuestionType

GET /api/utils/enums?name=eQuestionType

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.