Account

APIDescription
GET api/account/managementinformation

Gets some management information for the current account.

GET api/organizations/current/account/organizationlogo/sizes/{logoSize}

Gets the logo image for the current usercompany.

PUT api/accounts/current

Updates the current account.

PUT api/organizations/current/account/organizationlogo

Updates the current organization's logo.

ApplicationMailOptions

APIDescription
GET api/organizations/{organizationId}/application-mail-options/header-image

Gets the mail header image of an organization as an image stream.

PUT api/application-mail-options

Updates ApplicationMailOptions.

Authentication

APIDescription
GET api/authenticate/is_authenticated

Gets a value indicating whether a request is authenticated.

POST api/authenticate

Serves credentials, that can be used to access VobeSoft, upon succesful authentication.

Calculator

APIDescription
POST api/modules/calculator/calculate_total

Calculates a total ObjectCalculation.

POST api/modules/calculator/calculate_individual?pageSize={pageSize}&pageIndex={pageIndex}

Calculates an individual ObjectCalculation.

POST api/modules/calculator/objectcalculations

Adds a new ObjectCalculation.

ConditionalAgendaItemStyles

APIDescription
DELETE api/conditional-agenda-item-styles/{conditionalAgendaItemStyleId}

Deletes a specific ConditionalAgendaItemStyle.

GET api/entityattributes/{entityAttributeId}/conditionalAgendaItemStyles

Gets the ConditionalAgendaItemStyles by EntityAttributeId

POST api/entityattributes/{entityAttributeId}/conditional-agenda-item-styles

Creates a new ConditionalAgendaItemStyle.

PUT api/conditional-agenda-item-styles/{conditionalAgendaItemStyleId}

Updates a specific ConditionalAgendaItemStyle.

Contact

APIDescription
POST api/contact

No documentation available.

Currencies

APIDescription
GET api/currencies

Fetches a collection of Currencies.

EntityAttributeOrderings

EntityAttributeOrderingsController

APIDescription
GET api/entityattributeorderings/{entityAttributeOrderingId}

Gets a specific EntityAttributeOrder.

POST api/entityattributeorderings

Adds a new EntityAttributeOrdering.

PUT api/entityattributeorderings/{entityAttributeOrderingId}

Updates an existing EntityAttributeOrdering.

EntityCriteriaLists

APIDescription
GET api/entitycriterialists/{entityCriteriaListId}

Gets a specific EntityCriteriaList.

GET api/entitycriterialists/{entityCriteriaListId}/entityattributes

Gets a collection of EntityAttributes related to a specific EntityCriteriaList.

GET api/users/{userId}/entitycriterialists

Gets the EntityCriteriaList collection for a specific User.

GET api/users/{userId}/entitycriterialists?entityDefinitionId={entityDefinitionId}

Gets the EntityCriteriaList collection for a specific User.

POST api/entitycriterialists

Adds a new EntityCriteriaList.

PUT api/entitycriterialists/{entityCriteriaListId}

Updates a specific EntityCriteriaList.

PUT api/entitycriterialists/{entityCriteriaListId}/name

Updates the name of an EntityCriteriaList.

EntityDefinitionExports

APIDescription
GET api/entitydefinitionexports

Gets an EntityDefinitionExport collection for the current UserCompany.

EntityInstanceExport

APIDescription
POST api/EntityInstanceExport

Creates an Excel export.

FileDirectories

APIDescription
DELETE api/organizations/current/filedirectories/{fileDirectoryId}

Deletes a specific FileDirectory.

GET api/organizations/current/filedirectories

Gets the FileDirectory tree of the current organization.

POST api/organizations/current/filedirectories

Adds a new FileDirectory.

PUT api/organizations/current/filedirectories/{fileDirectoryId}

Updates a specific FileDirectory.

Files

A controller that exposes file related actions.

APIDescription
GET api/organizations/current/files?query={query}&pageIndex={pageIndex}&pageSize={pageSize}

Gets a file collection corresponding to the specified search query, pageIndex and pageSize.

GeneralStatistics

APIDescription
GET api/general-statistics

Gets the general statistics of the application.

Pictures

APIDescription
POST api/organizations/current/pictures/{pictureId}/crop

Crops a picture.

POST api/organizations/current/pictures

Adds a new Picture.

Pipeflows

APIDescription
DELETE api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}

Deletes a specific Pipeflow.

DELETE api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}/userdefaultpipeflowfilter

Deletes a User_DefaultPipeflowFilter for a specific Pipeflow and the current User.

GET api/organizations/current/users/current/modules/pipeflow/lastselectedpipeflow

Gets the LastSelectedPipeflow for the current User.

GET api/organizations/current/modules/pipeflows/entitydefinitions

Gets the ids of the EntityDefinitions usable by the Pipeflow module.

GET api/organizations/current/users/current/modules/pipeflows

Gets a collection of Pipeflows, with their related Pipeflow_Statuses, for the current User of the current UserCompany.

GET api/modules/pipeflows/{pipeflowId}/statuses/{status}/results?filters[0].EntityAttributeId={filters[0].EntityAttributeId}&filters[0].Value={filters[0].Value}&filters[1].EntityAttributeId={filters[1].EntityAttributeId}&filters[1].Value={filters[1].Value}&pageIndex={pageIndex}&pageSize={pageSize}

Gets the EntityInstance results for a specific Pipeflow pipe.

POST api/organizations/current/users/current/modules/pipeflows

Adds a new Pipeflow.

PUT api/organizations/current/users/current/modules/pipeflow/lastselectedpipeflow

Updates the LastSelectedPipeflow for the current User.

PUT api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}

Updates a specific Pipeflow.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatuses/{pipeflowStatusId}

Updates a specific PipeflowStatus.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatusorderings

Updates the orderings of specific PipeflowStatuses.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatuses/{pipeflowStatusId}/piperesults/{entityInstanceId}/status

Updates the status of an EntityInstance related to a Pipeflow.

POST api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}/userdefaultpipeflowfilterings

Sets the current user's default filtering for a specific Pipeflow.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatuses/{pipeflowStatusId}/entityinstanceorderings

Synchronizes the orderings of EntityInstances in regard to a specific PipeflowStatus.

PricingReference

APIDescription
GET api/pricing-reference

Fetches a PricingReference.

RecurringDates

APIDescription
DELETE api/recurringdates/{recurringDateId}

Deletes a specific RecurringDate.

GET api/entityinstance_entityattributes/{entityInstanceEntityAttributeId}/recurringdate

Gets the RecurringDate for an EntityInstance_EntityAttribute.

GET api/entityinstance_entityattributedateranges/{entityInstanceEntityAttributeDateRangeId}/recurringdate

Gets the RecurringDate for an EntityInstance_EntityAttributeDateRange.

GET api/entityobjectlistinstance_entityattributes/{entityObjectListInstanceEntityAttributeId}/recurringdate

Gets the RecurringDate for an EntityObjectListInstance_EntityAttribute.

GET api/entityobjectlistinstance_entityattributedateranges/{entityObjectListInstanceEntityAttributeDateRangeId}/recurringdate

Gets the RecurringDate for an EntityObjectListInstance_EntityAttributeDateRange.

Roles

APIDescription
DELETE api/roles/{id}

Deletes a Role.

GET api/roles/{roleId}

Gets a specific Role.

POST api/Role

Creates a new Role.

PUT api/Role

Updates a Role.

GET api/Roles

Fetches a ReadRoleViewModel collection.

UserCompanies

APIDescription
PUT api/organizations/current/additional-settings

Updates the additional settings of a UserCompany.

UserGroups

APIDescription
GET api/usergroups/{userGroupId}/users

No documentation available.

UserIntegrations

APIDescription
DELETE api/organizations/current/users/current/userintegrations?apiType={apiType}

Deletes a UserIntegration for the current User.

Users

APIDescription
GET api/users/current/change-context?userId={userId}

No documentation available.

DELETE api/users/{userId}

Deletes a specific User.

DELETE api/users/current/minimizedentities/entityinstances/{entityInstanceId}

Deletes a specific minimized EntityInstance for the current User.

DELETE api/users/current/minimizedentities/entityobjectlistinstances/{entityObjectListInstanceId}

Deletes a specific minimized EntityInstance for the current User.

GET api/users/{userId}

Gets a specific User.

GET api/users/{userId}/objectoverviewcolumnorderings

Gets a collection of User_ObjectOverviewColumnOrderings for a specific User.

GET api/users/current/permissions

No documentation available.

POST api/users

Adds a specific User.

POST api/users/current/userentitycategorylistcolumnorderings

Adds a UserEntityCategoryListColumnOrdering.

POST api/users/{userId}/user_entitydefinition_orders

Inserts User_EntityDefinitionOrders.

POST api/users/current/minimizedentities

Adds a new User_MinimizedEntity for the current User.

PUT api/users/{userId}

Updates a specific User.

PUT api/users/current/entitycategories/{entityCategoryId}/entityattributesorting

Updates the sorting of a EntityCategoryList for a specific user.

POST api/users/{userId}/entitydefinitions/{entityDefinitionId}/objectoverviewcolumnorderings

Saves the ordering of column in ObjectOverview for a specific User and EntityDefinition.

UserSettings

APIDescription
POST api/usersettings/userprofilepicture/crop

Crops a UserProfilePicture.

GET api/usersettings/userprofileinformation

Gets an existing UserProfileInformation.

GET api/usersettings/userprofilepicture/sizes/{photoSize}

Gets a UserProfilePicture.

GET api/users/{userId}/usersettings/userprofilepicture/sizes/{photoSize}

Gets a UserProfilePicture.

POST api/usersettings/profilepicture

Adds a new profile picture to a temporary directory. #NOTE: This is put into a temporary directory because the uploaded image still has to be scaled.

PUT api/usersettings/userprofileinformation

Updates the UserProfileInformation.

Weather

APIDescription
GET api/weather

Gets the current weather conditions for the currently logged in User.

WebForms

APIDescription
POST api/webforms/{webFormId}

Copies an existing WebForm.

DELETE api/webforms/{webFormId}

Deletes an existing WebForm.

GET api/webforms/{webformId}

Gets a specific WebForm.

GET api/entitydefinitions/{entityDefinitionId}/webforms

Gets a WebForm collection for a specific EntityDefinition.

GET api/webforms/{webFormId}/url

Gets the URL of a specific WebForm.

POST api/webforms/{webFormId}/createwebformfile

Creates a WebForm file corresponding to a specific WebForm.

POST api/entitydefinitions/{entityDefinitionId}/webforms

Creates a new WebForm.

PUT api/webforms/{webFormId}

Updates an existing WebForm.

Widgets

APIDescription
DELETE api/users/{userId}/widgets/{userWidgetConfigurationId}

Deletes a specific User_WidgetConfiguration.

GET api/users/{userId}/widgets

Gets a collection representing the Widget configurations of a specific User.

POST api/users/{userId}/widgets

Adds a new User_WidgetConfiguration.

PUT api/users/{userId}/listwidgetconfigurations/{userWidgetConfigurationId}/color

Updates the color associated with a ListWidget.

PUT api/users/{userId}/listwidgetconfigurations/{userWidgetConfigurationId}/entityattributeordering

Updates the EntityAttributeOrdering of a ListWidget.

PUT api/users/{userId}/listwidgetconfigurations/{userWidgetConfigurationId}/entitycriterialist

Updates the EntityCriteriaList associated with a ListWidget's instance.

PUT api/users/current/listwidgetconfigurations/{userWidgetConfigurationId}/lastsorting

Updates the last sorting of a ListWidget.

PUT api/users/current/notewidgetconfigurations/{userWidgetConfigurationId}

Updates a specific WidgetNoteConfiguration.

PUT api/users/{userId}/widgets

Updates an existing User_WidgetConfiguration collection.

GET api/Widgets

Gets a collection representing the available Widgets.