The customfield object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this customfield |
AllowMultipleOptions: bool optional |
AvailableOptions: string optional |
BusinessId: Id required |
CoworkerFieldPosition: Nexudus.Coworking.Core.Enums.eCoworkerFieldPosition optional |
CustomFieldIndex: int required |
DisplayInDirectorySearch: bool optional |
DisplayInProfileForm: bool optional |
DisplayInPublicProfile: bool optional |
DisplayInSignUpForm: bool optional |
DisplayInTourForm: bool optional |
DisplayOrder: int required |
FieldType: Nexudus.Coworking.Core.Enums.eFieldType optional |
GroupName: string optional |
Name: string required |
NameInSearch: string optional |
RecordType: Nexudus.Coworking.Core.Enums.eCustomFieldRecordType optional |
Required: bool optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this customfield |
SystemId: string optional api-only
User defined data about this customfield. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AllowMultipleOptions": false,
"AvailableOptions": "Joe",
"BusinessId": 12345678,
"CoworkerFieldPosition": 1,
"CustomFieldIndex": ,
"DisplayInDirectorySearch": false,
"DisplayInProfileForm": false,
"DisplayInPublicProfile": false,
"DisplayInSignUpForm": false,
"DisplayInTourForm": false,
"DisplayOrder": ,
"FieldType": 1,
"GroupName": "Short",
"Name": "Joe",
"NameInSearch": "Short",
"RecordType": 1,
"Required": false,
"UniqueId": "881d4f55-b314-484e-a0e3-2224880881dd",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a CustomField
This endpoint allows you to GET a list of customfields based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/crm/customfields?...
π Requires role "CustomField-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 customfield records based on their different properties. |
Id number
?Id=12345678 |
CustomField_AllowMultipleOptions bool
?CustomField_AllowMultipleOptions=... |
CustomField_AvailableOptions string
?CustomField_AvailableOptions=... |
CustomField_Business Business
?CustomField_Business=... |
CustomField_CoworkerFieldPosition Nexudus.Coworking.Core.Enums.eCoworkerFieldPosition
?CustomField_CoworkerFieldPosition=... |
CustomField_CustomFieldIndex int
?CustomField_CustomFieldIndex=... |
CustomField_DisplayInDirectorySearch bool
?CustomField_DisplayInDirectorySearch=... |
CustomField_DisplayInProfileForm bool
?CustomField_DisplayInProfileForm=... |
CustomField_DisplayInPublicProfile bool
?CustomField_DisplayInPublicProfile=... |
CustomField_DisplayInSignUpForm bool
?CustomField_DisplayInSignUpForm=... |
CustomField_DisplayInTourForm bool
?CustomField_DisplayInTourForm=... |
CustomField_DisplayOrder int
?CustomField_DisplayOrder=... |
CustomField_FieldType Nexudus.Coworking.Core.Enums.eFieldType
?CustomField_FieldType=... |
CustomField_GroupName string
?CustomField_GroupName=... |
CustomField_Name string
?CustomField_Name=... |
CustomField_NameInSearch string
?CustomField_NameInSearch=... |
CustomField_RecordType Nexudus.Coworking.Core.Enums.eCustomFieldRecordType
?CustomField_RecordType=... |
CustomField_Required bool
?CustomField_Required=... |
Range search querystring parameters
Lets you search customfield records based on a range of date or numeric values. |
To_CustomField_CreatedOn date
?To_CustomField_CreatedOn=2010-01-01T20:32 |
From_CustomField_CreatedOn date
?From_CustomField_CreatedOn=2010-01-01T20:32 |
To_CustomField_UpdatedOn date
?To_CustomField_UpdatedOn=2010-01-01T20:32 |
From_CustomField_UpdatedOn date
?From_CustomField_UpdatedOn=2010-01-01T20:32 |
To_CustomField_DisplayOrder number
?To_CustomField_DisplayOrder=0 |
From_CustomField_DisplayOrder number
?From_CustomField_DisplayOrder=10 |
To_CustomField_CustomFieldIndex number
?To_CustomField_CustomFieldIndex=0 |
From_CustomField_CustomFieldIndex number
?From_CustomField_CustomFieldIndex=10 |
Example request
GET https://spaces.nexudus.com/api/crm/customfields?CustomField_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"DisplayOrder": ,
"RecordType": 1,
"FieldType": 1,
"CoworkerFieldPosition": 1,
"AvailableOptions": "Joe",
"AllowMultipleOptions": false,
"CustomFieldIndex": ,
"Required": false,
"DisplayInSignUpForm": false,
"DisplayInProfileForm": false,
"DisplayInTourForm": false,
"GroupName": "Short",
"DisplayInPublicProfile": false,
"DisplayInDirectorySearch": false,
"NameInSearch": "Short",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "a920dd7f-0ca4-4864-84ee-81cca1ec2905",
"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 CustomFields by IDs
Gets one or more customfield records based on their Id.GET https://spaces.nexudus.com/api/crm/customfields?CustomField_Id=[:id1,:id2,...]
π Requires role "CustomField-List"
Querystring parameters |
CustomField_Id: array requried
?CustomField_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/crm/customfields?CustomField_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"DisplayOrder": ,
"RecordType": 1,
"FieldType": 1,
"CoworkerFieldPosition": 1,
"AvailableOptions": "Joe",
"AllowMultipleOptions": false,
"CustomFieldIndex": ,
"Required": false,
"DisplayInSignUpForm": false,
"DisplayInProfileForm": false,
"DisplayInTourForm": false,
"GroupName": "Short",
"DisplayInPublicProfile": false,
"DisplayInDirectorySearch": false,
"NameInSearch": "Short",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "d004fa4a-72e7-46c4-8838-16b5a52fe39e",
"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 CustomField by Id
Gets one customfield record by its Id.GET https://spaces.nexudus.com/api/crm/customfields/:Id
π Requires role "CustomField-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/crm/customfields/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AllowMultipleOptions": false,
"AvailableOptions": "Joe",
"BusinessId": 12345678,
"CoworkerFieldPosition": 1,
"CustomFieldIndex": ,
"DisplayInDirectorySearch": false,
"DisplayInProfileForm": false,
"DisplayInPublicProfile": false,
"DisplayInSignUpForm": false,
"DisplayInTourForm": false,
"DisplayOrder": ,
"FieldType": 1,
"GroupName": "Short",
"Name": "Joe",
"NameInSearch": "Short",
"RecordType": 1,
"Required": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "8ae8e0c0-d93e-4856-8f53-6531ed8d55bb",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new CustomField
Creates a new customfield.POST https://spaces.nexudus.com/api/crm/customfields
π Requires role "CustomField-Create"
Body parameters |
BusinessId: number required |
Name: string required |
DisplayOrder: int required |
RecordType: Nexudus.Coworking.Core.Enums.eCustomFieldRecordType optional |
FieldType: Nexudus.Coworking.Core.Enums.eFieldType optional |
CoworkerFieldPosition: Nexudus.Coworking.Core.Enums.eCoworkerFieldPosition optional |
AvailableOptions: string optional |
AllowMultipleOptions: bool optional |
CustomFieldIndex: int required |
Required: bool optional |
DisplayInSignUpForm: bool optional |
DisplayInProfileForm: bool optional |
DisplayInTourForm: bool optional |
GroupName: string optional |
DisplayInPublicProfile: bool optional |
DisplayInDirectorySearch: bool optional |
NameInSearch: string optional |
Example request
POST https://spaces.nexudus.com/api/crm/customfields Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "Joe",
"DisplayOrder": ,
"RecordType": 1, //(check Enumerated values section below)
"FieldType": 1, //(check Enumerated values section below)
"CoworkerFieldPosition": 1, //(check Enumerated values section below)
"AvailableOptions": "Joe",
"AllowMultipleOptions": false,
"CustomFieldIndex": ,
"Required": false,
"DisplayInSignUpForm": false,
"DisplayInProfileForm": false,
"DisplayInTourForm": false,
"GroupName": "Short",
"DisplayInPublicProfile": false,
"DisplayInDirectorySearch": false,
"NameInSearch": "Short",
}
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 CustomField
Updates an existing customfield.PUT https://spaces.nexudus.com/api/crm/customfields
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "CustomField-Edit"
Body parameters |
Id: number required
The unique Id of the customfield to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
DisplayOrder: int cleared if missing |
RecordType: Nexudus.Coworking.Core.Enums.eCustomFieldRecordType cleared if missing |
FieldType: Nexudus.Coworking.Core.Enums.eFieldType cleared if missing |
CoworkerFieldPosition: Nexudus.Coworking.Core.Enums.eCoworkerFieldPosition cleared if missing |
AvailableOptions: string cleared if missing |
AllowMultipleOptions: bool cleared if missing |
CustomFieldIndex: int cleared if missing |
Required: bool cleared if missing |
DisplayInSignUpForm: bool cleared if missing |
DisplayInProfileForm: bool cleared if missing |
DisplayInTourForm: bool cleared if missing |
GroupName: string cleared if missing |
DisplayInPublicProfile: bool cleared if missing |
DisplayInDirectorySearch: bool cleared if missing |
NameInSearch: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/crm/customfields Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "Joe",
"DisplayOrder": ,
"RecordType": 1, //(check Enumerated values section below)
"FieldType": 1, //(check Enumerated values section below)
"CoworkerFieldPosition": 1, //(check Enumerated values section below)
"AvailableOptions": "Joe",
"AllowMultipleOptions": false,
"CustomFieldIndex": ,
"Required": false,
"DisplayInSignUpForm": false,
"DisplayInProfileForm": false,
"DisplayInTourForm": false,
"GroupName": "Short",
"DisplayInPublicProfile": false,
"DisplayInDirectorySearch": false,
"NameInSearch": "Short",
}
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 CustomField
Deletes an existing customfield by its Id.DELETE https://spaces.nexudus.com/api/crm/customfields/:Id
π Requires role "CustomField-Delete"
URL parameters |
Id: number required
The unique Id of the customfield to update. |
Example request
DELETE https://spaces.nexudus.com/api/crm/customfields/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 customfield 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 customfield records.GET https://spaces.nexudus.com/api/crm/customfields/commands
Example request
GET https://spaces.nexudus.com/api/crm/customfields/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 customfield record IDs.POST https://spaces.nexudus.com/api/crm/customfields/runacommandπ Requires role "CustomField-Edit"
Example request
POST https://spaces.nexudus.com/api/crm/customfields/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
RecordType
GET /api/utils/enums?name=eCustomFieldRecordType
FieldType
GET /api/utils/enums?name=eFieldType
CoworkerFieldPosition
GET /api/utils/enums?name=eCoworkerFieldPosition
Comments
Please sign in to leave a comment.