The business object
| Attributes |
|
Id: int required, autogenerated, unique
The unique identifier for this business |
| AboutUs: string optional |
| Address: string optional |
| ContactEmail: string optional |
| ContactPhoneNumber: string optional |
| CookiePolicyUrl: string optional |
| CountryId: Id required |
| CurrencyId: Id required |
| DefaultLanguage: Nexudus.Coworking.Core.Enums.eLanguage optional |
| DefaultPaymentGatewayId: Id optional |
| EmailContact: string optional |
| Fax: string optional |
| FloorSpace: int? optional |
| FloorSpaceUnit: Nexudus.Coworking.Core.Enums.eFloorUnit optional |
| FridayClosed: bool optional |
| FridayCloseTime: int? optional |
| FridayOpenTime: int? optional |
| Last4Digits: string optional |
| Latitude: decimal? optional |
| Longitude: decimal? optional |
| MondayClosed: bool optional |
| MondayCloseTime: int? optional |
| MondayOpenTime: int? optional |
| Name: string required |
| Neighborhood: string optional |
| NextInvoice: DateTime? optional read-only |
| NumberOfFloors: int? optional |
| OnBoardingTier: string optional read-only |
| PassportBlogPostsAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportChannels: string optional |
| PassportCommunityAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportDescription: string optional |
| PassportEventsAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportMembersAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportPublished: bool optional |
| PassportSpaceName: string optional |
| PassportTagLine: string optional |
| Phone: string optional |
| PostalCode: string optional |
| PreAuthLastError: string optional |
| PrivacyPolicyUrl: string optional |
| Quote: string optional |
| RootLocationId: Id optional read-only |
| SameOpeningTimes: bool optional |
| SaturdayClosed: bool optional |
| SaturdayCloseTime: int? optional |
| SaturdayOpenTime: int? optional |
| ShortIntroduction: string optional |
| SimpleTimeZoneId: Id required |
| SpaceWebsiteLanguageId: Id optional |
| StreetName: string optional |
| StreetNumber: string optional |
| SundayClosed: bool optional |
| SundayCloseTime: int? optional |
| SundayOpenTime: int? optional |
| SupportTier: string optional read-only |
| SupportUrl: string optional read-only |
| Tags: string optional |
| TermsAndConditions: string optional |
| ThursdayClosed: bool optional |
| ThursdayCloseTime: int? optional |
| ThursdayOpenTime: int? optional |
| TownCity: string optional |
| TuesdayClosed: bool optional |
| TuesdayCloseTime: int? optional |
| TuesdayOpenTime: int? optional |
| VenueType: Nexudus.Coworking.Core.Enums.eVenueType optional |
| WebAddress: string required |
| WebContact: string optional |
| WednesdayClosed: bool optional |
| WednesdayCloseTime: int? optional |
| WednesdayOpenTime: int? optional |
|
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this business |
|
SystemId: string optional api-only
User defined data about this business. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AboutUs": "Abc123456",
"Address": "Joe",
"ContactEmail": "Abc123456",
"ContactPhoneNumber": "Abc123456",
"CookiePolicyUrl": "Joe",
"CountryId": 12345678,
"CurrencyId": 12345678,
"DefaultLanguage": 1,
"DefaultPaymentGatewayId": 12345678,
"EmailContact": "me@example.com",
"Fax": "0207768885828",
"FloorSpace": ,
"FloorSpaceUnit": 1,
"FridayClosed": false,
"FridayCloseTime": ,
"FridayOpenTime": ,
"Last4Digits": "0",
"Latitude": ,
"Longitude": ,
"MondayClosed": false,
"MondayCloseTime": ,
"MondayOpenTime": ,
"Name": "Joe",
"Neighborhood": "Abc123456",
"NextInvoice": ,
"NumberOfFloors": ,
"OnBoardingTier": "standard",
"PassportBlogPostsAccess": 1,
"PassportChannels": "null",
"PassportCommunityAccess": 1,
"PassportDescription": "Joe",
"PassportEventsAccess": 1,
"PassportMembersAccess": 1,
"PassportPublished": false,
"PassportSpaceName": "null",
"PassportTagLine": "null",
"Phone": "0207768885828",
"PostalCode": "Abc123456",
"PreAuthLastError": "0",
"PrivacyPolicyUrl": "Joe",
"Quote": "Joe",
"RootLocationId": 12345678,
"SameOpeningTimes": false,
"SaturdayClosed": false,
"SaturdayCloseTime": ,
"SaturdayOpenTime": ,
"ShortIntroduction": "Abc123456",
"SimpleTimeZoneId": 12345678,
"SpaceWebsiteLanguageId": 12345678,
"StreetName": "Abc123456",
"StreetNumber": "Abc123456",
"SundayClosed": false,
"SundayCloseTime": ,
"SundayOpenTime": ,
"SupportTier": "standard",
"SupportUrl": "Abc123456",
"Tags": "null",
"TermsAndConditions": "TermsAndConditions",
"ThursdayClosed": false,
"ThursdayCloseTime": ,
"ThursdayOpenTime": ,
"TownCity": "Abc123456",
"TuesdayClosed": false,
"TuesdayCloseTime": ,
"TuesdayOpenTime": ,
"VenueType": 1,
"WebAddress": "url",
"WebContact": "www.example.com",
"WednesdayClosed": false,
"WednesdayCloseTime": ,
"WednesdayOpenTime": ,
"UniqueId": "26fa35a7-abb6-47c2-b668-6b8fe3ef77f5",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a Business
This endpoint allows you to GET a list of businesses based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/sys/businesses?...
🔒 Requires role "Business-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 business records based on their different properties. |
|
Id number
?Id=12345678 |
|
Business_AboutUs string
?Business_AboutUs=... |
|
Business_Address string
?Business_Address=... |
|
Business_ContactEmail string
?Business_ContactEmail=... |
|
Business_ContactPhoneNumber string
?Business_ContactPhoneNumber=... |
|
Business_CookiePolicyUrl string
?Business_CookiePolicyUrl=... |
|
Business_Country Country
?Business_Country=... |
|
Business_Currency Currency
?Business_Currency=... |
|
Business_DefaultLanguage Nexudus.Coworking.Core.Enums.eLanguage
?Business_DefaultLanguage=... |
|
Business_DefaultPaymentGateway PaymentGateway
?Business_DefaultPaymentGateway=... |
|
Business_EmailContact string
?Business_EmailContact=... |
|
Business_Fax string
?Business_Fax=... |
|
Business_FloorSpace int?
?Business_FloorSpace=... |
|
Business_FloorSpaceUnit Nexudus.Coworking.Core.Enums.eFloorUnit
?Business_FloorSpaceUnit=... |
|
Business_FridayClosed bool
?Business_FridayClosed=... |
|
Business_FridayCloseTime int?
?Business_FridayCloseTime=... |
|
Business_FridayOpenTime int?
?Business_FridayOpenTime=... |
|
Business_Last4Digits string
?Business_Last4Digits=... |
|
Business_Latitude decimal?
?Business_Latitude=... |
|
Business_Longitude decimal?
?Business_Longitude=... |
|
Business_MondayClosed bool
?Business_MondayClosed=... |
|
Business_MondayCloseTime int?
?Business_MondayCloseTime=... |
|
Business_MondayOpenTime int?
?Business_MondayOpenTime=... |
|
Business_Name string
?Business_Name=... |
|
Business_Neighborhood string
?Business_Neighborhood=... |
|
Business_NextInvoice DateTime?
?Business_NextInvoice=... |
|
Business_NumberOfFloors int?
?Business_NumberOfFloors=... |
|
Business_OnBoardingTier string
?Business_OnBoardingTier=... |
|
Business_PassportBlogPostsAccess Nexudus.Coworking.Core.Enums.ePassportAccess
?Business_PassportBlogPostsAccess=... |
|
Business_PassportChannels string
?Business_PassportChannels=... |
|
Business_PassportCommunityAccess Nexudus.Coworking.Core.Enums.ePassportAccess
?Business_PassportCommunityAccess=... |
|
Business_PassportDescription string
?Business_PassportDescription=... |
|
Business_PassportEventsAccess Nexudus.Coworking.Core.Enums.ePassportAccess
?Business_PassportEventsAccess=... |
|
Business_PassportMembersAccess Nexudus.Coworking.Core.Enums.ePassportAccess
?Business_PassportMembersAccess=... |
|
Business_PassportPublished bool
?Business_PassportPublished=... |
|
Business_PassportSpaceName string
?Business_PassportSpaceName=... |
|
Business_PassportTagLine string
?Business_PassportTagLine=... |
|
Business_Phone string
?Business_Phone=... |
|
Business_PostalCode string
?Business_PostalCode=... |
|
Business_PreAuthLastError string
?Business_PreAuthLastError=... |
|
Business_PrivacyPolicyUrl string
?Business_PrivacyPolicyUrl=... |
|
Business_Quote string
?Business_Quote=... |
|
Business_RootLocation Business
?Business_RootLocation=... |
|
Business_SameOpeningTimes bool
?Business_SameOpeningTimes=... |
|
Business_SaturdayClosed bool
?Business_SaturdayClosed=... |
|
Business_SaturdayCloseTime int?
?Business_SaturdayCloseTime=... |
|
Business_SaturdayOpenTime int?
?Business_SaturdayOpenTime=... |
|
Business_ShortIntroduction string
?Business_ShortIntroduction=... |
|
Business_SimpleTimeZone SimpleTimeZone
?Business_SimpleTimeZone=... |
|
Business_SpaceWebsiteLanguage Language
?Business_SpaceWebsiteLanguage=... |
|
Business_StreetName string
?Business_StreetName=... |
|
Business_StreetNumber string
?Business_StreetNumber=... |
|
Business_SundayClosed bool
?Business_SundayClosed=... |
|
Business_SundayCloseTime int?
?Business_SundayCloseTime=... |
|
Business_SundayOpenTime int?
?Business_SundayOpenTime=... |
|
Business_SupportTier string
?Business_SupportTier=... |
|
Business_SupportUrl string
?Business_SupportUrl=... |
|
Business_Tags string
?Business_Tags=... |
|
Business_TermsAndConditions string
?Business_TermsAndConditions=... |
|
Business_ThursdayClosed bool
?Business_ThursdayClosed=... |
|
Business_ThursdayCloseTime int?
?Business_ThursdayCloseTime=... |
|
Business_ThursdayOpenTime int?
?Business_ThursdayOpenTime=... |
|
Business_TownCity string
?Business_TownCity=... |
|
Business_TuesdayClosed bool
?Business_TuesdayClosed=... |
|
Business_TuesdayCloseTime int?
?Business_TuesdayCloseTime=... |
|
Business_TuesdayOpenTime int?
?Business_TuesdayOpenTime=... |
|
Business_VenueType Nexudus.Coworking.Core.Enums.eVenueType
?Business_VenueType=... |
|
Business_WebAddress string
?Business_WebAddress=... |
|
Business_WebContact string
?Business_WebContact=... |
|
Business_WednesdayClosed bool
?Business_WednesdayClosed=... |
|
Business_WednesdayCloseTime int?
?Business_WednesdayCloseTime=... |
|
Business_WednesdayOpenTime int?
?Business_WednesdayOpenTime=... |
|
Business_SpaceWebsiteLanguage_Culture string
?Business_SpaceWebsiteLanguage_Culture=... |
|
Business_Country_Name string
?Business_Country_Name=... |
|
Business_Currency_Code string
?Business_Currency_Code=... |
|
Range search querystring parameters
Lets you search business records based on a range of date or numeric values. |
|
To_Business_CreatedOn date
?To_Business_CreatedOn=2010-01-01T20:32 |
|
From_Business_CreatedOn date
?From_Business_CreatedOn=2010-01-01T20:32 |
|
To_Business_UpdatedOn date
?To_Business_UpdatedOn=2010-01-01T20:32 |
|
From_Business_UpdatedOn date
?From_Business_UpdatedOn=2010-01-01T20:32 |
|
To_Business_NextInvoice date
?To_Business_NextInvoice=2010-01-01T20:32 |
|
From_Business_NextInvoice date
?From_Business_NextInvoice=2010-01-01T20:32 |
|
To_Business_NumberOfFloors number
?To_Business_NumberOfFloors=0 |
|
From_Business_NumberOfFloors number
?From_Business_NumberOfFloors=10 |
|
To_Business_FloorSpace number
?To_Business_FloorSpace=0 |
|
From_Business_FloorSpace number
?From_Business_FloorSpace=10 |
|
To_Business_Longitude number
?To_Business_Longitude=0 |
|
From_Business_Longitude number
?From_Business_Longitude=10 |
|
To_Business_Latitude number
?To_Business_Latitude=0 |
|
From_Business_Latitude number
?From_Business_Latitude=10 |
|
To_Business_MondayOpenTime number
?To_Business_MondayOpenTime=0 |
|
From_Business_MondayOpenTime number
?From_Business_MondayOpenTime=10 |
|
To_Business_MondayCloseTime number
?To_Business_MondayCloseTime=0 |
|
From_Business_MondayCloseTime number
?From_Business_MondayCloseTime=10 |
|
To_Business_TuesdayOpenTime number
?To_Business_TuesdayOpenTime=0 |
|
From_Business_TuesdayOpenTime number
?From_Business_TuesdayOpenTime=10 |
|
To_Business_TuesdayCloseTime number
?To_Business_TuesdayCloseTime=0 |
|
From_Business_TuesdayCloseTime number
?From_Business_TuesdayCloseTime=10 |
|
To_Business_WednesdayOpenTime number
?To_Business_WednesdayOpenTime=0 |
|
From_Business_WednesdayOpenTime number
?From_Business_WednesdayOpenTime=10 |
|
To_Business_WednesdayCloseTime number
?To_Business_WednesdayCloseTime=0 |
|
From_Business_WednesdayCloseTime number
?From_Business_WednesdayCloseTime=10 |
|
To_Business_ThursdayOpenTime number
?To_Business_ThursdayOpenTime=0 |
|
From_Business_ThursdayOpenTime number
?From_Business_ThursdayOpenTime=10 |
|
To_Business_ThursdayCloseTime number
?To_Business_ThursdayCloseTime=0 |
|
From_Business_ThursdayCloseTime number
?From_Business_ThursdayCloseTime=10 |
|
To_Business_FridayOpenTime number
?To_Business_FridayOpenTime=0 |
|
From_Business_FridayOpenTime number
?From_Business_FridayOpenTime=10 |
|
To_Business_FridayCloseTime number
?To_Business_FridayCloseTime=0 |
|
From_Business_FridayCloseTime number
?From_Business_FridayCloseTime=10 |
|
To_Business_SaturdayOpenTime number
?To_Business_SaturdayOpenTime=0 |
|
From_Business_SaturdayOpenTime number
?From_Business_SaturdayOpenTime=10 |
|
To_Business_SaturdayCloseTime number
?To_Business_SaturdayCloseTime=0 |
|
From_Business_SaturdayCloseTime number
?From_Business_SaturdayCloseTime=10 |
|
To_Business_SundayOpenTime number
?To_Business_SundayOpenTime=0 |
|
From_Business_SundayOpenTime number
?From_Business_SundayOpenTime=10 |
|
To_Business_SundayCloseTime number
?To_Business_SundayCloseTime=0 |
|
From_Business_SundayCloseTime number
?From_Business_SundayCloseTime=10 |
Example request
GET https://spaces.nexudus.com/api/sys/businesses?Business_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "Joe",
"DefaultLanguage": 1,
"SpaceWebsiteLanguage": ,
"RootLocation": ,
"WebAddress": "url",
"DefaultPaymentGateway": ,
"NextInvoice": ,
"TermsAndConditions": "TermsAndConditions",
"ShortIntroduction": "Abc123456",
"AboutUs": "Abc123456",
"Quote": "Joe",
"PrivacyPolicyUrl": "Joe",
"CookiePolicyUrl": "Joe",
"WebContact": "www.example.com",
"Address": "Joe",
"Phone": "0207768885828",
"Fax": "0207768885828",
"EmailContact": "me@example.com",
"Country": ,
"Currency": ,
"SimpleTimeZone": ,
"Last4Digits": "0",
"PreAuthLastError": "0",
"PassportChannels": "null",
"PassportPublished": false,
"PassportSpaceName": "null",
"PassportTagLine": "null",
"VenueType": 1,
"Tags": "null",
"NumberOfFloors": ,
"FloorSpace": ,
"FloorSpaceUnit": 1,
"Longitude": ,
"Latitude": ,
"PassportDescription": "Joe",
"TownCity": "Abc123456",
"PostalCode": "Abc123456",
"StreetName": "Abc123456",
"StreetNumber": "Abc123456",
"Neighborhood": "Abc123456",
"ContactPhoneNumber": "Abc123456",
"ContactEmail": "Abc123456",
"PassportMembersAccess": 1,
"PassportEventsAccess": 1,
"PassportCommunityAccess": 1,
"PassportBlogPostsAccess": 1,
"MondayOpenTime": ,
"MondayCloseTime": ,
"TuesdayOpenTime": ,
"TuesdayCloseTime": ,
"WednesdayOpenTime": ,
"WednesdayCloseTime": ,
"ThursdayOpenTime": ,
"ThursdayCloseTime": ,
"FridayOpenTime": ,
"FridayCloseTime": ,
"SaturdayOpenTime": ,
"SaturdayCloseTime": ,
"SundayOpenTime": ,
"SundayCloseTime": ,
"MondayClosed": false,
"TuesdayClosed": false,
"WednesdayClosed": false,
"ThursdayClosed": false,
"FridayClosed": false,
"SaturdayClosed": false,
"SundayClosed": false,
"SameOpeningTimes": false,
"OnBoardingTier": "standard",
"SupportTier": "standard",
"SupportUrl": "Abc123456",
"BusinessSpaceWebsiteLanguageCulture": "...",
"BusinessCountryName": "...",
"BusinessCurrencyCode": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "8e51f784-cefc-4207-8c9e-7bd379e36cee",
"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 Businesses by IDs
Gets one or more business records based on their Id.GET https://spaces.nexudus.com/api/sys/businesses?Business_Id=[:id1,:id2,...]
🔒 Requires role "Business-List"
| Querystring parameters |
|
Business_Id: array requried
?Business_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/sys/businesses?Business_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "Joe",
"DefaultLanguage": 1,
"SpaceWebsiteLanguage": ,
"RootLocation": ,
"WebAddress": "url",
"DefaultPaymentGateway": ,
"NextInvoice": ,
"TermsAndConditions": "TermsAndConditions",
"ShortIntroduction": "Abc123456",
"AboutUs": "Abc123456",
"Quote": "Joe",
"PrivacyPolicyUrl": "Joe",
"CookiePolicyUrl": "Joe",
"WebContact": "www.example.com",
"Address": "Joe",
"Phone": "0207768885828",
"Fax": "0207768885828",
"EmailContact": "me@example.com",
"Country": ,
"Currency": ,
"SimpleTimeZone": ,
"Last4Digits": "0",
"PreAuthLastError": "0",
"PassportChannels": "null",
"PassportPublished": false,
"PassportSpaceName": "null",
"PassportTagLine": "null",
"VenueType": 1,
"Tags": "null",
"NumberOfFloors": ,
"FloorSpace": ,
"FloorSpaceUnit": 1,
"Longitude": ,
"Latitude": ,
"PassportDescription": "Joe",
"TownCity": "Abc123456",
"PostalCode": "Abc123456",
"StreetName": "Abc123456",
"StreetNumber": "Abc123456",
"Neighborhood": "Abc123456",
"ContactPhoneNumber": "Abc123456",
"ContactEmail": "Abc123456",
"PassportMembersAccess": 1,
"PassportEventsAccess": 1,
"PassportCommunityAccess": 1,
"PassportBlogPostsAccess": 1,
"MondayOpenTime": ,
"MondayCloseTime": ,
"TuesdayOpenTime": ,
"TuesdayCloseTime": ,
"WednesdayOpenTime": ,
"WednesdayCloseTime": ,
"ThursdayOpenTime": ,
"ThursdayCloseTime": ,
"FridayOpenTime": ,
"FridayCloseTime": ,
"SaturdayOpenTime": ,
"SaturdayCloseTime": ,
"SundayOpenTime": ,
"SundayCloseTime": ,
"MondayClosed": false,
"TuesdayClosed": false,
"WednesdayClosed": false,
"ThursdayClosed": false,
"FridayClosed": false,
"SaturdayClosed": false,
"SundayClosed": false,
"SameOpeningTimes": false,
"OnBoardingTier": "standard",
"SupportTier": "standard",
"SupportUrl": "Abc123456",
"BusinessSpaceWebsiteLanguageCulture": "...",
"BusinessCountryName": "...",
"BusinessCurrencyCode": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "e2d2103e-a8ed-4a90-836b-fbffd6d27cf4",
"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 Business by Id
Gets one business record by its Id.GET https://spaces.nexudus.com/api/sys/businesses/:Id
🔒 Requires role "Business-Read"
| URL parameters |
| Id: number requried |
Example request
GET https://spaces.nexudus.com/api/sys/businesses/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AboutUs": "Abc123456",
"Address": "Joe",
"ContactEmail": "Abc123456",
"ContactPhoneNumber": "Abc123456",
"CookiePolicyUrl": "Joe",
"CountryId": 12345678,
"CurrencyId": 12345678,
"DefaultLanguage": 1,
"DefaultPaymentGatewayId": 12345678,
"EmailContact": "me@example.com",
"Fax": "0207768885828",
"FloorSpace": ,
"FloorSpaceUnit": 1,
"FridayClosed": false,
"FridayCloseTime": ,
"FridayOpenTime": ,
"Last4Digits": "0",
"Latitude": ,
"Longitude": ,
"MondayClosed": false,
"MondayCloseTime": ,
"MondayOpenTime": ,
"Name": "Joe",
"Neighborhood": "Abc123456",
"NextInvoice": ,
"NumberOfFloors": ,
"OnBoardingTier": "standard",
"PassportBlogPostsAccess": 1,
"PassportChannels": "null",
"PassportCommunityAccess": 1,
"PassportDescription": "Joe",
"PassportEventsAccess": 1,
"PassportMembersAccess": 1,
"PassportPublished": false,
"PassportSpaceName": "null",
"PassportTagLine": "null",
"Phone": "0207768885828",
"PostalCode": "Abc123456",
"PreAuthLastError": "0",
"PrivacyPolicyUrl": "Joe",
"Quote": "Joe",
"RootLocationId": 12345678,
"SameOpeningTimes": false,
"SaturdayClosed": false,
"SaturdayCloseTime": ,
"SaturdayOpenTime": ,
"ShortIntroduction": "Abc123456",
"SimpleTimeZoneId": 12345678,
"SpaceWebsiteLanguageId": 12345678,
"StreetName": "Abc123456",
"StreetNumber": "Abc123456",
"SundayClosed": false,
"SundayCloseTime": ,
"SundayOpenTime": ,
"SupportTier": "standard",
"SupportUrl": "Abc123456",
"Tags": "null",
"TermsAndConditions": "TermsAndConditions",
"ThursdayClosed": false,
"ThursdayCloseTime": ,
"ThursdayOpenTime": ,
"TownCity": "Abc123456",
"TuesdayClosed": false,
"TuesdayCloseTime": ,
"TuesdayOpenTime": ,
"VenueType": 1,
"WebAddress": "url",
"WebContact": "www.example.com",
"WednesdayClosed": false,
"WednesdayCloseTime": ,
"WednesdayOpenTime": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "828b98ce-6ff3-436f-b417-123813fd679c",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new Business
Creates a new business.POST https://spaces.nexudus.com/api/sys/businesses
🔒 Requires role "Business-Create"
| Body parameters |
| Name: string required |
| DefaultLanguage: Nexudus.Coworking.Core.Enums.eLanguage optional |
| SpaceWebsiteLanguageId: number optional |
| WebAddress: string required |
| DefaultPaymentGatewayId: number optional |
| TermsAndConditions: string optional |
| ShortIntroduction: string optional |
| AboutUs: string optional |
| Quote: string optional |
| PrivacyPolicyUrl: string optional |
| CookiePolicyUrl: string optional |
| WebContact: string optional |
| Address: string optional |
| Phone: string optional |
| Fax: string optional |
| EmailContact: string optional |
| CountryId: number required |
| CurrencyId: number required |
| SimpleTimeZoneId: number required |
| Last4Digits: string optional |
| PreAuthLastError: string optional |
| PassportChannels: string optional |
| PassportPublished: bool optional |
| PassportSpaceName: string optional |
| PassportTagLine: string optional |
| VenueType: Nexudus.Coworking.Core.Enums.eVenueType optional |
| Tags: string optional |
| NumberOfFloors: int? optional |
| FloorSpace: int? optional |
| FloorSpaceUnit: Nexudus.Coworking.Core.Enums.eFloorUnit optional |
| Longitude: decimal? optional |
| Latitude: decimal? optional |
| PassportDescription: string optional |
| TownCity: string optional |
| PostalCode: string optional |
| StreetName: string optional |
| StreetNumber: string optional |
| Neighborhood: string optional |
| ContactPhoneNumber: string optional |
| ContactEmail: string optional |
| PassportMembersAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportEventsAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportCommunityAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| PassportBlogPostsAccess: Nexudus.Coworking.Core.Enums.ePassportAccess optional |
| MondayOpenTime: int? optional |
| MondayCloseTime: int? optional |
| TuesdayOpenTime: int? optional |
| TuesdayCloseTime: int? optional |
| WednesdayOpenTime: int? optional |
| WednesdayCloseTime: int? optional |
| ThursdayOpenTime: int? optional |
| ThursdayCloseTime: int? optional |
| FridayOpenTime: int? optional |
| FridayCloseTime: int? optional |
| SaturdayOpenTime: int? optional |
| SaturdayCloseTime: int? optional |
| SundayOpenTime: int? optional |
| SundayCloseTime: int? optional |
| MondayClosed: bool optional |
| TuesdayClosed: bool optional |
| WednesdayClosed: bool optional |
| ThursdayClosed: bool optional |
| FridayClosed: bool optional |
| SaturdayClosed: bool optional |
| SundayClosed: bool optional |
| SameOpeningTimes: bool optional |
Example request
POST https://spaces.nexudus.com/api/sys/businesses Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Name": "Joe",
"DefaultLanguage": 1, //(check Enumerated values section below)
"SpaceWebsiteLanguageId": 12345678,
"WebAddress": "url",
"DefaultPaymentGatewayId": 12345678,
"TermsAndConditions": "TermsAndConditions",
"ShortIntroduction": "Abc123456",
"AboutUs": "Abc123456",
"Quote": "Joe",
"PrivacyPolicyUrl": "Joe",
"CookiePolicyUrl": "Joe",
"WebContact": "www.example.com",
"Address": "Joe",
"Phone": "0207768885828",
"Fax": "0207768885828",
"EmailContact": "me@example.com",
"CountryId": 12345678,
"CurrencyId": 12345678,
"SimpleTimeZoneId": 12345678,
"Last4Digits": "0",
"PreAuthLastError": "0",
"PassportChannels": "null",
"PassportPublished": false,
"PassportSpaceName": "null",
"PassportTagLine": "null",
"VenueType": 1, //(check Enumerated values section below)
"Tags": "null",
"NumberOfFloors": ,
"FloorSpace": ,
"FloorSpaceUnit": 1, //(check Enumerated values section below)
"Longitude": ,
"Latitude": ,
"PassportDescription": "Joe",
"TownCity": "Abc123456",
"PostalCode": "Abc123456",
"StreetName": "Abc123456",
"StreetNumber": "Abc123456",
"Neighborhood": "Abc123456",
"ContactPhoneNumber": "Abc123456",
"ContactEmail": "Abc123456",
"PassportMembersAccess": 1, //(check Enumerated values section below)
"PassportEventsAccess": 1, //(check Enumerated values section below)
"PassportCommunityAccess": 1, //(check Enumerated values section below)
"PassportBlogPostsAccess": 1, //(check Enumerated values section below)
"MondayOpenTime": ,
"MondayCloseTime": ,
"TuesdayOpenTime": ,
"TuesdayCloseTime": ,
"WednesdayOpenTime": ,
"WednesdayCloseTime": ,
"ThursdayOpenTime": ,
"ThursdayCloseTime": ,
"FridayOpenTime": ,
"FridayCloseTime": ,
"SaturdayOpenTime": ,
"SaturdayCloseTime": ,
"SundayOpenTime": ,
"SundayCloseTime": ,
"MondayClosed": false,
"TuesdayClosed": false,
"WednesdayClosed": false,
"ThursdayClosed": false,
"FridayClosed": false,
"SaturdayClosed": false,
"SundayClosed": false,
"SameOpeningTimes": 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 Business
Updates an existing business.PUT https://spaces.nexudus.com/api/sys/businesses
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
🔒 Requires role "Business-Edit"
| Body parameters |
|
Id: number required
The unique Id of the business to update. |
| Name: string cleared if missing |
| DefaultLanguage: Nexudus.Coworking.Core.Enums.eLanguage cleared if missing |
| SpaceWebsiteLanguageId: number cleared if missing |
| WebAddress: string cleared if missing |
| DefaultPaymentGatewayId: number cleared if missing |
| TermsAndConditions: string cleared if missing |
| ShortIntroduction: string cleared if missing |
| AboutUs: string cleared if missing |
| Quote: string cleared if missing |
| PrivacyPolicyUrl: string cleared if missing |
| CookiePolicyUrl: string cleared if missing |
| WebContact: string cleared if missing |
| Address: string cleared if missing |
| Phone: string cleared if missing |
| Fax: string cleared if missing |
| EmailContact: string cleared if missing |
| CountryId: number cleared if missing |
| CurrencyId: number cleared if missing |
| SimpleTimeZoneId: number cleared if missing |
| Last4Digits: string cleared if missing |
| PreAuthLastError: string cleared if missing |
| PassportChannels: string cleared if missing |
| PassportPublished: bool cleared if missing |
| PassportSpaceName: string cleared if missing |
| PassportTagLine: string cleared if missing |
| VenueType: Nexudus.Coworking.Core.Enums.eVenueType cleared if missing |
| Tags: string cleared if missing |
| NumberOfFloors: int? cleared if missing |
| FloorSpace: int? cleared if missing |
| FloorSpaceUnit: Nexudus.Coworking.Core.Enums.eFloorUnit cleared if missing |
| Longitude: decimal? cleared if missing |
| Latitude: decimal? cleared if missing |
| PassportDescription: string cleared if missing |
| TownCity: string cleared if missing |
| PostalCode: string cleared if missing |
| StreetName: string cleared if missing |
| StreetNumber: string cleared if missing |
| Neighborhood: string cleared if missing |
| ContactPhoneNumber: string cleared if missing |
| ContactEmail: string cleared if missing |
| PassportMembersAccess: Nexudus.Coworking.Core.Enums.ePassportAccess cleared if missing |
| PassportEventsAccess: Nexudus.Coworking.Core.Enums.ePassportAccess cleared if missing |
| PassportCommunityAccess: Nexudus.Coworking.Core.Enums.ePassportAccess cleared if missing |
| PassportBlogPostsAccess: Nexudus.Coworking.Core.Enums.ePassportAccess cleared if missing |
| MondayOpenTime: int? cleared if missing |
| MondayCloseTime: int? cleared if missing |
| TuesdayOpenTime: int? cleared if missing |
| TuesdayCloseTime: int? cleared if missing |
| WednesdayOpenTime: int? cleared if missing |
| WednesdayCloseTime: int? cleared if missing |
| ThursdayOpenTime: int? cleared if missing |
| ThursdayCloseTime: int? cleared if missing |
| FridayOpenTime: int? cleared if missing |
| FridayCloseTime: int? cleared if missing |
| SaturdayOpenTime: int? cleared if missing |
| SaturdayCloseTime: int? cleared if missing |
| SundayOpenTime: int? cleared if missing |
| SundayCloseTime: int? cleared if missing |
| MondayClosed: bool cleared if missing |
| TuesdayClosed: bool cleared if missing |
| WednesdayClosed: bool cleared if missing |
| ThursdayClosed: bool cleared if missing |
| FridayClosed: bool cleared if missing |
| SaturdayClosed: bool cleared if missing |
| SundayClosed: bool cleared if missing |
| SameOpeningTimes: bool cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/sys/businesses Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"Name": "Joe",
"DefaultLanguage": 1, //(check Enumerated values section below)
"SpaceWebsiteLanguageId": 12345678,
"WebAddress": "url",
"DefaultPaymentGatewayId": 12345678,
"TermsAndConditions": "TermsAndConditions",
"ShortIntroduction": "Abc123456",
"AboutUs": "Abc123456",
"Quote": "Joe",
"PrivacyPolicyUrl": "Joe",
"CookiePolicyUrl": "Joe",
"WebContact": "www.example.com",
"Address": "Joe",
"Phone": "0207768885828",
"Fax": "0207768885828",
"EmailContact": "me@example.com",
"CountryId": 12345678,
"CurrencyId": 12345678,
"SimpleTimeZoneId": 12345678,
"Last4Digits": "0",
"PreAuthLastError": "0",
"PassportChannels": "null",
"PassportPublished": false,
"PassportSpaceName": "null",
"PassportTagLine": "null",
"VenueType": 1, //(check Enumerated values section below)
"Tags": "null",
"NumberOfFloors": ,
"FloorSpace": ,
"FloorSpaceUnit": 1, //(check Enumerated values section below)
"Longitude": ,
"Latitude": ,
"PassportDescription": "Joe",
"TownCity": "Abc123456",
"PostalCode": "Abc123456",
"StreetName": "Abc123456",
"StreetNumber": "Abc123456",
"Neighborhood": "Abc123456",
"ContactPhoneNumber": "Abc123456",
"ContactEmail": "Abc123456",
"PassportMembersAccess": 1, //(check Enumerated values section below)
"PassportEventsAccess": 1, //(check Enumerated values section below)
"PassportCommunityAccess": 1, //(check Enumerated values section below)
"PassportBlogPostsAccess": 1, //(check Enumerated values section below)
"MondayOpenTime": ,
"MondayCloseTime": ,
"TuesdayOpenTime": ,
"TuesdayCloseTime": ,
"WednesdayOpenTime": ,
"WednesdayCloseTime": ,
"ThursdayOpenTime": ,
"ThursdayCloseTime": ,
"FridayOpenTime": ,
"FridayCloseTime": ,
"SaturdayOpenTime": ,
"SaturdayCloseTime": ,
"SundayOpenTime": ,
"SundayCloseTime": ,
"MondayClosed": false,
"TuesdayClosed": false,
"WednesdayClosed": false,
"ThursdayClosed": false,
"FridayClosed": false,
"SaturdayClosed": false,
"SundayClosed": false,
"SameOpeningTimes": 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"
},
]
}
Commands
Commands allow to perform actions against one or more business 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 business records.GET https://spaces.nexudus.com/api/sys/businesses/commands
Example request
GET https://spaces.nexudus.com/api/sys/businesses/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 business record IDs.POST https://spaces.nexudus.com/api/sys/businesses/runacommand🔒 Requires role "Business-Edit"
Example request
POST https://spaces.nexudus.com/api/sys/businesses/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
VisitedHelpItems
GET /api/utils/enums?name=eHelpItemFlag
DefaultLanguage
GET /api/utils/enums?name=eLanguage
VenueType
GET /api/utils/enums?name=eVenueType
FloorSpaceUnit
GET /api/utils/enums?name=eFloorUnit
PassportMembersAccess
GET /api/utils/enums?name=ePassportAccess
PassportEventsAccess
GET /api/utils/enums?name=ePassportAccess
PassportCommunityAccess
GET /api/utils/enums?name=ePassportAccess
PassportBlogPostsAccess
GET /api/utils/enums?name=ePassportAccess
Binary files
The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.
Logo
GET https://spaces.nexudus.com/api/sys/businesses/getlogo/:id
| URL parameters |
|
Id: number required
The id of the Business to get the logo for. |
BannerImage
GET https://spaces.nexudus.com/api/sys/businesses/getbannerimage/:id
| URL parameters |
|
Id: number required
The id of the Business to get the bannerimage for. |
PassportBanner
GET https://spaces.nexudus.com/api/sys/businesses/getpassportbanner/:id
| URL parameters |
|
Id: number required
The id of the Business to get the passportbanner for. |
Comments
Please sign in to leave a comment.