Reference

Crmboardcolumn

The crmboardcolumn object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this crmboardcolumn
ActivateAccount: bool optional
Bookings: bool optional
Cancellations: bool optional
CannedResponseId: Id optional
ConfirmTour: bool optional
ContactMessages: bool optional
CrmBoardId: Id required
DeactivateAccount: bool optional
DocumentsSigned: bool optional
EventRegistrations: bool optional
Name: string required
Position: int required
ProposalsAccepted: bool optional
ProposalsSent: bool optional
SignUps: bool optional
TaskListId: Id optional
TourCompleted: bool optional
TourRequests: bool optional
ToursConfirmed: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this crmboardcolumn
SystemId: string optional api-only
User defined data about this crmboardcolumn. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ActivateAccount": false,
  "Bookings": false,
  "Cancellations": false,
  "CannedResponseId": 12345678,
  "ConfirmTour": false,
  "ContactMessages": false,
  "CrmBoardId": 12345678,
  "DeactivateAccount": false,
  "DocumentsSigned": false,
  "EventRegistrations": false,
  "Name": "Joe",
  "Position": ,
  "ProposalsAccepted": false,
  "ProposalsSent": false,
  "SignUps": false,
  "TaskListId": 12345678,
  "TourCompleted": false,
  "TourRequests": false,
  "ToursConfirmed": false,
  "UniqueId": "ff8e3ed6-4c38-4eaf-9466-bcaaeb0be541",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CrmBoardColumn

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

GET https://spaces.nexudus.com/api/crm/crmboardcolumns?...

πŸ”’ Requires role "CrmBoardColumn-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=Position
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 crmboardcolumn records based on their different properties.
Id number
?Id=12345678
CrmBoardColumn_ActivateAccount bool
?CrmBoardColumn_ActivateAccount=...
CrmBoardColumn_Bookings bool
?CrmBoardColumn_Bookings=...
CrmBoardColumn_Cancellations bool
?CrmBoardColumn_Cancellations=...
CrmBoardColumn_CannedResponse CannedResponse
?CrmBoardColumn_CannedResponse=...
CrmBoardColumn_ConfirmTour bool
?CrmBoardColumn_ConfirmTour=...
CrmBoardColumn_ContactMessages bool
?CrmBoardColumn_ContactMessages=...
CrmBoardColumn_CrmBoard CrmBoard
?CrmBoardColumn_CrmBoard=...
CrmBoardColumn_DeactivateAccount bool
?CrmBoardColumn_DeactivateAccount=...
CrmBoardColumn_DocumentsSigned bool
?CrmBoardColumn_DocumentsSigned=...
CrmBoardColumn_EventRegistrations bool
?CrmBoardColumn_EventRegistrations=...
CrmBoardColumn_Name string
?CrmBoardColumn_Name=...
CrmBoardColumn_Position int
?CrmBoardColumn_Position=...
CrmBoardColumn_ProposalsAccepted bool
?CrmBoardColumn_ProposalsAccepted=...
CrmBoardColumn_ProposalsSent bool
?CrmBoardColumn_ProposalsSent=...
CrmBoardColumn_SignUps bool
?CrmBoardColumn_SignUps=...
CrmBoardColumn_TaskList TaskList
?CrmBoardColumn_TaskList=...
CrmBoardColumn_TourCompleted bool
?CrmBoardColumn_TourCompleted=...
CrmBoardColumn_TourRequests bool
?CrmBoardColumn_TourRequests=...
CrmBoardColumn_ToursConfirmed bool
?CrmBoardColumn_ToursConfirmed=...
CrmBoardColumn_CrmBoardName string
?CrmBoardColumn_CrmBoardName=...
CrmBoardColumn_CrmBoardBusiness_Id string
?CrmBoardColumn_CrmBoardBusiness_Id=...
CrmBoardColumn_CrmBoardBusiness_Name string
?CrmBoardColumn_CrmBoardBusiness_Name=...
CrmBoardColumn_CrmBoardBusiness_Currency_Id string
?CrmBoardColumn_CrmBoardBusiness_Currency_Id=...
CrmBoardColumn_CrmBoardBusiness_Currency_Code string
?CrmBoardColumn_CrmBoardBusiness_Currency_Code=...

Range search querystring parameters
Lets you search crmboardcolumn records based on a range of date or numeric values.
To_CrmBoardColumn_CreatedOn date
?To_CrmBoardColumn_CreatedOn=2010-01-01T20:32
From_CrmBoardColumn_CreatedOn date
?From_CrmBoardColumn_CreatedOn=2010-01-01T20:32
To_CrmBoardColumn_UpdatedOn date
?To_CrmBoardColumn_UpdatedOn=2010-01-01T20:32
From_CrmBoardColumn_UpdatedOn date
?From_CrmBoardColumn_UpdatedOn=2010-01-01T20:32
To_CrmBoardColumn_Position number
?To_CrmBoardColumn_Position=0
From_CrmBoardColumn_Position number
?From_CrmBoardColumn_Position=10

Example request

GET https://spaces.nexudus.com/api/crm/crmboardcolumns?CrmBoardColumn_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "CrmBoard": ,
        "Name": "Joe",
        "Position": ,
        "TourRequests": false,
        "ToursConfirmed": false,
        "TourCompleted": false,
        "SignUps": false,
        "Bookings": false,
        "Cancellations": false,
        "ProposalsSent": false,
        "ProposalsAccepted": false,
        "DocumentsSigned": false,
        "EventRegistrations": false,
        "ContactMessages": false,
        "CannedResponse": ,
        "TaskList": ,
        "ActivateAccount": false,
        "DeactivateAccount": false,
        "ConfirmTour": false,
        "CrmBoardColumnCrmBoardName": "...",
        "CrmBoardColumnCrmBoardBusiness_Id": "...",
        "CrmBoardColumnCrmBoardBusiness_Name": "...",
        "CrmBoardColumnCrmBoardBusiness_Currency_Id": "...",
        "CrmBoardColumnCrmBoardBusiness_Currency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "fff52116-b2d9-4fb1-8617-08142f6a6c92",
        "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 CrmBoardColumns by IDs

Gets one or more crmboardcolumn records based on their Id.
GET https://spaces.nexudus.com/api/crm/crmboardcolumns?CrmBoardColumn_Id=[:id1,:id2,...]

πŸ”’ Requires role "CrmBoardColumn-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CrmBoard": ,
        "Name": "Joe",
        "Position": ,
        "TourRequests": false,
        "ToursConfirmed": false,
        "TourCompleted": false,
        "SignUps": false,
        "Bookings": false,
        "Cancellations": false,
        "ProposalsSent": false,
        "ProposalsAccepted": false,
        "DocumentsSigned": false,
        "EventRegistrations": false,
        "ContactMessages": false,
        "CannedResponse": ,
        "TaskList": ,
        "ActivateAccount": false,
        "DeactivateAccount": false,
        "ConfirmTour": false,
        "CrmBoardColumnCrmBoardName": "...",
        "CrmBoardColumnCrmBoardBusiness_Id": "...",
        "CrmBoardColumnCrmBoardBusiness_Name": "...",
        "CrmBoardColumnCrmBoardBusiness_Currency_Id": "...",
        "CrmBoardColumnCrmBoardBusiness_Currency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "681def9d-28c2-4d81-a7cf-3cfe7a1f6037",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Position",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CrmBoardColumn by Id

Gets one crmboardcolumn record by its Id.
GET https://spaces.nexudus.com/api/crm/crmboardcolumns/:Id

πŸ”’ Requires role "CrmBoardColumn-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ActivateAccount": false,
  "Bookings": false,
  "Cancellations": false,
  "CannedResponseId": 12345678,
  "ConfirmTour": false,
  "ContactMessages": false,
  "CrmBoardId": 12345678,
  "DeactivateAccount": false,
  "DocumentsSigned": false,
  "EventRegistrations": false,
  "Name": "Joe",
  "Position": ,
  "ProposalsAccepted": false,
  "ProposalsSent": false,
  "SignUps": false,
  "TaskListId": 12345678,
  "TourCompleted": false,
  "TourRequests": false,
  "ToursConfirmed": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "8751983b-79d5-4a57-b46b-953f2baa5d0a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CrmBoardColumn

Creates a new crmboardcolumn.
POST https://spaces.nexudus.com/api/crm/crmboardcolumns

πŸ”’ Requires role "CrmBoardColumn-Create"

Body parameters
CrmBoardId: number required
Name: string required
Position: int required
TourRequests: bool optional
ToursConfirmed: bool optional
TourCompleted: bool optional
SignUps: bool optional
Bookings: bool optional
Cancellations: bool optional
ProposalsSent: bool optional
ProposalsAccepted: bool optional
DocumentsSigned: bool optional
EventRegistrations: bool optional
ContactMessages: bool optional
CannedResponseId: number optional
TaskListId: number optional
ActivateAccount: bool optional
DeactivateAccount: bool optional
ConfirmTour: bool optional

Example request

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

{
    "CrmBoardId": 12345678,
    "Name": "Joe",
    "Position": ,
    "TourRequests": false,
    "ToursConfirmed": false,
    "TourCompleted": false,
    "SignUps": false,
    "Bookings": false,
    "Cancellations": false,
    "ProposalsSent": false,
    "ProposalsAccepted": false,
    "DocumentsSigned": false,
    "EventRegistrations": false,
    "ContactMessages": false,
    "CannedResponseId": 12345678,
    "TaskListId": 12345678,
    "ActivateAccount": false,
    "DeactivateAccount": false,
    "ConfirmTour": 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 CrmBoardColumn

Updates an existing crmboardcolumn.
PUT https://spaces.nexudus.com/api/crm/crmboardcolumns

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

πŸ”’ Requires role "CrmBoardColumn-Edit"

Body parameters
Id: number required
The unique Id of the crmboardcolumn to update.
CrmBoardId: number cleared if missing
Name: string cleared if missing
Position: int cleared if missing
TourRequests: bool cleared if missing
ToursConfirmed: bool cleared if missing
TourCompleted: bool cleared if missing
SignUps: bool cleared if missing
Bookings: bool cleared if missing
Cancellations: bool cleared if missing
ProposalsSent: bool cleared if missing
ProposalsAccepted: bool cleared if missing
DocumentsSigned: bool cleared if missing
EventRegistrations: bool cleared if missing
ContactMessages: bool cleared if missing
CannedResponseId: number cleared if missing
TaskListId: number cleared if missing
ActivateAccount: bool cleared if missing
DeactivateAccount: bool cleared if missing
ConfirmTour: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "CrmBoardId": 12345678,
    "Name": "Joe",
    "Position": ,
    "TourRequests": false,
    "ToursConfirmed": false,
    "TourCompleted": false,
    "SignUps": false,
    "Bookings": false,
    "Cancellations": false,
    "ProposalsSent": false,
    "ProposalsAccepted": false,
    "DocumentsSigned": false,
    "EventRegistrations": false,
    "ContactMessages": false,
    "CannedResponseId": 12345678,
    "TaskListId": 12345678,
    "ActivateAccount": false,
    "DeactivateAccount": false,
    "ConfirmTour": 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 CrmBoardColumn

Deletes an existing crmboardcolumn by its Id.
DELETE https://spaces.nexudus.com/api/crm/crmboardcolumns/:Id

πŸ”’ Requires role "CrmBoardColumn-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/crm/crmboardcolumns/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 crmboardcolumn 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 crmboardcolumn records.
GET https://spaces.nexudus.com/api/crm/crmboardcolumns/commands

Example request

GET https://spaces.nexudus.com/api/crm/crmboardcolumns/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 crmboardcolumn record IDs.
POST https://spaces.nexudus.com/api/crm/crmboardcolumns/runacommand
πŸ”’ Requires role "CrmBoardColumn-Edit"

Example request

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