Reference

Team

The team object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this team
ActiveContracts: int required
BusinessId: Id required
CoworkerBillingNames: string optional
CoworkerFullNames: string optional
CoworkerIds: string optional
CreateSingleInvoiceForTeam: bool optional
DefaultMemberTariffId: Id optional
Description: string optional
DiscountCharges: decimal? optional
DiscountExtraServices: decimal? optional
DiscountTariffs: decimal? optional
DiscountTimePasses: decimal? optional
Facebook: string optional
GoogleMapsLink: string optional
Linkedin: string optional
MaxTeamMemberCount: decimal? optional
Name: string required
PayingMemberId: Id optional
ProfileIsPublic: bool optional
ProfileSummary: string optional
ProfileTags: string optional
ProfileWebsite: string optional
ShareBookingCredit: bool optional
ShareExtraServices: bool optional
ShareTimePasses: bool optional
Skype: string optional
TransferCreditsToPayingMember: bool optional
TunnelPrivateGroupId: string optional
Twitter: string optional
UseSpecialPrices: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this team
SystemId: string optional api-only
User defined data about this team. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ActiveContracts": ,
  "BusinessId": 12345678,
  "CoworkerBillingNames": "Abc123456",
  "CoworkerFullNames": "Abc123456",
  "CoworkerIds": "Abc123456",
  "CreateSingleInvoiceForTeam": false,
  "DefaultMemberTariffId": 12345678,
  "Description": "Descripción",
  "DiscountCharges": ,
  "DiscountExtraServices": ,
  "DiscountTariffs": ,
  "DiscountTimePasses": ,
  "Facebook": "Facebook",
  "GoogleMapsLink": "GoogleMapsLink",
  "Linkedin": "Linkedin",
  "MaxTeamMemberCount": ,
  "Name": "Name",
  "PayingMemberId": 12345678,
  "ProfileIsPublic": false,
  "ProfileSummary": "null",
  "ProfileTags": "BusinessArea",
  "ProfileWebsite": "ProfileWebsite",
  "ShareBookingCredit": false,
  "ShareExtraServices": false,
  "ShareTimePasses": false,
  "Skype": "Skype",
  "TransferCreditsToPayingMember": false,
  "TunnelPrivateGroupId": "Abc123456",
  "Twitter": "Twitter",
  "UseSpecialPrices": false,
  "UniqueId": "13699839-0afb-4388-8a55-b656e051b13c",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a Team

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

GET https://spaces.nexudus.com/api/spaces/teams?...

🔒 Requires role "Team-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 team records based on their different properties.
Id number
?Id=12345678
Team_ActiveContracts int
?Team_ActiveContracts=...
Team_Business Business
?Team_Business=...
Team_CoworkerBillingNames string
?Team_CoworkerBillingNames=...
Team_CoworkerFullNames string
?Team_CoworkerFullNames=...
Team_CoworkerIds string
?Team_CoworkerIds=...
Team_CreateSingleInvoiceForTeam bool
?Team_CreateSingleInvoiceForTeam=...
Team_DefaultMemberTariff Tariff
?Team_DefaultMemberTariff=...
Team_Description string
?Team_Description=...
Team_DiscountCharges decimal?
?Team_DiscountCharges=...
Team_DiscountExtraServices decimal?
?Team_DiscountExtraServices=...
Team_DiscountTariffs decimal?
?Team_DiscountTariffs=...
Team_DiscountTimePasses decimal?
?Team_DiscountTimePasses=...
Team_Facebook string
?Team_Facebook=...
Team_GoogleMapsLink string
?Team_GoogleMapsLink=...
Team_Linkedin string
?Team_Linkedin=...
Team_MaxTeamMemberCount decimal?
?Team_MaxTeamMemberCount=...
Team_Name string
?Team_Name=...
Team_PayingMember Coworker
?Team_PayingMember=...
Team_ProfileIsPublic bool
?Team_ProfileIsPublic=...
Team_ProfileSummary string
?Team_ProfileSummary=...
Team_ProfileTags string
?Team_ProfileTags=...
Team_ProfileWebsite string
?Team_ProfileWebsite=...
Team_ShareBookingCredit bool
?Team_ShareBookingCredit=...
Team_ShareExtraServices bool
?Team_ShareExtraServices=...
Team_ShareTimePasses bool
?Team_ShareTimePasses=...
Team_Skype string
?Team_Skype=...
Team_TransferCreditsToPayingMember bool
?Team_TransferCreditsToPayingMember=...
Team_TunnelPrivateGroupId string
?Team_TunnelPrivateGroupId=...
Team_Twitter string
?Team_Twitter=...
Team_UseSpecialPrices bool
?Team_UseSpecialPrices=...
Team_PayingMemberFullName string
?Team_PayingMemberFullName=...
Team_DefaultMemberTariffName string
?Team_DefaultMemberTariffName=...
Team_TeamMembers List of Coworker
?Team_TeamMembers=...

Range search querystring parameters
Lets you search team records based on a range of date or numeric values.
To_Team_CreatedOn date
?To_Team_CreatedOn=2010-01-01T20:32
From_Team_CreatedOn date
?From_Team_CreatedOn=2010-01-01T20:32
To_Team_UpdatedOn date
?To_Team_UpdatedOn=2010-01-01T20:32
From_Team_UpdatedOn date
?From_Team_UpdatedOn=2010-01-01T20:32
To_Team_MaxTeamMemberCount number
?To_Team_MaxTeamMemberCount=0
From_Team_MaxTeamMemberCount number
?From_Team_MaxTeamMemberCount=10
To_Team_DiscountExtraServices number
?To_Team_DiscountExtraServices=0
From_Team_DiscountExtraServices number
?From_Team_DiscountExtraServices=10
To_Team_DiscountTimePasses number
?To_Team_DiscountTimePasses=0
From_Team_DiscountTimePasses number
?From_Team_DiscountTimePasses=10
To_Team_DiscountCharges number
?To_Team_DiscountCharges=0
From_Team_DiscountCharges number
?From_Team_DiscountCharges=10
To_Team_DiscountTariffs number
?To_Team_DiscountTariffs=0
From_Team_DiscountTariffs number
?From_Team_DiscountTariffs=10
To_Team_ActiveContracts number
?To_Team_ActiveContracts=0
From_Team_ActiveContracts number
?From_Team_ActiveContracts=10

Example request

GET https://spaces.nexudus.com/api/spaces/teams?Team_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Description": "Descripción",
        "TunnelPrivateGroupId": "Abc123456",
        "CreateSingleInvoiceForTeam": false,
        "UseSpecialPrices": false,
        "PayingMember": ,
        "DefaultMemberTariff": ,
        "MaxTeamMemberCount": ,
        "TransferCreditsToPayingMember": false,
        "ShareTimePasses": false,
        "ShareExtraServices": false,
        "ShareBookingCredit": false,
        "DiscountExtraServices": ,
        "DiscountTimePasses": ,
        "DiscountCharges": ,
        "DiscountTariffs": ,
        "ProfileSummary": "null",
        "ProfileTags": "BusinessArea",
        "ProfileWebsite": "ProfileWebsite",
        "GoogleMapsLink": "GoogleMapsLink",
        "ProfileIsPublic": false,
        "Twitter": "Twitter",
        "Facebook": "Facebook",
        "Linkedin": "Linkedin",
        "Skype": "Skype",
        "CoworkerIds": "Abc123456",
        "CoworkerFullNames": "Abc123456",
        "CoworkerBillingNames": "Abc123456",
        "ActiveContracts": ,
        "TeamPayingMemberFullName": "...",
        "TeamDefaultMemberTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e7e8476d-70af-4bd7-ac47-f22c4d26ff07",
        "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 Teams by IDs

Gets one or more team records based on their Id.
GET https://spaces.nexudus.com/api/spaces/teams?Team_Id=[:id1,:id2,...]

🔒 Requires role "Team-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Description": "Descripción",
        "TunnelPrivateGroupId": "Abc123456",
        "CreateSingleInvoiceForTeam": false,
        "UseSpecialPrices": false,
        "PayingMember": ,
        "DefaultMemberTariff": ,
        "MaxTeamMemberCount": ,
        "TransferCreditsToPayingMember": false,
        "ShareTimePasses": false,
        "ShareExtraServices": false,
        "ShareBookingCredit": false,
        "DiscountExtraServices": ,
        "DiscountTimePasses": ,
        "DiscountCharges": ,
        "DiscountTariffs": ,
        "ProfileSummary": "null",
        "ProfileTags": "BusinessArea",
        "ProfileWebsite": "ProfileWebsite",
        "GoogleMapsLink": "GoogleMapsLink",
        "ProfileIsPublic": false,
        "Twitter": "Twitter",
        "Facebook": "Facebook",
        "Linkedin": "Linkedin",
        "Skype": "Skype",
        "CoworkerIds": "Abc123456",
        "CoworkerFullNames": "Abc123456",
        "CoworkerBillingNames": "Abc123456",
        "ActiveContracts": ,
        "TeamPayingMemberFullName": "...",
        "TeamDefaultMemberTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "43fe8975-4d34-43e2-8b04-710923185e18",
        "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 Team by Id

Gets one team record by its Id.
GET https://spaces.nexudus.com/api/spaces/teams/:Id

🔒 Requires role "Team-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ActiveContracts": ,
  "BusinessId": 12345678,
  "CoworkerBillingNames": "Abc123456",
  "CoworkerFullNames": "Abc123456",
  "CoworkerIds": "Abc123456",
  "CreateSingleInvoiceForTeam": false,
  "DefaultMemberTariffId": 12345678,
  "Description": "Descripción",
  "DiscountCharges": ,
  "DiscountExtraServices": ,
  "DiscountTariffs": ,
  "DiscountTimePasses": ,
  "Facebook": "Facebook",
  "GoogleMapsLink": "GoogleMapsLink",
  "Linkedin": "Linkedin",
  "MaxTeamMemberCount": ,
  "Name": "Name",
  "PayingMemberId": 12345678,
  "ProfileIsPublic": false,
  "ProfileSummary": "null",
  "ProfileTags": "BusinessArea",
  "ProfileWebsite": "ProfileWebsite",
  "ShareBookingCredit": false,
  "ShareExtraServices": false,
  "ShareTimePasses": false,
  "Skype": "Skype",
  "TransferCreditsToPayingMember": false,
  "TunnelPrivateGroupId": "Abc123456",
  "Twitter": "Twitter",
  "UseSpecialPrices": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "e5a86b19-e6ea-49c2-a729-d650d5bcad7c",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new Team

Creates a new team.
POST https://spaces.nexudus.com/api/spaces/teams

🔒 Requires role "Team-Create"

Body parameters
BusinessId: number required
Name: string required
Description: string optional
TunnelPrivateGroupId: string optional
CreateSingleInvoiceForTeam: bool optional
UseSpecialPrices: bool optional
PayingMemberId: number optional
DefaultMemberTariffId: number optional
MaxTeamMemberCount: decimal? optional
TransferCreditsToPayingMember: bool optional
ShareTimePasses: bool optional
ShareExtraServices: bool optional
ShareBookingCredit: bool optional
DiscountExtraServices: decimal? optional
DiscountTimePasses: decimal? optional
DiscountCharges: decimal? optional
DiscountTariffs: decimal? optional
ProfileSummary: string optional
ProfileTags: string optional
ProfileWebsite: string optional
GoogleMapsLink: string optional
ProfileIsPublic: bool optional
Twitter: string optional
Facebook: string optional
Linkedin: string optional
Skype: string optional
CoworkerIds: string optional
CoworkerFullNames: string optional
CoworkerBillingNames: string optional
ActiveContracts: int required

Example request

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

{
    "BusinessId": 12345678,
    "Name": "Name",
    "Description": "Descripción",
    "TunnelPrivateGroupId": "Abc123456",
    "TeamMembers": [12345678, 87654321],
    "CreateSingleInvoiceForTeam": false,
    "UseSpecialPrices": false,
    "PayingMemberId": 12345678,
    "DefaultMemberTariffId": 12345678,
    "MaxTeamMemberCount": ,
    "TransferCreditsToPayingMember": false,
    "ShareTimePasses": false,
    "ShareExtraServices": false,
    "ShareBookingCredit": false,
    "DiscountExtraServices": ,
    "DiscountTimePasses": ,
    "DiscountCharges": ,
    "DiscountTariffs": ,
    "ProfileSummary": "null",
    "ProfileTags": "BusinessArea",
    "ProfileWebsite": "ProfileWebsite",
    "GoogleMapsLink": "GoogleMapsLink",
    "ProfileIsPublic": false,
    "Twitter": "Twitter",
    "Facebook": "Facebook",
    "Linkedin": "Linkedin",
    "Skype": "Skype",
    "CoworkerIds": "Abc123456",
    "CoworkerFullNames": "Abc123456",
    "CoworkerBillingNames": "Abc123456",
    "ActiveContracts": ,
}


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 Team

Updates an existing team.
PUT https://spaces.nexudus.com/api/spaces/teams

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

🔒 Requires role "Team-Edit"

Body parameters
Id: number required
The unique Id of the team to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Description: string cleared if missing
TunnelPrivateGroupId: string cleared if missing
CreateSingleInvoiceForTeam: bool cleared if missing
UseSpecialPrices: bool cleared if missing
PayingMemberId: number cleared if missing
DefaultMemberTariffId: number cleared if missing
MaxTeamMemberCount: decimal? cleared if missing
TransferCreditsToPayingMember: bool cleared if missing
ShareTimePasses: bool cleared if missing
ShareExtraServices: bool cleared if missing
ShareBookingCredit: bool cleared if missing
DiscountExtraServices: decimal? cleared if missing
DiscountTimePasses: decimal? cleared if missing
DiscountCharges: decimal? cleared if missing
DiscountTariffs: decimal? cleared if missing
ProfileSummary: string cleared if missing
ProfileTags: string cleared if missing
ProfileWebsite: string cleared if missing
GoogleMapsLink: string cleared if missing
ProfileIsPublic: bool cleared if missing
Twitter: string cleared if missing
Facebook: string cleared if missing
Linkedin: string cleared if missing
Skype: string cleared if missing
CoworkerIds: string cleared if missing
CoworkerFullNames: string cleared if missing
CoworkerBillingNames: string cleared if missing
ActiveContracts: int cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "Description": "Descripción",
    "TunnelPrivateGroupId": "Abc123456",
    "TeamMembers": [12345678, 87654321],
    "CreateSingleInvoiceForTeam": false,
    "UseSpecialPrices": false,
    "PayingMemberId": 12345678,
    "DefaultMemberTariffId": 12345678,
    "MaxTeamMemberCount": ,
    "TransferCreditsToPayingMember": false,
    "ShareTimePasses": false,
    "ShareExtraServices": false,
    "ShareBookingCredit": false,
    "DiscountExtraServices": ,
    "DiscountTimePasses": ,
    "DiscountCharges": ,
    "DiscountTariffs": ,
    "ProfileSummary": "null",
    "ProfileTags": "BusinessArea",
    "ProfileWebsite": "ProfileWebsite",
    "GoogleMapsLink": "GoogleMapsLink",
    "ProfileIsPublic": false,
    "Twitter": "Twitter",
    "Facebook": "Facebook",
    "Linkedin": "Linkedin",
    "Skype": "Skype",
    "CoworkerIds": "Abc123456",
    "CoworkerFullNames": "Abc123456",
    "CoworkerBillingNames": "Abc123456",
    "ActiveContracts": ,
}


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 Team

Deletes an existing team by its Id.
DELETE https://spaces.nexudus.com/api/spaces/teams/:Id

🔒 Requires role "Team-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/spaces/teams/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 team record IDs.
POST https://spaces.nexudus.com/api/spaces/teams/runacommand
🔒 Requires role "Team-Edit"

Example request

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


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

TeamLogo

GET https://spaces.nexudus.com/api/spaces/teams/getteamlogo/:id
URL parameters
Id: number required
The id of the Team to get the teamlogo for.

TeamImage1

GET https://spaces.nexudus.com/api/spaces/teams/getteamimage1/:id
URL parameters
Id: number required
The id of the Team to get the teamimage1 for.

TeamImage2

GET https://spaces.nexudus.com/api/spaces/teams/getteamimage2/:id
URL parameters
Id: number required
The id of the Team to get the teamimage2 for.

TeamImage3

GET https://spaces.nexudus.com/api/spaces/teams/getteamimage3/:id
URL parameters
Id: number required
The id of the Team to get the teamimage3 for.

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.