README
dot-vision-motion-api-v2
DotVisionMotionApiV2 - JavaScript client for dot-vision-motion-api-v2
Version: v2
Automatically generated by the JavaScript Swagger Codegen project:
- Build date: 2016-03-18T10:35:06.799+01:00
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Use inThe generated client is valid npm package, you can publish it as described in Publishing npm packages.
After that, you can install it into your project via:
npm install dot-vision-motion-api-v2 --save
You can also host the generated client as a git repository on github, e.g. https://github.com/YOUR_USERNAME/dot-vision-motion-api-v2
Then you can install it via:
npm install YOUR_USERNAME/dot-vision-motion-api-v2 --save
browserify
Use in browser withThe client also works in browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
you can do this in your project (assuming main.js is your entry file):
browserify main.js > bundle.js
The generated bundle.js can now be included in your HTML pages.
Getting Started
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');
var defaultClient = DotVisionMotionApiV2.ApiClient.default;
defaultClient.timeout = 10 * 1000;
defaultClient.defaultHeaders['Test-Header'] = 'test_value';
// Assuming there's a `PetApi` containing a `getPetById` method
// which returns a model object:
var api = new DotVisionMotionApiV2.PetApi();
api.getPetById(2, function(err, pet, resp) {
console.log('HTTP status code: ' + resp.status);
console.log('Response Content-Type: ' + resp.get('Content-Type'));
if (err) {
console.error(err);
} else {
console.log(pet);
}
});
Documentation for API Endpoints
All URIs are relative to http://dotvision-motion-webapi.azurewebsites.net
Class | Method | HTTP request | Description |
---|---|---|---|
DotVisionMotionApiV2.BackOfficeApi | backOfficeSendContactEmail | POST /api/backoffice/email/contact | Sends an email formatted in HTML to contact@dotvision.com |
DotVisionMotionApiV2.BackOfficeApi | backOfficeSendEmail | POST /api/backoffice/email | Sends an email with a raw text. |
DotVisionMotionApiV2.CategoriesApi | categoriesCategoriesCount | GET /api/categories/count | Get categories count |
DotVisionMotionApiV2.CategoriesApi | categoriesCreateCategory | POST /api/categories | Create a category |
DotVisionMotionApiV2.CategoriesApi | categoriesDeleteCategory | DELETE /api/categories/{id} | Delete a category |
DotVisionMotionApiV2.CategoriesApi | categoriesGetAllCategories | GET /api/categories | Get categories collection |
DotVisionMotionApiV2.CategoriesApi | categoriesGetCategory | GET /api/categories/{id} | Get a category |
DotVisionMotionApiV2.CategoriesApi | categoriesUpdateCategory | PUT /api/categories | Update a category |
DotVisionMotionApiV2.EventsApi | eventsCreateEvent | POST /api/events | Create an event |
DotVisionMotionApiV2.EventsApi | eventsDeleteEvent | DELETE /api/events/{id} | Delete an event |
DotVisionMotionApiV2.EventsApi | eventsDeleteUniqueNameForEvent | DELETE /api/events/{id}/uniqueName | Delete unique name for event |
DotVisionMotionApiV2.EventsApi | eventsEventAddAdmin | POST /api/events/{id}/admins | Add an admin for an event |
DotVisionMotionApiV2.EventsApi | eventsEventAddOrganisation | POST /api/events/{id}/organisation | Link an organisation to an event |
DotVisionMotionApiV2.EventsApi | eventsEventAddParticipant | POST /api/events/{id}/participants | Add a participant on an event |
DotVisionMotionApiV2.EventsApi | eventsEventAddStage | POST /api/events/{id}/stages | Add a stage to an event |
DotVisionMotionApiV2.EventsApi | eventsEventAdminsCount | GET /api/events/{id}/admins/count | Get event administrators count |
DotVisionMotionApiV2.EventsApi | eventsEventAdminsGetAll | GET /api/events/{id}/admins | Get event administrators collection |
DotVisionMotionApiV2.EventsApi | eventsEventDeleteAdmin | DELETE /api/events/{id}/admins | Delete an administrator of an event |
DotVisionMotionApiV2.EventsApi | eventsEventDeleteOrganisation | DELETE /api/events/{id}/organisation | Unlink the organisation of an event |
DotVisionMotionApiV2.EventsApi | eventsEventDeleteParticipant | DELETE /api/events/{id}/participants | Delete a participants of an event |
DotVisionMotionApiV2.EventsApi | eventsEventDeleteStage | DELETE /api/events/{id}/stages/{stageId} | Delete the stage of an event |
DotVisionMotionApiV2.EventsApi | eventsEventParticipantsCount | GET /api/events/{id}/participants/count | Get event participants count |
DotVisionMotionApiV2.EventsApi | eventsEventParticipantsGetAll | GET /api/events/{id}/participants | Get event participants collection |
DotVisionMotionApiV2.EventsApi | eventsEventRegistrationsCount | GET /api/events/{id}/registrations/count | Get registrations count for an event |
DotVisionMotionApiV2.EventsApi | eventsEventStagesCount | GET /api/events/{id}/stages/count | Get event stages count |
DotVisionMotionApiV2.EventsApi | eventsEventUpdateAdmin | PUT /api/events/{id}/admins | Update an administrator for an event |
DotVisionMotionApiV2.EventsApi | eventsEventUpdateParticipant | PUT /api/events/{id}/participants | Update a participant for an event |
DotVisionMotionApiV2.EventsApi | eventsEventUpdateStage | PUT /api/events/{id}/stages | Update a stage for an event |
DotVisionMotionApiV2.EventsApi | eventsGetAllCategories | GET /api/events/{id}/categories | Get all categories for an event |
DotVisionMotionApiV2.EventsApi | eventsGetAllEventStages | GET /api/events/{id}/stages | Get all event stages |
DotVisionMotionApiV2.EventsApi | eventsGetAllEvents | GET /api/events | Get events collection |
DotVisionMotionApiV2.EventsApi | eventsGetEvent | GET /api/events/{id} | Get an individual event |
DotVisionMotionApiV2.EventsApi | eventsGetEventCategoriesCount | GET /api/events/{id}/categories/count | Get number of categories for an event |
DotVisionMotionApiV2.EventsApi | eventsGetEventOrganisation | GET /api/events/{id}/organisation | Get event organisation |
DotVisionMotionApiV2.EventsApi | eventsGetEventParticipantRegistration | GET /api/events/{id}/participants/{participantId}/registration | Get registration for a participants of an event |
DotVisionMotionApiV2.EventsApi | eventsGetEventRegistrations | GET /api/events/{id}/registrations | Get registrations list for an event |
DotVisionMotionApiV2.EventsApi | eventsGetUniqueNameForEvent | GET /api/events/{id}/uniqueName | Get unique name attributed to the event |
DotVisionMotionApiV2.EventsApi | eventsLinkCategory | POST /api/events/{id}/categories | Link a category to an event |
DotVisionMotionApiV2.EventsApi | eventsPublicEventsCount | GET /api/events/count | Get public events count |
DotVisionMotionApiV2.EventsApi | eventsSearchEvents | GET /api/events/search | Search for an event by name |
DotVisionMotionApiV2.EventsApi | eventsSetUniqueNameForEvent | POST /api/events/{id}/uniqueName | Set unique name for event |
DotVisionMotionApiV2.EventsApi | eventsUnlinkCategory | DELETE /api/events/{id}/categories | Unlink a category from an event |
DotVisionMotionApiV2.EventsApi | eventsUpdateEvent | PUT /api/events | Update an event |
DotVisionMotionApiV2.EventsApi | eventsUpdateUniqueNameForEvent | PUT /api/events/{id}/uniqueName | Update unique name for event |
DotVisionMotionApiV2.OrganisationsApi | organisationsCreateOrganisation | POST /api/organisations | Create an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsDeleteOrganisation | DELETE /api/organisations/{id} | Delete an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsDeleteUniqueNameForOrganisation | DELETE /api/organisations/{id}/uniqueName | Delete unique name for organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsGetAllOrganisations | GET /api/organisations | Get organisations collection |
DotVisionMotionApiV2.OrganisationsApi | organisationsGetOrganisation | GET /api/organisations/{id} | Get an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsGetUniqueNameForOrganisation | GET /api/organisations/{id}/uniqueName | Get unique name attributed to the organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationAdminsCount | GET /api/organisations/{id}/admins/count | Get organisation administrators count |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationAdminsGetAll | GET /api/organisations/{id}/admins | Get organisation administrators collection |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationEventsGetAll | GET /api/organisations/{id}/events | Get organisation events collection |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationLinkAdmin | POST /api/organisations/{id}/admins | Link an administrator to an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationUnlinkAdmin | DELETE /api/organisations/{id}/admins | Unlink an administrator of an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationUpdateLinkAdmin | PUT /api/organisations/{id}/admins | Update an administrator link for an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationsCount | GET /api/organisations/count | Get organisations count |
DotVisionMotionApiV2.OrganisationsApi | organisationsOrganisationsEventsCount | GET /api/organisations/{id}/events/count | Get organisation events count |
DotVisionMotionApiV2.OrganisationsApi | organisationsSearchOrganisations | GET /api/organisations/search | Search for an organisation by name |
DotVisionMotionApiV2.OrganisationsApi | organisationsSetUniqueNameForOrganisation | POST /api/organisations/{id}/uniqueName | Set unique name for organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsUpdateOrganisation | PUT /api/organisations | Update an organisation |
DotVisionMotionApiV2.OrganisationsApi | organisationsUpdateUniqueNameForOrganisation | PUT /api/organisations/{id}/uniqueName | Update unique name for organisation |
DotVisionMotionApiV2.ParticipantsApi | participantsAddTeammateToTeam | POST /api/participants/{id}/teammates | Add a teammate to a team |
DotVisionMotionApiV2.ParticipantsApi | participantsCountTeammates | GET /api/participants/{id}/teammates/count | Get teammates count for a team |
DotVisionMotionApiV2.ParticipantsApi | participantsGetAllActivities | GET /api/participants/{id}/activities | Get all activities for a participant |
DotVisionMotionApiV2.ParticipantsApi | participantsGetAllCategories | GET /api/participants/{id}/categories | Get all categories for a participant |
DotVisionMotionApiV2.ParticipantsApi | participantsGetAllTeammates | GET /api/participants/{id}/teammates | Get all teammates for a team |
DotVisionMotionApiV2.ParticipantsApi | participantsGetAssociatedUser | GET /api/participants/{id}/associatedUser | Get the user associated with participant |
DotVisionMotionApiV2.ParticipantsApi | participantsGetCategoriesCountForParticipant | GET /api/participants/{id}/categories/count | Get number of categories for a participant |
DotVisionMotionApiV2.ParticipantsApi | participantsGetParticipant | GET /api/participants/{id} | Get a participant |
DotVisionMotionApiV2.ParticipantsApi | participantsGetRoleForTeammate | GET /api/participants/{id}/teammates/{participantId}/teamRole | Get role for a teammate |
DotVisionMotionApiV2.ParticipantsApi | participantsGetTeammate | GET /api/participants/{id}/teammates/{participantId} | Get a teammate of a team |
DotVisionMotionApiV2.ParticipantsApi | participantsLinkCategory | POST /api/participants/{id}/categories | Link a category to a participant |
DotVisionMotionApiV2.ParticipantsApi | participantsRemoveTeammateFromTeam | DELETE /api/participants/{id}/teammates/{participantId} | Delete a teammate |
DotVisionMotionApiV2.ParticipantsApi | participantsUnlinkCategory | DELETE /api/participants/{id}/categories | Unlink a category from a participant |
DotVisionMotionApiV2.ParticipantsApi | participantsUpdateTeammate | PUT /api/participants/{id}/teammates | Update a teammate |
DotVisionMotionApiV2.RegistrationsApi | registrationsCreateRegistration | POST /api/registrations | Create a registration |
DotVisionMotionApiV2.RegistrationsApi | registrationsDeleteRegistration | DELETE /api/registrations | Delete a registration |
DotVisionMotionApiV2.RegistrationsApi | registrationsGetRegistration | GET /api/registrations/{id} | Get an individual registration |
DotVisionMotionApiV2.RegistrationsApi | registrationsGetRegistrationsForEmail | GET /api/registrations | Get registrations collection for an email |
DotVisionMotionApiV2.RegistrationsApi | registrationsPublicRegistrationsCount | GET /api/registrations/count | Get registrations count |
DotVisionMotionApiV2.RegistrationsApi | registrationsUpdateRegistration | PUT /api/registrations | Update a registration |
DotVisionMotionApiV2.RolesApi | rolesCreateRole | POST /api/roles | Create a role |
DotVisionMotionApiV2.RolesApi | rolesDeleteRole | DELETE /api/roles/{id} | Delete a role |
DotVisionMotionApiV2.RolesApi | rolesGetAllRoles | GET /api/roles | Get roles collection |
DotVisionMotionApiV2.RolesApi | rolesGetRole | GET /api/roles/{id} | Get a role |
DotVisionMotionApiV2.RolesApi | rolesRolesCount | GET /api/roles/count | Get roles count |
DotVisionMotionApiV2.RolesApi | rolesUpdateRole | PUT /api/roles | Update a role |
DotVisionMotionApiV2.StagesApi | stagesCreateActivity | POST /api/stages/{id}/activities | Create activity for a stage |
DotVisionMotionApiV2.StagesApi | stagesCreateStageStatus | POST /api/stages/{id}/stageStatus | Create a status for a stage |
DotVisionMotionApiV2.StagesApi | stagesDeleteActivity | DELETE /api/stages/{id}/activities | Delete activity of a stage |
DotVisionMotionApiV2.StagesApi | stagesDeleteStageStatus | DELETE /api/stages/{id}/stageStatus | Delete a stage status |
DotVisionMotionApiV2.StagesApi | stagesGetAllActivities | GET /api/stages/{id}/activities | Get all activities for a stage |
DotVisionMotionApiV2.StagesApi | stagesGetAllCategories | GET /api/stages/{id}/categories | Get all categories for a stage |
DotVisionMotionApiV2.StagesApi | stagesGetAllCategoriesForActivity | GET /api/stages/{id}/activities/{activityId}/categories | Get all categories for an activity |
DotVisionMotionApiV2.StagesApi | stagesGetCategoriesCountForActivity | GET /api/stages/{id}/activities/{activityId}/categories/count | Get number of categories for an activity |
DotVisionMotionApiV2.StagesApi | stagesGetLastStageStatus | GET /api/stages/{id}/lastStageStatus | Get last status of a stage |
DotVisionMotionApiV2.StagesApi | stagesGetParticipant | GET /api/stages/{id}/activities/{activityId}/participant | Get participant associated to the activity of a stage |
DotVisionMotionApiV2.StagesApi | stagesGetStage | GET /api/stages/{id} | Get a stage |
DotVisionMotionApiV2.StagesApi | stagesGetStageCategoriesCount | GET /api/stages/{id}/categories/count | Get number of categories for a stage |
DotVisionMotionApiV2.StagesApi | stagesGetStageStatus | GET /api/stages/{id}/stageStatus | Get status of a stage |
DotVisionMotionApiV2.StagesApi | stagesLinkCategory | POST /api/stages/{id}/activities/{activityId}/categories | Link a category to an activity |
DotVisionMotionApiV2.StagesApi | stagesLinkCategory_0 | POST /api/stages/{id}/categories | Link a category to a stage |
DotVisionMotionApiV2.StagesApi | stagesUnlinkCategory | DELETE /api/stages/{id}/activities/{activityId}/categories | Unlink a category from an activity |
DotVisionMotionApiV2.StagesApi | stagesUnlinkCategory_0 | DELETE /api/stages/{id}/categories | Unlink a category from a stage |
DotVisionMotionApiV2.StagesApi | stagesUpdateActivity | PUT /api/stages/{id}/activities | Update activity of a stage |
DotVisionMotionApiV2.TeamRolesApi | teamRolesCreateTeamRole | POST /api/teamroles | Create a team role |
DotVisionMotionApiV2.TeamRolesApi | teamRolesDeleteTeamRole | DELETE /api/teamroles/{id} | Delete a role |
DotVisionMotionApiV2.TeamRolesApi | teamRolesGetAllTeamRoles | GET /api/teamroles | Get team roles collection |
DotVisionMotionApiV2.TeamRolesApi | teamRolesGetTeamRole | GET /api/teamroles/{id} | Get a team role |
DotVisionMotionApiV2.TeamRolesApi | teamRolesTeamRolesCount | GET /api/teamroles/count | Get team roles count |
DotVisionMotionApiV2.TeamRolesApi | teamRolesUpdateTeamRole | PUT /api/teamroles | Update a team role |
DotVisionMotionApiV2.UniqueNamesApi | uniqueNamesGetObjectForUniqueName | GET /api/uniqueNames/{uniqueName} | Get object refered by unique name |
DotVisionMotionApiV2.UniqueNamesApi | uniqueNamesGetUniqueName | GET /api/uniqueNames/{id} | Get unique name attributed to the object id |
DotVisionMotionApiV2.UsersApi | usersAcceptRegistrationForUser | PUT /api/users/{id}/registrations/{registrationId}/accept | Accept a user registration |
DotVisionMotionApiV2.UsersApi | usersDeclineRegistrationForUser | PUT /api/users/{id}/registrations/{registrationId}/decline | Decline a user registration |
DotVisionMotionApiV2.UsersApi | usersDeleteUniqueNameForUser | DELETE /api/users/{id}/uniqueName | Delete unique name for user |
DotVisionMotionApiV2.UsersApi | usersGetEventsAsAdmin | GET /api/users/{id}/eventsAsAdmin | Get list of events in witch user is involved as an administrator |
DotVisionMotionApiV2.UsersApi | usersGetEventsAsAdminCount | GET /api/users/{id}/eventsAsAdmin/count | Get number of events in witch user is involved as an administrator |
DotVisionMotionApiV2.UsersApi | usersGetEventsAsParticipant | GET /api/users/{id}/eventsAsParticipant | Get list of events in witch user is involved as a participant |
DotVisionMotionApiV2.UsersApi | usersGetEventsAsParticipantCount | GET /api/users/{id}/eventsAsParticipant/count | Get number of events in witch user is involved as a participant |
DotVisionMotionApiV2.UsersApi | usersGetMe | GET /api/users/me | Get current claims of connected user |
DotVisionMotionApiV2.UsersApi | usersGetOrganisationsAsAdmin | GET /api/users/{id}/organisationsAsAdmin | Get list of organisations in witch user is involved as an administrator |
DotVisionMotionApiV2.UsersApi | usersGetOrganisationsAsAdminCount | GET /api/users/{id}/organisationsAsAdmin/count | Get number of organisations in witch user is involved as an administrator |
DotVisionMotionApiV2.UsersApi | usersGetRegistrationsForUser | GET /api/users/{id}/registrations | Get list of registrations attributed to the user |
DotVisionMotionApiV2.UsersApi | usersGetUniqueNameForUser | GET /api/users/{id}/uniqueName | Get unique name attributed to the user |
DotVisionMotionApiV2.UsersApi | usersGetUser | GET /api/users/{id} | Get a user |
DotVisionMotionApiV2.UsersApi | usersGetUserCount | GET /api/users/count | Get users count |
DotVisionMotionApiV2.UsersApi | usersIdentity | GET /api/users/identity | Get current claims of connected user |
DotVisionMotionApiV2.UsersApi | usersSearchUsers | GET /api/users/search | Search for a user by name |
DotVisionMotionApiV2.UsersApi | usersSetUniqueNameForUser | POST /api/users/{id}/uniqueName | Set unique name for user |
DotVisionMotionApiV2.UsersApi | usersStandByRegistrationForUser | PUT /api/users/{id}/registrations/{registrationId}/standby | Answer "Perhaps" for a user registration |
DotVisionMotionApiV2.UsersApi | usersUpdateUniqueNameForUser | PUT /api/users/{id}/uniqueName | Update unique name for user |
DotVisionMotionApiV2.UsersApi | usersUpdateUser | PUT /api/users | Update a user |
DotVisionMotionApiV2.UsersApi | usersUserNameExist | GET /api/users/exist | |
DotVisionMotionApiV2.UsersApi | usersUserRegistrationsCount | GET /api/users/{id}/registrations/count | Get registrations count for a user |
Documentation for Models
- DotVisionMotionApiV2.ActivityModel
- DotVisionMotionApiV2.CategoryModel
- DotVisionMotionApiV2.ContactModel
- DotVisionMotionApiV2.EmailModel
- DotVisionMotionApiV2.EventModel
- DotVisionMotionApiV2.ModelObject
- DotVisionMotionApiV2.OrganisationModel
- DotVisionMotionApiV2.ParticipantModel
- DotVisionMotionApiV2.PlaceModel
- DotVisionMotionApiV2.RegistrationModel
- DotVisionMotionApiV2.RoleModel
- DotVisionMotionApiV2.StageModel
- DotVisionMotionApiV2.StageStatusModel
- DotVisionMotionApiV2.TeamRoleModel
- DotVisionMotionApiV2.TeammateModel
- DotVisionMotionApiV2.UniqueNameModel
- DotVisionMotionApiV2.UserInRolesModel
- DotVisionMotionApiV2.UserModel
- DotVisionMotionApiV2.UserRoleModel
Documentation for Authorization
apiKey
- Type: API key
- API key parameter name: api_key
- Location: HTTP header