{"swagger":"2.0","info":{"version":"v1","title":"VEO.API"},"host":"api.veo.co.uk","schemes":["https"],"paths":{"/api/auth/login-method":{"post":{"tags":["Auth"],"summary":"Returns the available authentication methods for an email address based on its domain.\r\nUsed by the frontend to determine whether to show password login, Microsoft SSO, or both.","operationId":"Auth_GetLoginMethod","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The login method request containing the email address","required":true,"schema":{"$ref":"#/definitions/LoginMethodRequestDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LoginMethodResponseDTO"}}}}},"/api/bots":{"get":{"tags":["Bot"],"summary":"Gets a list of bots.","operationId":"Bot_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BotDTO"}}}}}},"/api/communities":{"get":{"tags":["Community"],"summary":"Fetch all communities","operationId":"Community_GetCommunities","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"query","required":false,"type":"string"},{"name":"visibility","in":"query","required":false,"type":"string"},{"name":"createdByMe","in":"query","required":false,"type":"boolean"},{"name":"organisationId","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["Community"],"summary":"Create a community","operationId":"Community_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/CommunityPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}}}},"/api/communities/{id}":{"get":{"tags":["Community"],"summary":"Get a community","operationId":"Community_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The community identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CommunityGetDTO"}}}},"put":{"tags":["Community"],"summary":"Updates a community","operationId":"Community_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The community identifier","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/CommunityPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}}},"delete":{"tags":["Community"],"summary":"Deletes a community","operationId":"Community_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The community identifier.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/communities/invite":{"post":{"tags":["Community"],"summary":"Sends an email with invitation to join community","operationId":"Community_PostUserInvite","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/CommunityInvitePostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/communities/invite/accept/{hash}":{"get":{"tags":["Community"],"summary":"Accepts invite to join community, if hash is valid","operationId":"Community_AcceptUserInvite","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"hash","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/communities/invite/accept":{"post":{"tags":["Community"],"summary":"Accepts invite to join community, if hash is valid","operationId":"Community_AcceptUserInvitePost","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"hashDTO","in":"body","required":true,"schema":{"$ref":"#/definitions/InviteHashPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/communities/{communityId}/adminaccept/{userId}":{"get":{"tags":["Community"],"summary":"Accepts invite to join community, if hash is valid","operationId":"Community_AdminAcceptUserInvite","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/communities/{id}/posts":{"get":{"tags":["Community"],"summary":"Get community posts","operationId":"Community_GetPostList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"an community id","required":true,"type":"integer","format":"int64"},{"name":"pageNumber","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[PostGetDTO]"}}}}},"/api/community/{communityId}/files":{"get":{"tags":["Community"],"operationId":"Community_GetCommunityFilesAsync","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"uploadedByMe","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/user-activity":{"get":{"tags":["Community"],"summary":"Counts the amount of times user posted/commented on posts. \r\nAdds the user to a list and returns the list sorted by total number of comments and posts","operationId":"Community_GetMostActiveUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/post-activity":{"get":{"tags":["Community"],"operationId":"Community_GetMostActivePosts","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/post-recent":{"get":{"tags":["Community"],"operationId":"Community_GetMostRecentPosts","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/hashtags-recent":{"get":{"tags":["Community"],"summary":"gets all the recent hashtag of a single community's timeline","operationId":"Community_GetRecentHashtags","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/hashtags-popular":{"get":{"tags":["Community"],"summary":"Endpoint for most popular hashtags","operationId":"Community_GetPopularHashtags","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/communities/{id}/image":{"get":{"tags":["Community"],"operationId":"Community_GetCommunityImages","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/communities/{id}/features":{"get":{"tags":["Community"],"operationId":"Community_GetCommunityFeatures","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"put":{"tags":["Community"],"operationId":"Community_PutCommunityFeatures","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/PutCommunityFeaturesDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/members/nonmembers/{communityId}":{"get":{"tags":["CommunityUserMember"],"summary":"Get all Users who are not currently in the community","operationId":"CommunityUserMember_GetNonMembersForCommunity","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/members/members/{communityId}":{"get":{"tags":["CommunityUserMember"],"summary":"Gets all Users who are members of a community (can be filtered by admin)","operationId":"CommunityUserMember_GetCommunityMembers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"onlyUsers","in":"query","description":"","required":false,"type":"boolean"},{"name":"organisationId","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"isAccepted","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/members/addmember/{userId}":{"post":{"tags":["CommunityUserMember"],"summary":"adds a member to a community (can be promoted to admin instantly)","operationId":"CommunityUserMember_AssignMemberToCommunity","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"admin","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/members/promote/{userId}":{"put":{"tags":["CommunityUserMember"],"summary":"promotes a single User to the admin status","operationId":"CommunityUserMember_PromoteCommunityMember","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/community/{communityId}/members/remove/{userId}":{"delete":{"tags":["CommunityUserMember"],"summary":"removes a user from the member list of a single community","operationId":"CommunityUserMember_RemoveCommunityMember","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/lookup/countries":{"get":{"tags":["Country"],"summary":"Get a list of countries","operationId":"Country_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CountryLookupDTO"}}}}}},"/api/datacentres":{"get":{"tags":["DataCentre"],"summary":"Gets a list of datacentres","operationId":"DataCentre_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DataCentreDTO"}}}}}},"/api/files/fileupload/{id}":{"put":{"tags":["File"],"operationId":"File_UploadPostFile","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/files/community/fileupload/{communityId}":{"put":{"tags":["File"],"operationId":"File_UploadPostFileForCommunity","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/files/portfolio/fileupload/{portfolioId}":{"put":{"tags":["File"],"operationId":"File_UploadFileForPortfolio","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"portfolioId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/images/user/{id}":{"put":{"tags":["Image"],"operationId":"Image_UploadUserPicture","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["Image"],"operationId":"Image_RemoveUserPicture","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/images/community/{id}/cover":{"put":{"tags":["Image"],"operationId":"Image_UploadCommunityCoverPicture","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/images/community/{id}/profile":{"put":{"tags":["Image"],"operationId":"Image_UploadCommunityProfilePicture","consumes":["multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"File","in":"formData","description":"Select a file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/me/switchdefaultorganisation/{organisationId}":{"get":{"tags":["Me"],"summary":"If a user belongs to more than one organisation, they can switch their default organisation \r\nusing this endpoint.","operationId":"Me_SwitchOrganisation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/me/logoutnotification":{"get":{"tags":["Me"],"summary":"Get the user profile","operationId":"Me_LogoutNotificationAsync","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/me":{"get":{"tags":["Me"],"summary":"Get the user profile","operationId":"Me_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserProfileGetDTO"}}}},"put":{"tags":["Me"],"summary":"Update the user profile","operationId":"Me_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/UserProfilePutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/me/accept-terms":{"post":{"tags":["Me"],"summary":"Accept terms and conditions and privacy policy","operationId":"Me_AcceptTerms","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/me/videos":{"get":{"tags":["Me"],"summary":"Get the videos for the current user","operationId":"Me_ListVideos","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"query","description":"","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VideoForLookupDTO"}}}},"deprecated":true}},"/api/taggedVideos":{"get":{"tags":["Me"],"summary":"Get all taggedVideos for the current user","operationId":"Me_ListTaggedVideos","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"status","in":"query","description":"<br />1 = Autosaved, 2 = Complete","required":true,"type":"integer","format":"int32","enum":[1,2]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TaggedVideoDTO"}}}},"deprecated":true}},"/api/me/communities":{"get":{"tags":["Me"],"summary":"Get a paged list of communities for the current user","operationId":"Me_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"query","description":"","required":true,"type":"string"},{"name":"administrators","in":"query","description":"","required":false,"type":"boolean"},{"name":"returnPagedList","in":"query","description":"","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"},{"name":"createdByMe","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[CommunityForListDTO]"}}}}},"/api/me/communities/recent-activities":{"get":{"tags":["Me"],"operationId":"Me_GetRecentActivites","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/me/profilestats":{"get":{"tags":["Me"],"summary":"Get the profile statistics","operationId":"Me_GetProfileStats","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserProfileStatsGetDTO"}}}}},"/api/me/organisations":{"get":{"tags":["Me"],"summary":"Gets the organisations that the user belongs to","operationId":"Me_GetOrganisations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OrganisationSimpleGetDTO"}}}}}},"/api/me/shared/activities":{"get":{"tags":["Me"],"operationId":"Me_GetSharedActivities","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/me/shared/videos":{"get":{"tags":["Me"],"summary":"gets all the video for a single user (he's the author, it's shared with him directly, it's shared with the community he's in)","operationId":"Me_GetSharedVideos","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/me/community/invites":{"get":{"tags":["Me"],"operationId":"Me_GetCommunityInvites","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchTerm","in":"query","required":false,"type":"string"},{"name":"orderByDirection","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/me/getuser/{userId}":{"get":{"tags":["Me"],"operationId":"Me_GetUserFromVEO","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/me/get-organisation-users/tag-group/{videoId}":{"get":{"tags":["Me"],"operationId":"Me_GetOrganisationUsersForTagSetAdmins","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/lookup/metadata":{"get":{"tags":["Metadata"],"summary":"Get a list of metadata","operationId":"Metadata_GetMetadataLookup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"typeId","in":"query","description":"The metadata type - 1 = postrecord, 2 = prerecord<br />1 = Prerecord, 2 = Postrecord","required":true,"type":"integer","format":"int32","enum":[1,2]},{"name":"organisationId","in":"query","description":"Optional organisation id","required":false,"type":"integer","format":"int32"},{"name":"includeHidden","in":"query","description":"The include hidden flag","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MetadataLookupDTO"}}}}}},"/api/metadata":{"get":{"tags":["Metadata"],"summary":"Get the metadata by id","operationId":"Metadata_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"The metadata identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MetadataGetDTO"}}}},"post":{"tags":["Metadata"],"summary":"Create a metadata","operationId":"Metadata_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MetadataPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/metadata/{id}":{"put":{"tags":["Metadata"],"summary":"Update a metadata","operationId":"Metadata_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"the metadata indentifier","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MetadataPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/notifications":{"get":{"tags":["Notification"],"summary":"Get a paged list of notifications","operationId":"Notification_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[NotificationForListDTO]"}}}}},"/api/notifications/{id}":{"delete":{"tags":["Notification"],"summary":"Deletes a notification","operationId":"Notification_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/lookup/organisations":{"get":{"tags":["Organisation"],"summary":"Get a list of organisations","operationId":"Organisation_GetOrganisationLookup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"IsActive","in":"query","required":false,"type":"boolean"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"orderBy","in":"query","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/organisations":{"get":{"tags":["Organisation"],"summary":"Get a paged list of organisations","operationId":"Organisation_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"query","description":"the organaisation name","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"the page number","required":false,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"the order by column. Valid values are NAME or CREATESTAMP","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"the order by direction. Valid values are ASC or DESC","required":false,"type":"string"},{"name":"showActive","in":"query","description":"the show active flag","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[OrganisationForListDTO]"}}}}},"/api/organisations/{id}/communities":{"get":{"tags":["Organisation"],"summary":"Gets list of communities assigned to an organisation","operationId":"Organisation_Search","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The organisation identifier","required":true,"type":"integer","format":"int32"},{"name":"name","in":"query","description":"The community name","required":false,"type":"string"},{"name":"type","in":"query","description":"The community type<br />1 = SingleUser, 2 = Users, 3 = SingleBusinessUnit, 4 = Organisations, 5 = VideoControllers, 6 = Site","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CommunityGetDTO"}}}}}},"/api/organisations/{id}/communities/page/{pageNumber}":{"get":{"tags":["Organisation"],"summary":"Get a paged List of communities for an organisation","operationId":"Organisation_PagedSearch","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"the organisation identifier","required":true,"type":"integer","format":"int32"},{"name":"pageNumber","in":"path","description":"the page number","required":true,"type":"integer","format":"int32"},{"name":"name","in":"query","description":"the community name","required":false,"type":"string"},{"name":"type","in":"query","description":"the community type<br />1 = SingleUser, 2 = Users, 3 = SingleBusinessUnit, 4 = Organisations, 5 = VideoControllers, 6 = Site","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]},{"name":"orderBy","in":"query","description":"the order by column. Valid values are NAME or TYPE","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"the order by direction. Valid values are ASC or DESC","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/api/organisations/{id}":{"get":{"tags":["Organisation"],"summary":"Get an organisation","operationId":"Organisation_GetOrganisation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OrganisationGetDTO"}}}}},"/api/organisations/{id}/image":{"get":{"tags":["Organisation"],"summary":"Get an organisation image if available.","operationId":"Organisation_GetOrganisationImage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OrganisationImageDTO"}}}}},"/api/v2/organisations/{id}":{"put":{"tags":["Organisation"],"operationId":"Organisation_UpdateOrganisationV2","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/OrganisationPutV2DTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/organisations/{id}/tagsets":{"get":{"tags":["OrganisationTagSet"],"summary":"Get a list of tag sets assigned to an organisation","operationId":"OrganisationTagSet_List","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"includeUnpublished","in":"query","description":"","required":false,"type":"boolean"},{"name":"isOrganisationWide","in":"query","description":"","required":false,"type":"boolean"},{"name":"visibility","in":"query","description":"","required":false,"type":"string"},{"name":"status","in":"query","description":"","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OrganisationTagSetListWithAuthorDTO"}}}}}},"/api/portfolios/{id}":{"get":{"tags":["Portfolio"],"summary":"Get a portoflio by id","operationId":"Portfolio_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PortfolioGetDTO"}}}},"put":{"tags":["Portfolio"],"summary":"Updates a portfolio","operationId":"Portfolio_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/PortfolioPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["Portfolio"],"summary":"Delete a portoflio by id","operationId":"Portfolio_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/{id}/tagsets":{"get":{"tags":["Portfolio"],"summary":"Get a list of tag sets for a portfolio","operationId":"Portfolio_PortfolioTagsets","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PortfolioTagsetsGetDTO"}}}}},"/api/portfolios/v2/search":{"get":{"tags":["Portfolio"],"summary":"New version of searching portfolios","operationId":"Portfolio_SearchV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchTerm","in":"query","description":"","required":false,"type":"string"},{"name":"searchType","in":"query","description":"<br />1 = SingleUser, 2 = Shared, 3 = SharedSingleUser","required":false,"type":"integer","format":"int32","enum":[1,2,3]},{"name":"startDate","in":"query","description":"","required":false,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":false,"type":"string","format":"date-time"},{"name":"pageSize","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[PortfolioGetDTO]"}}}}},"/api/portfolios":{"get":{"tags":["Portfolio"],"summary":"Get a list of portfolios for the current user","operationId":"Portfolio_List","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PortfolioCommentGetDTO"}}}}},"post":{"tags":["Portfolio"],"summary":"Create a portfolio","operationId":"Portfolio_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/PortfolioPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolio/{portfolioId}/videos/get-all":{"get":{"tags":["Portfolio"],"operationId":"Portfolio_GetPortfolioVideos","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"portfolioId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"createdByMe","in":"query","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/{portfolioId}/get-files":{"get":{"tags":["Portfolio"],"operationId":"Portfolio_GetPortfolioFiles","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"portfolioId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/{portfolioId}/remove-file/{fileId}":{"delete":{"tags":["Portfolio"],"operationId":"Portfolio_RemovePortfolioFile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"portfolioId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"fileId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/{id}/comments":{"get":{"tags":["PortfolioComment"],"summary":"Get a paged list of comments belonging to a portfolio.","operationId":"PortfolioComment_List","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier","required":true,"type":"integer","format":"int64"},{"name":"parentCommentId","in":"query","description":"The parent comment id","required":false,"type":"integer","format":"int64"},{"name":"pageNumber","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[PortfolioCommentGetDTO]"}}}},"post":{"tags":["PortfolioComment"],"summary":"Add a comment to a portfolio","operationId":"PortfolioComment_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/PortfolioCommentPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/v2/{id}/comments":{"get":{"tags":["PortfolioComment"],"summary":"Gets portfolio comments with user picture","operationId":"PortfolioComment_ListV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"parentCommentId","in":"query","description":"","required":false,"type":"integer","format":"int64"},{"name":"pageNumber","in":"query","description":"","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[PortfolioCommentGetDTO]"}}}}},"/api/portfolios/{id}/comments/{commentId}":{"delete":{"tags":["PortfolioComment"],"summary":"Removes a comment from portfolio","operationId":"PortfolioComment_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier","required":true,"type":"integer","format":"int64"},{"name":"commentId","in":"path","description":"The comment identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/{id}/documents":{"get":{"tags":["PortfolioDocument"],"summary":"Get all documents for a portfolio","operationId":"PortfolioDocument_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PortfolioDocumentForListDTO"}}}}}},"/api/portfolio/shared/users/me":{"get":{"tags":["PortfolioUserSharing"],"summary":"Gets all the portfolios currently shared with me","operationId":"PortfolioUserSharing_GetSharedWithMe","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolio/shared/users/{id}":{"get":{"tags":["PortfolioUserSharing"],"summary":"Gets a list of portfolios shared with a single user","operationId":"PortfolioUserSharing_GetSharedWithUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"put":{"tags":["PortfolioUserSharing"],"summary":"Shares all portfolios of the current user with the given user by Id","operationId":"PortfolioUserSharing_ShareMyPortfolio","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolio/{id}/shared/users":{"get":{"tags":["PortfolioUserSharing"],"summary":"Gets a list of user for a given portfolio","operationId":"PortfolioUserSharing_GetSharedUsersForPortfolio","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolio/{portfolioId}/shared/users/{userId}":{"put":{"tags":["PortfolioUserSharing"],"summary":"Share a single portfolio with another user ( you have to be the creator of the portfolio to be able to share it)","operationId":"PortfolioUserSharing_ShareSinglePortfolio","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"portfolioId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolio/{portfolioId}/shared/users/available":{"get":{"tags":["PortfolioUserSharing"],"operationId":"PortfolioUserSharing_GetAvailableUsersForPortoflioSharing","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"portfolioId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolio/available/shared/user/{userId}":{"get":{"tags":["PortfolioUserSharing"],"operationId":"PortfolioUserSharing_GetAvailablePortfoliosForUserSharing","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/v2":{"get":{"tags":["PortfolioUserSharing"],"operationId":"PortfolioUserSharing_GetPortfoliosForUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"createdByMe","in":"query","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/portfolios/{id}/videos/{videoId}":{"post":{"tags":["PortfolioVideos"],"summary":"Assign a video to a portfolio","operationId":"PortfolioVideos_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier.","required":true,"type":"integer","format":"int64"},{"name":"videoId","in":"path","description":"The video identifier.","required":true,"type":"integer","format":"int64"},{"name":"tags","in":"body","description":"The list of tag identifiers.","required":true,"schema":{"type":"array","items":{"format":"int64","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["PortfolioVideos"],"summary":"Remove a video from a portfolio.","operationId":"PortfolioVideos_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The portfolio identifier.","required":true,"type":"integer","format":"int64"},{"name":"videoId","in":"path","description":"The video identifier.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/post_comments":{"post":{"tags":["PostComment"],"summary":"Create a post comment","operationId":"PostComment_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/PostCommentCreateDTO"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}}}},"/api/lookup/regions":{"get":{"tags":["Region"],"summary":"Get a lookup of regions","operationId":"Region_GetRegions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RegionLookupDTO"}}}}}},"/api/reporting/usageReport":{"get":{"tags":["Reporting"],"operationId":"Reporting_GetUsageReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml","text/plain"],"parameters":[{"name":"organisationId","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/api/reporting":{"post":{"tags":["Reporting"],"operationId":"Reporting_GetAsync","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml","text/plain"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/ReportingPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/api/statistics/totals":{"get":{"tags":["Statistic"],"summary":"Get the statistic totals","operationId":"Statistic_GetTotalStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StatisticTotalGetDTO"}}}}},"/api/statistics":{"post":{"tags":["Statistic"],"summary":"Get the statistics","operationId":"Statistic_GetStatistics","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchCriteria","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/StatisticSearchCriteriaGetDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StatisticGetDTO"}}}}},"/api/videos/{id}/taggedVideos":{"get":{"tags":["TaggedVideo"],"summary":"Get the tagged videos for a video","operationId":"TaggedVideo_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TaggedVideoDTO"}}}}}},"/api/videos/{videoId}/taggedVideos/{taggedVideoId}":{"get":{"tags":["TaggedVideo"],"summary":"Get the tagged video for a video","operationId":"TaggedVideo_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"taggedVideoId","in":"path","description":"The tagged video identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaggedVideoDTO"}}}},"put":{"tags":["TaggedVideo"],"summary":"Update an existing tagged video","operationId":"TaggedVideo_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"taggedVideoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/TaggedVideoPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/taggedVideos":{"post":{"tags":["TaggedVideo"],"summary":"Create a tagged video","operationId":"TaggedVideo_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/TaggedVideoPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/taggedvideo/{taggedVideoId}/notes":{"get":{"tags":["TaggedVideoTagNote"],"summary":"Get a  list of tagged video tag notes","operationId":"TaggedVideoTagNote_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taggedVideoId","in":"path","description":"The tagged video identifier","required":true,"type":"integer","format":"int64"},{"name":"parentNoteId","in":"query","description":"The optional tagged video tag parent note identifier identifier","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TaggedVideoTagNoteGetDTO"}}}}}},"/api/taggedvideo/{taggedVideoId}/tags/{taggedVideoTagId}/notes":{"post":{"tags":["TaggedVideoTagNote"],"summary":"Create a tagged video tag note","operationId":"TaggedVideoTagNote_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taggedVideoId","in":"path","description":"The tagged video identifier","required":true,"type":"integer","format":"int64"},{"name":"taggedVideoTagId","in":"path","description":"The tagged video tag identifier","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/TaggedVideoTagNotePostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/taggedvideo/{taggedVideoId}/tags/{taggedVideoTagId}/notes/{noteId}":{"delete":{"tags":["TaggedVideoTagNote"],"summary":"Delete a note and any of its child notes","operationId":"TaggedVideoTagNote_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taggedVideoId","in":"path","description":"The tagged video identifier","required":true,"type":"integer","format":"int64"},{"name":"taggedVideoTagId","in":"path","description":"The tagged video tag identifier","required":true,"type":"integer","format":"int64"},{"name":"noteId","in":"path","description":"The note identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/v3/tagsets/lookup":{"get":{"tags":["TagSet"],"operationId":"TagSet_GetTagSetsV3","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchTerm","in":"query","required":false,"type":"string"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"orderByField","in":"query","required":false,"type":"string"},{"name":"isPublished","in":"query","required":false,"type":"boolean"},{"name":"visible","in":"query","required":false,"type":"boolean"},{"name":"organisationId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"isDeleted","in":"query","required":false,"type":"boolean"},{"name":"user","in":"query","required":false,"type":"boolean"},{"name":"isAdmin","in":"query","required":false,"type":"boolean"},{"name":"tagging","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/tagsets/{id}":{"get":{"tags":["TagSet"],"summary":"Get a tagset","operationId":"TagSet_GetTagSetById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The tag set identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/tagset":{"get":{"tags":["TagSet"],"summary":"Get a tagset","operationId":"TagSet_GetTagSetByIdCopy","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"The tag set identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["TagSet"],"summary":"Create a tagset","operationId":"TagSet_CreateTagSet","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/TagSetPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/tagsets":{"put":{"tags":["TagSet"],"summary":"Update a tagset","operationId":"TagSet_UpdateTagSetCopy","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/TagSetPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["TagSet"],"summary":"Create a tagset","operationId":"TagSet_CreateTagSetCopy","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/TagSetPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/v2/tag-sets/publish":{"put":{"tags":["TagSet"],"operationId":"TagSet_UpdateTagSetsPublishedStatus","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/TagSetBulkPublishPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/v2/tag-sets/organisation/copy-tagsets":{"put":{"tags":["TagSet"],"operationId":"TagSet_CopyTagSetsToOrganisations","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/TagSetBulkCopyToOrganisationPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/v2/tag-sets/{restore}":{"delete":{"tags":["TagSet"],"operationId":"TagSet_DeleteTagset","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/TagSetBulkDeleteDTO"}},{"name":"restore","in":"path","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/timeline/community/{communityId}":{"get":{"tags":["Timeline"],"operationId":"Timeline_FetchTimelineByCommunityId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/timeline/{id}/posts":{"get":{"tags":["Timeline"],"summary":"Gets all posts for a single timeline","operationId":"Timeline_FetchPosts","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"},{"name":"searchTerm","in":"query","description":"","required":false,"type":"string"},{"name":"pagedList","in":"query","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/timeline/{timelineId}/post/{postId}":{"delete":{"tags":["Timeline"],"summary":"Deletes a post from the timeline","operationId":"Timeline_DeletePostFromTimeline","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"timelineId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"postId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/timeline/{timelineId}/post":{"post":{"tags":["Timeline"],"summary":"Creates a post for a given timeline","operationId":"Timeline_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/PostCreateDTO"}},{"name":"timelineId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/timeline/{timelineId}/popular-videotags":{"get":{"tags":["Timeline"],"operationId":"Timeline_FetchPopularVideoTags","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"timelineId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/user":{"get":{"tags":["User"],"summary":"Get a user by id","operationId":"User_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserGetDTO"}}}},"delete":{"tags":["User"],"summary":"Delete a user","operationId":"User_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users":{"get":{"tags":["User"],"summary":"Get a paged list of users","operationId":"User_GetUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"query","description":"The organisation identifier","required":false,"type":"integer","format":"int32"},{"name":"searchTerm","in":"query","description":"The search term","required":false,"type":"string"},{"name":"roleId","in":"query","description":"The role Id","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"The order by column. Valid values are NAME, EMAIL or CREATESTAMP","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The order by direction. ASC or DESC","required":false,"type":"string"},{"name":"isActive","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[UserForListDTO]"}}}}},"/api/users/{id}/resetadministrativepassword":{"post":{"tags":["User"],"summary":"When allowed by the users organisation, an administrator may set the backup administrative password for a user.","operationId":"User_ResetAdminPassword","consumes":["application/json","text/json","application/xml","text/xml","text/plain"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The user ID","required":true,"type":"integer","format":"int32"},{"name":"newAdministrativePassword","in":"body","description":"The admin password.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/v2/users/{id}":{"put":{"tags":["User"],"operationId":"User_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/UserPutDTOV2"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/{id}":{"put":{"tags":["User"],"summary":"Update a user","operationId":"User_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"User's id","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/UserPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/v2/users/{active}":{"put":{"tags":["User"],"operationId":"User_BulkUserActiveUpdate","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/UserInviteBulkDeleteDTO"}},{"name":"active","in":"path","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/forgottenpassword":{"get":{"tags":["User"],"summary":"Send forgotten password email for user","operationId":"User_ForgottenPassword","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"emailAddress","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/resetpassword":{"put":{"tags":["User"],"summary":"Reset a password","operationId":"User_ResetPassword","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/ResetPasswordDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/{Id}/action=updateRegion":{"put":{"tags":["User"],"summary":"Update the users region","operationId":"User_UpdateRegion","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"Id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/sso":{"get":{"tags":["User"],"summary":"Begin the SAML SSO Sign In Flow.","operationId":"User_PostSsoRedirect","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/get-all":{"get":{"tags":["User"],"operationId":"User_GetAllUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"searchTerm","in":"query","required":false,"type":"string"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"organisationId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"isActive","in":"query","required":false,"type":"boolean"},{"name":"roleId","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/users/communities/{userId}":{"get":{"tags":["User"],"summary":"Gets all user with communities they are members of","operationId":"User_GetAllUsersWithCommunities","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserWithCommunitiesGetDTO"}}}}}},"/api/users/{id}/images/{imageId}":{"get":{"tags":["UserImage"],"summary":"Get the user image.","operationId":"UserImage_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"imageId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/userinvites/guid/{guid}":{"get":{"tags":["UserInvite"],"summary":"Get a user invite by its guid","operationId":"UserInvite_GetUserInvite","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"guid","in":"path","description":"the guid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserInviteGetDTO"}}}}},"/api/userinvites/multiple":{"post":{"tags":["UserInvite"],"summary":"Create multiple user invites","operationId":"UserInvite_PostUserInvites","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/UserInvitesPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/userinvites/{id}/action=resend":{"put":{"tags":["UserInvite"],"summary":"Resend a user invite","operationId":"UserInvite_ResendUserInvite","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The invite id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/userinvites":{"get":{"tags":["UserInvite"],"summary":"Get a paged list of user invites","operationId":"UserInvite_GetUserInvites","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"query","description":"The organisation identifier","required":true,"type":"integer","format":"int32"},{"name":"searchTerm","in":"query","description":"The search term","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"The order by column.  Valid values are EMAIL, NAME, CREATESTAMP and EXPIRYSTAMP","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The order by direction.  Valid values are ASC or DESC","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[UserInviteForListDTO]"}}}},"delete":{"tags":["UserInvite"],"summary":"Delete a user invite","operationId":"UserInvite_Delete","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/UserInviteBulkDeleteDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/video/{videoId}/coowners":{"get":{"tags":["Video"],"operationId":"Video_GetCoOwners","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["Video"],"operationId":"Video_AddCoOwner","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"coOwner","in":"body","required":true,"schema":{"$ref":"#/definitions/NewCoOwnerDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/video/{videoId}/coowners/{userId}":{"delete":{"tags":["Video"],"operationId":"Video_DeleteCoOwner","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int64"},{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/video/{videoId}/takeownership":{"get":{"tags":["Video"],"operationId":"Video_TakeOwnership","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos":{"get":{"tags":["Video"],"summary":"Get a paged list of videos","operationId":"Video_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"pageSize","in":"query","description":"The page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"},{"name":"organisationId","in":"query","description":"Speficic organisation filter for content access query","required":false,"type":"integer","format":"int32"},{"name":"searchType","in":"query","description":"The search type (SingleUser = 1, WatchList = 2, Shared = 3, OrganisationContentAccess = 5)<br />1 = SingleUser, 2 = WatchList, 3 = Shared, 4 = SingleBusinessUnit, 5 = OrganisationContentAccess","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5]},{"name":"orderBy","in":"query","description":"The order by column. Valid values are TITLE or UPLOADEDSTAMP","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The order by direction.  Valid values are ASC or DESC","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[VideoForListDTO]"}}}},"post":{"tags":["Video"],"summary":"Creates a new video with tag details.","operationId":"Video_CreateNewVideoCopy","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model.","required":true,"schema":{"$ref":"#/definitions/VideoPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/video":{"get":{"tags":["Video"],"summary":"Get a video","operationId":"Video_GetVideo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"The video indentifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["Video"],"summary":"Creates a new video with tag details.","operationId":"Video_CreateNewVideo","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model.","required":true,"schema":{"$ref":"#/definitions/VideoPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/notifyuploadcomplete":{"get":{"tags":["Video"],"operationId":"Video_NotifyUploadComplete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/action=settaggedvideopermission":{"put":{"tags":["Video"],"summary":"Set the tagged video permissions","operationId":"Video_SetTaggedVideoPermission","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"permissionId","in":"query","description":"<br />1 = All, 2 = ViewerAndOwner, 3 = Viewer, 4 = Communities","required":true,"type":"integer","format":"int32","enum":[1,2,3,4]}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/action=updatetitle":{"put":{"tags":["Video"],"summary":"Update the title of the video","operationId":"Video_UpdateTitle","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"updateModel","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/VideoPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/action=flagAsInappropriate":{"put":{"tags":["Video"],"summary":"Flag a video as inappropiate","operationId":"Video_PutFlagAsInappropriate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"isFlaggedAsInappropriate","in":"query","description":"","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/thumbnail":{"get":{"tags":["Video"],"summary":"Get a video thumbnail","operationId":"Video_GetThumbnail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"desiredFileSize","in":"query","description":"","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/community/{communityId}/thumbnails":{"get":{"tags":["Video"],"summary":"Gets all the community thumbnails (added sorting as well)","operationId":"Video_GetThumbnails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"uploadedByMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"orderDirection","in":"query","description":"","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/community/{communityId}/videos":{"get":{"tags":["Video"],"summary":"Gets all videos for a given community by communityId","operationId":"Video_GetAllvideosForCommunity","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"communityId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"createdByMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"},{"name":"searchTerm","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/get-all":{"get":{"tags":["Video"],"summary":"Gets a fancy paged list with videos, thumbnails and user pictures","operationId":"Video_GetAllVideos","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"createdByMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"},{"name":"searchTerm","in":"query","description":"","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/v3/get-all":{"get":{"tags":["Video"],"summary":"Gets a fancy paged list with videos, thumbnails and user pictures","operationId":"Video_GetAllVideosV3Async","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"createdByMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","description":"","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","description":"","required":false,"type":"string"},{"name":"searchTerm","in":"query","description":"","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VideoAWSGetListV3DTO"}}}}}},"/api/videos/v4/get-all":{"get":{"tags":["Video"],"operationId":"Video_GetAllVideosV4Async","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"createdByMe","in":"query","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","required":false,"type":"boolean"},{"name":"searchTerm","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VideoSearchResult"}}}}},"/api/videos/get-session-count":{"post":{"tags":["Video"],"summary":"Gets a count of all of the sessions for the given videos.","operationId":"Video_GetSessionCountAsync","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoIds","in":"body","description":"The IDs of the videos to return counts for.","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VideoSessionCount"}}}}}},"/api/videos/get-all/count":{"get":{"tags":["Video"],"summary":"gets the total count for get all videos","operationId":"Video_GetAllVideosCount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/v2/get-all":{"get":{"tags":["Video"],"operationId":"Video_GetAllVideosAdvancedSearch","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"createdByMe","in":"query","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/get-all/author/{authorId}":{"get":{"tags":["Video"],"operationId":"Video_GetAllVideosSharedWithMeAuthoredBy","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"authorId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"createdByMe","in":"query","required":false,"type":"boolean"},{"name":"sharedWithMe","in":"query","required":false,"type":"boolean"},{"name":"orderByDirection","in":"query","required":false,"type":"string"},{"name":"searchTerm","in":"query","required":false,"type":"string"},{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/uploadtoken":{"get":{"tags":["Video"],"summary":"Get a video upload token","operationId":"Video_GetVideoUploadTokenCopy","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"mimeType","in":"query","description":"The mime type","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/video/uploadtoken":{"get":{"tags":["Video"],"summary":"Get a video upload token","operationId":"Video_GetVideoUploadToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"query","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"mimeType","in":"query","description":"The mime type","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/availablereports":{"get":{"tags":["Video"],"summary":"Gets a list of all reports available to run on a video.","operationId":"Video_GetAvailableReports","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/jobs":{"get":{"tags":["Video"],"summary":"Gets a list of all reports available to run on a video.","operationId":"Video_GetInsightJobs","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/jobs/{jobId}":{"get":{"tags":["Video"],"summary":"Gets a list of all reports available to run on a video.","operationId":"Video_GetInsights","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"jobId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/startjob/{reportId}":{"put":{"tags":["Video"],"operationId":"Video_StartJob","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"reportId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/transcript/namedspeaker/{speakerId}":{"delete":{"tags":["Video"],"operationId":"Video_DeleteNamedSpeaker","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"speakerId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/transcript/namespeaker":{"post":{"tags":["Video"],"operationId":"Video_NameSpeaker","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"namedSpeaker","in":"body","required":true,"schema":{"$ref":"#/definitions/NamedSpeaker"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/insights/transcript":{"get":{"tags":["Video"],"summary":"Gets a list of all reports available to run on a video.","operationId":"Video_GetInsightsTranscript","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/downloadtoken":{"get":{"tags":["Video"],"summary":"Get a video download token","operationId":"Video_GetDownloadToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VideoPlaybackDTO"}}}}},"/api/videos/{id}/speakers":{"get":{"tags":["Video"],"summary":"Gets the speakers in the video.","operationId":"Video_GetSpeakers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SpeakerDTO"}}}}},"put":{"tags":["Video"],"summary":"Sets a speaker in the video.","operationId":"Video_SetSpeaker","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video ID","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/SpeakerPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SpeakerDTO"}}}}}},"/api/videos/{id}/speakers/{label}":{"delete":{"tags":["Video"],"operationId":"Video_DeleteSpeaker","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"label","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SpeakerDTO"}}}}}},"/api/videos/{id}/preferences":{"put":{"tags":["Video"],"summary":"Set the video preferences","operationId":"Video_SetPreferences","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/VideoPreferencePutDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VideoPreferenceGetDTO"}}}}},"/api/videos/{id}/transcript":{"get":{"tags":["Video"],"summary":"Gets the latest transcript for the video.","operationId":"Video_GetTranscript","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TranscriptDTO"}}}}},"/api/videos/{id}/words/{transcriptId}":{"get":{"tags":["Video"],"summary":"Gets the words for the video.","operationId":"Video_GetWordStats","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"transcriptId","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/WordCountDTO"}}}}}},"/api/videos/{id}/bothighlights":{"post":{"tags":["Video"],"summary":"Get highlights generated about this video by VEO's suite of AI bots.","operationId":"Video_GetHighlights","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"filter","in":"body","required":true,"schema":{"$ref":"#/definitions/BotHighlightFilterDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BotHighlightDTO"}}}}}},"/api/videos/search":{"post":{"tags":["Video"],"summary":"Search for a video","operationId":"Video_Search","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchCriteria","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/VideoSearchCriteriaDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}":{"get":{"tags":["Video"],"summary":"Get a video","operationId":"Video_GetVideoCopy","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video indentifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["Video"],"summary":"Delete a video","operationId":"Video_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/status":{"get":{"tags":["Video"],"summary":"Get the video status","operationId":"Video_GetVideoStatusByIdCopy","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/video/status":{"get":{"tags":["Video"],"summary":"Get the video status","operationId":"Video_GetVideoStatusById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/stats":{"get":{"tags":["Video"],"summary":"Get the video statistics","operationId":"Video_GetVideoStatsById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VideoStatsGetDTO"}}}}},"/api/videos/{id}/comments":{"get":{"tags":["VideoComment"],"summary":"Get a paged list of video comments","operationId":"VideoComment_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"the video id","required":true,"type":"integer","format":"int64"},{"name":"commentId","in":"query","description":"The parent comment id","required":false,"type":"integer","format":"int64"},{"name":"pageNumber","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticPagedList[VideoCommentGetDTO]"}}}},"post":{"tags":["VideoComment"],"summary":"Create a video comment","operationId":"VideoComment_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/VideoCommentPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/comments/{commentId}":{"get":{"tags":["VideoComment"],"summary":"Get a video comment","operationId":"VideoComment_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"commentId","in":"path","description":"The comment indentifier","required":true,"type":"integer","format":"int64"},{"name":"userId","in":"query","description":"The user identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"put":{"tags":["VideoComment"],"summary":"Update a comment","operationId":"VideoComment_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"commentId","in":"path","description":"The comment indentifier","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/VideoCommentPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["VideoComment"],"summary":"Delete a video comment","operationId":"VideoComment_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"commentId","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/comments/{videoCommentId}/favourites":{"post":{"tags":["VideoCommentFavourites"],"summary":"Favourite a video comment","operationId":"VideoCommentFavourites_Post","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video idenitifier","required":true,"type":"integer","format":"int64"},{"name":"videoCommentId","in":"path","description":"The video comment identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["VideoCommentFavourites"],"summary":"Unfavourite a video comment","operationId":"VideoCommentFavourites_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"videoCommentId","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/communities/action=getAvailable":{"get":{"tags":["VideoCommunity"],"summary":"Get the communities which can be shared with a video","operationId":"VideoCommunity_GetAvailableCommunitiesForVideoSharing","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/communities/action=getIndividual":{"get":{"tags":["VideoCommunity"],"summary":"Get the individual community assoicated with a video","operationId":"VideoCommunity_GetIndividualsCommunityForVideo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/communities/get-all":{"get":{"tags":["VideoCommunity"],"operationId":"VideoCommunity_GetAllCommunitiesForVideo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/communities/{communityId}":{"delete":{"tags":["VideoCommunity"],"operationId":"VideoCommunity_RemoveVideoCommunitySharing","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"communityId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{id}/communities":{"put":{"tags":["VideoCommunity"],"summary":"Add and/or remove video from a list of communities","operationId":"VideoCommunity_PutCommunities","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"model","in":"body","description":"The model","required":true,"schema":{"$ref":"#/definitions/VideoCommunitiesPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/videocontrollers":{"get":{"tags":["VideoController"],"summary":"Get a list of video controllers","operationId":"VideoController_List","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserForAssignmentListDTO"}}}}}},"/api/videos/{videoId}/videocontrollers/{userId}":{"post":{"tags":["VideoController"],"summary":"Assign a controller to a video","operationId":"VideoController_Post","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"userId","in":"path","description":"The controller identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["VideoController"],"summary":"Delete a controller from a video","operationId":"VideoController_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"userId","in":"path","description":"The user identifier","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/{videoId}/documents":{"get":{"tags":["VideoDocument"],"summary":"Get all documents for a video","operationId":"VideoDocument_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VideoDocumentForListDTO"}}}}},"post":{"tags":["VideoDocument"],"summary":"Saves a documents against a video","operationId":"VideoDocument_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video Id","required":true,"type":"integer","format":"int64"},{"name":"postModel","in":"body","description":"The brand model.","required":true,"schema":{"$ref":"#/definitions/VideoDocumentPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","enum":[100,101,200,201,202,203,204,205,206,300,301,302,303,304,305,306,307,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,426,500,501,502,503,504,505],"type":"integer"}}}}},"/api/videos/{videoId}/documents/{id}/uploadtoken":{"get":{"tags":["VideoDocument"],"summary":"Get a video document upload token","operationId":"VideoDocument_GetUploadToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The document identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"format":"int32","enum":[100,101,200,201,202,203,204,205,206,300,301,302,303,304,305,306,307,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,426,500,501,502,503,504,505],"type":"integer"}}}}},"/api/videos/{videoId}/documents/{id}/downloadtoken":{"get":{"tags":["VideoDocument"],"summary":"Get a video document download token","operationId":"VideoDocument_GetDownloadToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"The video identifier","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The document identifier","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"format":"int64","type":"integer"}}}}},"/api/videos/{videoId}/documents/{id}":{"delete":{"tags":["VideoDocument"],"summary":"Delete a video document","operationId":"VideoDocument_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"format":"int32","enum":[100,101,200,201,202,203,204,205,206,300,301,302,303,304,305,306,307,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,426,500,501,502,503,504,505],"type":"integer"}}}}},"/api/videos/{id}/favourites":{"post":{"tags":["VideoFavourites"],"summary":"Favourite a video","operationId":"VideoFavourites_Post","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["VideoFavourites"],"summary":"Unfavourite a video","operationId":"VideoFavourites_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videoinsights/reports":{"get":{"tags":["VideoInsights"],"summary":"Gets a list of all reports.","operationId":"VideoInsights_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Report"}}}}}},"/api/videoinsights/organisation/{organisationId}/reports":{"get":{"tags":["VideoInsights"],"summary":"Gets a list of all reports.","operationId":"VideoInsights_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videoinsights/organisation/{organisationId}/reports/{reportId}":{"put":{"tags":["VideoInsights"],"summary":"Disable a report for an organisation.","operationId":"VideoInsights_EnableReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"reportId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"delete":{"tags":["VideoInsights"],"summary":"Disable a report for an organisation.","operationId":"VideoInsights_DeleteReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"reportId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/lookup/videotaggroups":{"get":{"tags":["VideoTagGroup"],"summary":"Get a list of video tag groups","operationId":"VideoTagGroup_GetVideoTagGroupLookup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"organisationId","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"includeHidden","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VideoTagGroupLookupDTO"}}}}}},"/api/videotaggroups/{id}":{"get":{"tags":["VideoTagGroup"],"summary":"Get a video tag group","operationId":"VideoTagGroup_GetVideoTagGroup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VideoTagGroupDTO"}}}},"put":{"tags":["VideoTagGroup"],"summary":"Update a video tag group","operationId":"VideoTagGroup_Put","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The video tag group identifier","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/VideoTagGroupPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videotaggroups":{"post":{"tags":["VideoTagGroup"],"summary":"Create a video tag group","operationId":"VideoTagGroup_Post","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/VideoTagGroupPostDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/user/{id}":{"get":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_GetAllVideosSharedWithUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/video/{id}":{"get":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_GetAllUsersSharedWithVideo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/user/me":{"get":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_GetAllVideosSharedWithMe","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/user/{userId}/video/{videoId}":{"put":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_ShareVideoWithUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"videoId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/videos":{"put":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_ShareVideosWithUsers","consumes":["application/json","text/json","application/xml","text/xml"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/ShareVideoWithUserPutDTO"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/videos/{videoId}":{"get":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_GetAvailableUsersForVideoSharing","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/videos/usersharing/video/{videoId}/user/{userId}/unshare":{"delete":{"tags":["VideoUserSharing"],"operationId":"VideoUserSharing_UnshareUserFromVideo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"videoId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}}},"definitions":{"LoginMethodRequestDTO":{"type":"object","properties":{"Email":{"description":"The email address to check login methods for","type":"string"}}},"LoginMethodResponseDTO":{"type":"object","properties":{"Methods":{"description":"Available authentication methods for the email domain (e.g. \"password\", \"microsoft\")","type":"array","items":{"type":"string"}},"Scheme":{"description":"The authentication scheme name (e.g. \"default\", \"companyabc\")","type":"string"}}},"BotDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The unique identifier for the bot.","type":"integer"},"Key":{"description":"A unique key for the bot.","type":"string"},"Name":{"description":"The bots name.","type":"string"},"Description":{"description":"A description for the bot.","type":"string"},"DependentOnBotKeys":{"description":"The keys of other bots which this bot is dependent on.","type":"array","items":{"type":"string"}}}},"CommunityPostDTO":{"type":"object","properties":{"Name":{"description":"The name","type":"string"},"OrganisationId":{"format":"int32","description":"The organisation ID. If not supplied your default organisation will be used.","type":"integer"},"Description":{"description":"The description","type":"string"},"TypeId":{"format":"int32","description":"The communit type<br />1 = SingleUser, 2 = Users, 3 = SingleBusinessUnit, 4 = Organisations, 5 = VideoControllers, 6 = Site","maximum":6,"minimum":1,"enum":[1,2,3,4,5,6],"type":"integer"},"SystemGenerated":{"description":"The system generated flag","type":"boolean"},"ObjectIds":{"description":"The list of object identifiers","type":"array","items":{"format":"int32","type":"integer"}},"AdminstratorIds":{"description":"The list of administrator idenitifers","type":"array","items":{"format":"int32","type":"integer"}},"PrivacyLevelId":{"format":"int32","description":"Community privacy levels<br />1 = Internal, 2 = Shared","maximum":2,"minimum":1,"enum":[1,2],"type":"integer"},"VisibilityId":{"format":"int32","description":"Visibility settings<br />1 = PublicPlatform, 2 = PublicOrganisation, 3 = Private","maximum":3,"minimum":1,"enum":[1,2,3],"type":"integer"},"InviteTypeId":{"format":"int32","description":"Invite settings<br />1 = JoinRequest, 2 = OrganisationCommunities","maximum":2,"minimum":1,"enum":[1,2],"type":"integer"},"CommentPostsType":{"description":"Share posts in a Community - where you can include videos / activities / documents","type":"boolean"},"PostingPermissionTypeId":{"format":"int32","description":"Posting permission settings<br />1 = Open, 2 = Closed","maximum":2,"minimum":1,"enum":[1,2],"type":"integer"},"ProfileBackgroundColor":{"type":"string"},"FeatureActivity":{"type":"boolean"},"FeatureFile":{"type":"boolean"},"FeatureTimeline":{"type":"boolean"},"FeatureVideo":{"type":"boolean"},"DefaultLandingPage":{"type":"string"}}},"CommunityGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The community identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Description":{"description":"The description","type":"string"},"TypeId":{"format":"int32","description":"The community type id","type":"integer"},"CreatedByUserId":{"format":"int32","description":"The created by user id","type":"integer"},"SystemGenerated":{"description":"The system generated flag","type":"boolean"},"CreateStamp":{"format":"date-time","description":"The create stamp generated flag","type":"string"},"PrivacyLevelId":{"format":"int32","type":"integer"},"VisibilityId":{"format":"int32","type":"integer"},"CommunityInviteTypeId":{"format":"int32","type":"integer"},"CommentPostsType":{"type":"boolean"},"PostingPermissionTypeId":{"format":"int32","type":"integer"},"CoverImage":{"type":"string"},"CoverImageDataCentreLocation":{"type":"string"},"CoverImageDataCentreProvider":{"type":"string"},"ProfileImage":{"type":"string"},"ProfileImageDataCentreLocation":{"type":"string"},"ProfileImageDataCentreProvider":{"type":"string"},"FeatureTimeline":{"type":"boolean"},"FeatureActivity":{"type":"boolean"},"FeatureVideo":{"type":"boolean"},"FeatureFile":{"type":"boolean"},"ProfileBackgroundColor":{"type":"string"},"DefaultLandingPage":{"type":"string"},"NumberOfUsers":{"format":"int32","description":"The number of users generated flag","type":"integer"},"LastUpdatedStamp":{"format":"date-time","type":"string"},"AdministratorIds":{"type":"array","items":{"format":"int32","type":"integer"}}}},"CommunityPutDTO":{"type":"object","properties":{"Name":{"description":"The community name","type":"string"},"Description":{"description":"The community description","type":"string"},"PrivacyLevelId":{"format":"int32","description":"Community privacy levels<br />1 = Internal, 2 = Shared","maximum":2,"minimum":1,"enum":[1,2],"type":"integer"},"VisibilityId":{"format":"int32","description":"Visibility settings<br />1 = PublicPlatform, 2 = PublicOrganisation, 3 = Private","maximum":3,"minimum":1,"enum":[1,2,3],"type":"integer"},"InviteTypeId":{"format":"int32","description":"Invite settings<br />1 = JoinRequest, 2 = OrganisationCommunities","maximum":2,"minimum":1,"enum":[1,2],"type":"integer"},"CommentPostsType":{"description":"Share posts in a Community - where you can include videos / activities / documents","type":"boolean"},"PostingPermissionTypeId":{"format":"int32","description":"Posting permission settings<br />1 = Open, 2 = Closed","maximum":2,"minimum":1,"enum":[1,2],"type":"integer"},"FeatureTimeline":{"type":"boolean"},"FeatureActivity":{"type":"boolean"},"FeatureVideo":{"type":"boolean"},"FeatureFile":{"type":"boolean"},"ProfileBackgroundColor":{"type":"string"},"DefaultLandingPage":{"type":"string"}}},"CommunityInvitePostDTO":{"type":"object","properties":{"CommunityId":{"format":"int32","type":"integer"},"UserEmail":{"type":"string"}}},"InviteHashPostDTO":{"type":"object","properties":{"Hash":{"type":"string"}}},"StaticPagedList[PostGetDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/PostGetDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"PostGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The region identifier","type":"integer"},"Text":{"description":"The text","type":"string"},"VideoId":{"format":"int32","description":"The video id","type":"integer"},"ActivityId":{"format":"int32","description":"The activity id","type":"integer"},"CreatedByCommunityId":{"format":"int32","description":"The created by community id","type":"integer"},"CreatedByUserId":{"format":"int32","description":"The created by user id","type":"integer"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"UserImageUploadDate":{"format":"date-time","type":"string"},"UserFileName":{"type":"string"},"UserFileType":{"type":"string"},"UserFilePath":{"type":"string"},"UserFileSize":{"format":"int32","type":"integer"},"UserFilePathDataCentreLocation":{"type":"string","readOnly":true},"UserFilePathDataCentreProvider":{"type":"string","readOnly":true}}},"PutCommunityFeaturesDTO":{"type":"object","properties":{"FeatureTimeline":{"type":"boolean"},"FeatureActivity":{"type":"boolean"},"FeatureVideo":{"type":"boolean"},"FeatureFile":{"type":"boolean"}}},"CountryLookupDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"DataCentreDTO":{"type":"object","properties":{"Location":{"type":"string"},"DisplayName":{"type":"string"},"Locality":{"type":"string"},"Zones":{"format":"int32","type":"integer"}}},"UserProfileGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The user indentifier","type":"integer"},"FirstName":{"description":"The first name","type":"string"},"LastName":{"description":"The last name","type":"string"},"Email":{"description":"The email address","type":"string"},"JobTitle":{"description":"The job title","type":"string"},"GenderId":{"format":"int32","description":"The Gender id","type":"integer"},"IsActive":{"type":"boolean"},"TelephoneNumber":{"description":"The telephone number","type":"string"},"AcceptsTermsAndConditions":{"type":"string"},"AcceptsPrivacyPolicy":{"type":"string"},"OrganisationId":{"format":"int32","description":"The Organisation id","type":"integer"},"OrganisationIds":{"type":"array","items":{"format":"int32","type":"integer"}},"ProfilePicture":{"type":"string"},"ProfilePictureDataCentreProvider":{"type":"string"},"ProfilePictureDataCentreLocation":{"type":"string"},"Roles":{"type":"array","items":{"$ref":"#/definitions/RolePairDTO"}},"Preferences":{"$ref":"#/definitions/UserPreferenceGetDTO"},"ViewerOnlyOrganisations":{"type":"array","items":{"format":"int32","type":"integer"}},"CurrentOrganisationIsViewerOnly":{"type":"boolean"}}},"RolePairDTO":{"type":"object","properties":{"OrganisationId":{"format":"int32","type":"integer"},"RoleId":{"format":"int32","type":"integer"}}},"UserPreferenceGetDTO":{"description":"The user preferences settings class.","type":"object","properties":{"SendVideoSharedEmail":{"description":"send an email when the user's video is shared.","type":"boolean"},"SendVideoWatchedEmail":{"description":"send an email when a user's video is watched","type":"boolean"},"SendVideoTaggedEmail":{"description":"Send an email when a user's video is tagged","type":"boolean"},"SendVideoCommentEmail":{"description":"Send an email when a user's video receives a comment","type":"boolean"},"SendDailySummaryEmail":{"description":"send a daily email summarising a user's activity","type":"boolean"},"SendWeeklySummaryEmail":{"description":"/// send a weekly email summarising a user's activity","type":"boolean"}}},"UserProfilePutDTO":{"required":["FirstName","LastName"],"type":"object","properties":{"FirstName":{"description":"The first name","type":"string"},"LastName":{"description":"The last name","type":"string"},"JobTitle":{"description":"The job title","type":"string"},"CurrentPassword":{"description":"The current password","type":"string"},"Password":{"description":"The new password","type":"string"},"GenderId":{"format":"int32","description":"The gender","type":"integer"},"TelephoneNumber":{"description":"The telephone number","type":"string"},"Image":{"description":"The image","type":"string"},"ImageType":{"description":"The image type","type":"string"},"AcceptsTermsAndConditions":{"type":"boolean"},"AcceptsPrivacyPolicy":{"type":"boolean"},"IsActive":{"type":"boolean"},"Preferences":{"$ref":"#/definitions/UserPreferencePutDTO","description":"The user's preferences"}}},"UserPreferencePutDTO":{"description":"The user preferences settings class.","type":"object","properties":{"SendVideoSharedEmail":{"description":"send an email when the user's video is shared.","type":"boolean"},"SendVideoWatchedEmail":{"description":"send an email when a user's video is watched","type":"boolean"},"SendVideoTaggedEmail":{"description":"Send an email when a user's video is tagged","type":"boolean"},"SendVideoCommentEmail":{"description":"Send an email when a user's video receives a comment","type":"boolean"},"SendDailySummaryEmail":{"description":"send a daily email summarising a user's activity","type":"boolean"},"SendWeeklySummaryEmail":{"description":"/// send a weekly email summarising a user's activity","type":"boolean"}}},"VideoForLookupDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The video identifier","type":"integer"},"Title":{"description":"The title","type":"string"}}},"TaggedVideoDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The tagged video identifier","type":"integer"},"VideoId":{"format":"int64","description":"The video identifier","type":"integer"},"VideoTitle":{"description":"The video name","type":"string"},"TagSetId":{"format":"int32","description":"The tag set identifier","type":"integer"},"TagSetName":{"description":"The tag set name","type":"string"},"CreatedByUserId":{"format":"int32","description":"The created by user id","type":"integer"},"CreatedByUserName":{"description":"The created by username","type":"string"},"User":{"$ref":"#/definitions/UserGetForPortfolioSharingDTO"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"VideoLength":{"format":"int64","description":"The video length","type":"integer"},"IsPrivate":{"description":"The is private flag","type":"boolean"},"Hidden":{"type":"boolean"},"Status":{"format":"int32","description":"The tagged video status<br />1 = Autosaved, 2 = Complete","enum":[1,2],"type":"integer"},"Metadata":{"description":"The list of metadata","type":"array","items":{"$ref":"#/definitions/TaggedVideoMetadataDTO"}},"Tags":{"description":"The list of tags","type":"array","items":{"$ref":"#/definitions/TaggedVideoTagDTO"}},"Possessions":{"description":"The list of possessions","type":"array","items":{"$ref":"#/definitions/TaggedVideoPossessionDTO"}},"Engagements":{"description":"The list of engagements","type":"array","items":{"$ref":"#/definitions/TaggedVideoEngagementDTO"}}}},"UserGetForPortfolioSharingDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"ProfilePictureURL":{"type":"string"},"OrganisationId":{"format":"int32","type":"integer"},"OrganisationIds":{"type":"array","items":{"format":"int32","type":"integer"}},"ProfilePictureDataCentreProvider":{"type":"string"},"ProfilePictureDataCentreLocation":{"type":"string"}}},"TaggedVideoMetadataDTO":{"type":"object","properties":{"ControlId":{"format":"int32","description":"The control id","type":"integer"},"ControlValueId":{"format":"int32","description":"The control value id","type":"integer"},"Value":{"description":"The value","type":"string"},"Control":{"$ref":"#/definitions/MetadataControlGetDTO","description":"The control"},"ControlValue":{"$ref":"#/definitions/MetadataControlValueGetDTO","description":"The control value"}}},"TaggedVideoTagDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The tagged video tag identifier","type":"integer"},"TagId":{"format":"int32","description":"The tag id","type":"integer"},"SubTagId":{"format":"int32","description":"The sub tag id","type":"integer"},"Time":{"format":"int32","description":"The time","type":"integer"},"IsBot":{"type":"boolean"},"BotType":{"type":"string"},"BotContent":{"type":"string"},"SubTagTypeId":{"format":"int32","description":"The selection type id","type":"integer"},"SubTagType":{"$ref":"#/definitions/SubTagSelectionTypeDTO"},"SubTagScroller":{"$ref":"#/definitions/SubTagScrollerDTO"},"SubTagCheckList":{"type":"array","items":{"$ref":"#/definitions/SubTagCheckListDTO"}},"Note":{"description":"The parent note","type":"string"},"NoteCount":{"format":"int32","description":"The total number of notes","type":"integer"},"UserId":{"format":"int32","description":"User id","type":"integer"},"Tag":{"$ref":"#/definitions/VideoTagGetDTO","description":"The tag"},"SubTag":{"$ref":"#/definitions/VideoSubTagGetDTO"},"Rating":{"format":"int32","type":"integer"}}},"TaggedVideoPossessionDTO":{"type":"object","properties":{"PossessionId":{"format":"int32","description":"The video possession id","type":"integer"},"Time":{"format":"int32","description":"The time","type":"integer"},"Possession":{"$ref":"#/definitions/PossessionGetDTO","description":"The possession"}}},"TaggedVideoEngagementDTO":{"type":"object","properties":{"Time":{"format":"int32","description":"The time","type":"integer"},"Value":{"format":"int32","description":"The value","type":"integer"}}},"MetadataControlGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The control id","type":"integer"},"LabelText":{"description":"The label text","type":"string"},"ControlTypeId":{"format":"int32","description":"The control type id","type":"integer"},"Required":{"description":"The required flag","type":"boolean"},"Order":{"format":"int32","description":"The order flag","type":"integer"},"IsTitle":{"description":"The is title flag","type":"boolean"},"IsDescription":{"description":"The is description flag","type":"boolean"},"ControlTypeName":{"description":"The control type name","type":"string"},"NumberOfTabletColumns":{"description":"The number of tablet columns","type":"string"},"MetaDataControlValues":{"description":"The list of metadata control values","type":"array","items":{"$ref":"#/definitions/MetadataControlValueGetDTO"}}}},"MetadataControlValueGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The metadata control value identifier","type":"integer"},"Value":{"description":"The value","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"}}},"SubTagSelectionTypeDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"SubTagScrollerDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"ScrollerValue":{"format":"int32","type":"integer"},"MaxValue":{"format":"int32","type":"integer"},"MinValue":{"format":"int32","type":"integer"},"IntervalValue":{"format":"int32","type":"integer"}}},"SubTagCheckListDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"IsChecked":{"type":"boolean"},"TaggedVideoTagId":{"format":"int32","type":"integer"},"SubTagCheckListItem":{"$ref":"#/definitions/SubTagCheckListItem"}}},"VideoTagGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The tag id","type":"integer"},"VideoTagGroupId":{"format":"int32","description":"The video tag group id","type":"integer"},"Name":{"description":"The name","type":"string"},"FontAwesomeIconName":{"description":"The font awesome icon name","type":"string"},"IconRotation":{"format":"int32","description":"The icon rotation","type":"integer"},"Colour":{"description":"The colour","type":"string"},"PositionId":{"format":"int32","description":"The position id","type":"integer"},"Order":{"format":"int32","description":"The order","type":"integer"},"SubTags":{"description":"The list of sub tags","type":"array","items":{"$ref":"#/definitions/VideoSubTagGetDTO"}}}},"VideoSubTagGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The sub tag identifier","type":"integer"},"VideoTagId":{"format":"int32","description":"The video tag identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"},"FontAwesomeIconName1":{"type":"string"},"FontAwesomeIconName2":{"type":"string"},"FontAwesomeIconName3":{"type":"string"}}},"PossessionGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The possession identifier","type":"integer"},"VideoTagGroupId":{"format":"int32","description":"The video tag group identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Colour":{"description":"The colour","type":"string"},"SelectedColour":{"description":"The selected colour","type":"string"},"FontAwesomeIconName":{"description":"The font awesome icon name","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"}}},"SubTagCheckListItem":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"StaticPagedList[CommunityForListDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/CommunityForListDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"CommunityForListDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The community identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"CoverPhoto":{"type":"string"},"ProfilePhoto":{"type":"string"},"ProfilePhotoStorageLocation":{"type":"string"},"ProfileBackgroundColor":{"type":"string"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"MemberCount":{"format":"int32","description":"The member count","type":"integer"},"VideoCount":{"format":"int32","description":"The video count","type":"integer"},"AdministratorIds":{"type":"array","items":{"format":"int32","type":"integer"}},"CoverPhotoDataCentreLocation":{"type":"string"},"CoverPhotoDataCentreProvider":{"type":"string"},"ProfilePhotoDataCentreLocation":{"type":"string"},"ProfilePhotoDataCentreProvider":{"type":"string"}}},"UserProfileStatsGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The user identifier","type":"integer"},"FirstName":{"description":"The first name","type":"string"},"LastName":{"description":"The lastname","type":"string"},"VideoCount":{"format":"int32","description":"The video count","type":"integer"},"CommunityCount":{"format":"int32","description":"The community count","type":"integer"},"UnreadNotificationCount":{"format":"int32","description":"The unread notification count","type":"integer"},"OrganisationRegionCode":{"description":"The organisation region code","type":"string"}}},"OrganisationSimpleGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The organisation identifier","type":"integer"},"Name":{"description":"The name","type":"string"}}},"MetadataLookupDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The metadata identifer","type":"integer"},"Name":{"description":"The metadata name","type":"string"}}},"MetadataGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The metadata indentifier","type":"integer"},"TypeId":{"format":"int32","description":"The type id<br />1 = Prerecord, 2 = Postrecord","enum":[1,2],"type":"integer"},"Name":{"description":"The name","type":"string"},"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"},"HasBeenPublished":{"description":"The has been published flag","type":"boolean"},"MetadataControls":{"description":"A collection of metadata controles","type":"array","items":{"$ref":"#/definitions/MetadataControlGetDTO"}}}},"MetadataPostDTO":{"required":["Name"],"type":"object","properties":{"MetadataControls":{"description":"A collection of metadata controls","type":"array","items":{"$ref":"#/definitions/MetadataControlPostDTO"}},"TypeId":{"format":"int32","description":"The metadata type<br />1 = Prerecord, 2 = Postrecord","enum":[1,2],"type":"integer"},"Name":{"description":"The metadata name","type":"string"},"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"}}},"MetadataControlPostDTO":{"required":["LabelText"],"type":"object","properties":{"MetaDataControlValues":{"description":"A collection of metadata control values","type":"array","items":{"$ref":"#/definitions/MetadataControlValueDTO"}},"MetadataId":{"format":"int32","description":"The metadata id","type":"integer"},"LabelText":{"description":"The label text","type":"string"},"ControlTypeId":{"format":"int32","description":"The control type<br />1 = HalfWidthTextbox, 2 = FullWidthTextbox, 3 = DateTimePicker, 4 = Dropdown, 5 = OptionList, 6 = MultilineTextBox, 7 = TimePicker","enum":[1,2,3,4,5,6,7],"type":"integer"},"Required":{"description":"The required flag","type":"boolean"},"Order":{"format":"int32","description":"The order id","type":"integer"},"IsTitle":{"description":"The is title flag","type":"boolean"},"IsDescription":{"description":"The is description flag","type":"boolean"}}},"MetadataControlValueDTO":{"required":["Value"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"MetadataControlId":{"format":"int32","description":"The metadata control id","type":"integer"},"Value":{"description":"The value","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"}}},"MetadataPutDTO":{"required":["Name"],"type":"object","properties":{"Id":{"format":"int32","description":"The identifier","type":"integer"},"MetadataControls":{"description":"A collection of metadata controls","type":"array","items":{"$ref":"#/definitions/MetadataControlPutDTO"}},"TypeId":{"format":"int32","description":"The metadata type<br />1 = Prerecord, 2 = Postrecord","enum":[1,2],"type":"integer"},"Name":{"description":"The metadata name","type":"string"},"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"}}},"MetadataControlPutDTO":{"required":["LabelText"],"type":"object","properties":{"Id":{"format":"int32","description":"The metadata control id","type":"integer"},"MetaDataControlValues":{"description":"A collection of metadata control values","type":"array","items":{"$ref":"#/definitions/MetadataControlValuePutDTO"}},"MetadataId":{"format":"int32","description":"The metadata id","type":"integer"},"LabelText":{"description":"The label text","type":"string"},"ControlTypeId":{"format":"int32","description":"The control type<br />1 = HalfWidthTextbox, 2 = FullWidthTextbox, 3 = DateTimePicker, 4 = Dropdown, 5 = OptionList, 6 = MultilineTextBox, 7 = TimePicker","enum":[1,2,3,4,5,6,7],"type":"integer"},"Required":{"description":"The required flag","type":"boolean"},"Order":{"format":"int32","description":"The order id","type":"integer"},"IsTitle":{"description":"The is title flag","type":"boolean"},"IsDescription":{"description":"The is description flag","type":"boolean"}}},"MetadataControlValuePutDTO":{"required":["Value"],"type":"object","properties":{"Id":{"format":"int32","description":"The metadata control value identifier","type":"integer"},"MetadataControlId":{"format":"int32","description":"The metadata control id","type":"integer"},"Value":{"description":"The value","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"}}},"StaticPagedList[NotificationForListDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/NotificationForListDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"NotificationForListDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The notification indentifier","type":"integer"},"Message":{"description":"The message","type":"string"},"SenderId":{"format":"int32","description":"The sender Id","type":"integer"},"SenderFirstName":{"description":"The sender image id","type":"string"},"SenderLastName":{"type":"string"},"SenderName":{"description":"The sender name","type":"string"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"Read":{"description":"The read flag","type":"boolean"},"SystemGenerated":{"description":"The system generated flag","type":"boolean"},"NotificationTypeId":{"format":"int32","description":"The notification type id<br />1 = Video, 2 = Organisation, 3 = BusinessUnit, 4 = Community, 5 = VideoShare, 6 = BusinessUnitSharingInvite, 7 = VideoComment, 8 = BusinessUnitSharing, 9 = OrganisationSharing, 10 = VideoStreamInvite, 11 = PortfolioShare, 12 = ActivityComment","enum":[1,2,3,4,5,6,7,8,9,10,11,12],"type":"integer"},"ObjectId":{"format":"int64","description":"The object id","type":"integer"},"SubObjectId":{"format":"int32","description":"The sub object id","type":"integer"},"UserId":{"format":"int32","type":"integer"},"UserName":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"ProfilePictureURL":{"type":"string"},"ProfilePictureDataCentreProvider":{"type":"string"},"ProfilePictureDataCentreLocation":{"type":"string"}}},"StaticPagedList[OrganisationForListDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/OrganisationForListDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"OrganisationForListDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The organisation identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"RenewalDate":{"format":"date-time","description":"The renewal date for the organisation.","type":"string"}}},"OrganisationGetDTO":{"required":["Name","Line1","Town","Postcode"],"type":"object","properties":{"Id":{"format":"int32","description":"The organisation identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Bots":{"type":"array","items":{"format":"int32","type":"integer"}},"RenewalDate":{"format":"date-time","description":"The renewal date for the organisation.","type":"string"},"AadAccountAutoProvisionTlds":{"description":"The TLDs which are auto provisioned when logging in via AAD.","type":"array","items":{"type":"string"}},"Reference":{"description":"The reference","type":"string"},"SectorId":{"format":"int32","description":"The sector id","type":"integer"},"AddressId":{"format":"int32","description":"The address id","type":"integer"},"Line1":{"description":"The address line 1","type":"string"},"Line2":{"description":"The address line 2","type":"string"},"Town":{"description":"The town","type":"string"},"County":{"description":"The county","type":"string"},"CountryId":{"format":"int32","description":"The country id","type":"integer"},"Postcode":{"description":"The post code","type":"string"},"TelephoneNumber":{"description":"The telephone number","type":"string"},"EmailAddress":{"description":"The email address","type":"string"},"UserLimit":{"format":"int32","description":"The user limit","type":"integer"},"AllowUpload":{"description":"The allow upload flag","type":"boolean"},"IsActive":{"description":"The is active flag","type":"boolean"},"BrandingId":{"format":"int32","description":"The branding id","type":"integer"},"TypeId":{"format":"int32","description":"The organisation type<br />1 = Open, 2 = Closed","enum":[1,2],"type":"integer"},"RequiresBusinessUnitApprovalForSharing":{"description":"The requires business unit approval for sharing flag","type":"boolean"},"CrossOrganisationSharingTypeId":{"format":"int32","description":"The cross organisation sharing type id","type":"integer"},"AllowCrossOrganisationSharing":{"description":"The allow cross organisation sharing flag","type":"boolean"},"CanSetAdministrativePasswords":{"type":"boolean"},"Type":{"description":"The organisaton type","type":"string"},"BypassTermsAndConditions":{"description":"The bypass terms and conditions flag","type":"boolean"},"BypassPrivacy":{"description":"The bypass privacy flag","type":"boolean"},"DefaultRegionId":{"format":"int32","description":"The default region id","type":"integer"},"LiveStreamIntegrated":{"description":"The live stream integrated flag","type":"boolean"},"LiveStreamMaxDuration":{"format":"int32","description":"The live stream max duration in minutes","type":"integer"},"WowzaApplicationName":{"description":"The wowza application name","type":"string"},"EnablePassThroughAuthentication":{"description":"The enable passthrough authentication flag","type":"boolean"},"HideHeaderMenuForUsers":{"description":"The hide menu headers flag","type":"boolean"},"EnableAddAllVideoTagsForPortfolio":{"description":"Gets or sets a value indicating whether [enable add all video tags for portfolio].","type":"boolean"},"HideUserProfile":{"description":"The hide user profile flag","type":"boolean"},"HasVeoBrand":{"description":"The has veo brand flag","type":"boolean"},"EnableIPWhiteList":{"description":"The enable ip whitelist flag","type":"boolean"},"IPWhiteList":{"description":"The ip whitelist","type":"string"},"EnableDocumentUpload":{"description":"The enable document upload flag","type":"boolean"},"DocumentSingularDescription":{"description":"The document singular description","type":"string"},"DocumentPluralDescription":{"description":"The document singular description","type":"string"},"EnableTaggedVideoAutoSave":{"description":"The enable tagged video auto save flag","type":"boolean"},"EnableVideoUploadAutoShare":{"description":"The enable video upload auto share flag","type":"boolean"},"AiEnabled":{"description":"Defines if the Ai is enabled for calling the microservice for video upload","type":"boolean"},"OrganisationSharingId":{"format":"int32","description":"Organisation sharing id","type":"integer"},"OrganisationSharingType":{"description":"Organisation sharing type","type":"string"},"IsMultiSite":{"type":"boolean"},"PreferredRegionLocation":{"type":"string"}}},"OrganisationImageDTO":{"type":"object","properties":{"ImageAsBase64":{"type":"string"},"MimeType":{"type":"string"}}},"OrganisationPutV2DTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The idenitifier","type":"integer"},"Bots":{"description":"The bots which are enabled for the organisation.","type":"array","items":{"format":"int32","type":"integer"}},"AadAccountAutoProvisionTlds":{"description":"The TLDs which are auto provisioned through AAD.","type":"array","items":{"type":"string"}},"Name":{"description":"The name","type":"string"},"Reference":{"description":"The reference","type":"string"},"AddressId":{"format":"int32","description":"The address id","type":"integer"},"RenewalDate":{"format":"date-time","description":"The renewal date for the organisation.","type":"string"},"Line1":{"description":"The address line 1","type":"string"},"Line2":{"description":"The address line 2","type":"string"},"Town":{"description":"The town","type":"string"},"County":{"description":"The county","type":"string"},"CountryId":{"format":"int32","description":"The country id","type":"integer"},"Postcode":{"description":"The post code","type":"string"},"DefaultRegionId":{"format":"int32","description":"The default region id","type":"integer"},"TelephoneNumber":{"description":"The telephone number","type":"string"},"EmailAddress":{"description":"The email address","type":"string"},"UserLimit":{"format":"int32","description":"The user limit","type":"integer"},"AllowUpload":{"description":"The allow upload flag","type":"boolean"},"IsActive":{"description":"The is active flag","type":"boolean"},"BrandingId":{"format":"int32","description":"The branding id","type":"integer"},"TypeId":{"format":"int32","description":"The type id","type":"integer"},"SectorId":{"format":"int32","description":"The sector id","type":"integer"},"AllowCrossOrganisationSharing":{"description":"The allow cross organisation sharing flag","type":"boolean"},"Image":{"description":"The image path","type":"string"},"ImageType":{"description":"The image type","type":"string"},"ZohoAccountId":{"format":"int64","description":"The zoho account id","type":"integer"},"BypassTermsAndConditions":{"description":"The bypass terms and conditions flag","type":"boolean"},"BypassPrivacy":{"description":"The bypass privacy flag","type":"boolean"},"LiveStreamIntegrated":{"description":"The live stream integrated flag","type":"boolean"},"LiveStreamMaxDuration":{"format":"int32","description":"The live stream max duration in minutes","type":"integer"},"WowzaApplicationName":{"description":"The wowza application name","type":"string"},"EnablePassThroughAuthentication":{"description":"The enable passthrough authentication flag","type":"boolean"},"HideHeaderMenuForUsers":{"description":"The hide menu headers flag","type":"boolean"},"EnableAddAllVideoTagsForPortfolio":{"description":"Gets or sets a value indicating whether [enable add all video tags for portfolio].","type":"boolean"},"HideUserProfile":{"description":"The hide user profile flag","type":"boolean"},"EnableIPWhiteList":{"description":"The enable live stream ip white list flag","type":"boolean"},"IPWhiteList":{"description":"The enable live stream ip white list list. \r\nRequired format is a comma delimited list of single IP addresses","type":"string"},"EnableDocumentUpload":{"description":"The enable document upload flag","type":"boolean"},"DocumentSingularDescription":{"description":"The document singular description","type":"string"},"DocumentPluralDescription":{"description":"The document singular description","type":"string"},"EnableTaggedVideoAutoSave":{"description":"The enable tagged video auto save flag","type":"boolean"},"EnableVideoUploadAutoShare":{"description":"The enable video upload auto share flag","type":"boolean"},"IsMultiSite":{"type":"boolean"},"PreferredRegionLocation":{"type":"string"},"CanSetAdministrativePasswords":{"description":"Allows an organisation to set an administrative password on the account during create user.","type":"boolean"}}},"OrganisationTagSetListWithAuthorDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IsOrganisationWide":{"type":"boolean"},"Visibility":{"type":"string"},"Status":{"type":"string"},"CreateStamp":{"format":"date-time","type":"string"},"AuthorFirstName":{"type":"string"},"AuthorLastName":{"type":"string"},"AuthorEmail":{"type":"string"},"AuthorProfilePic":{"type":"string"}}},"PortfolioGetDTO":{"required":["Title"],"type":"object","properties":{"Id":{"format":"int64","description":"The identifier","type":"integer"},"Title":{"description":"The title","type":"string"},"Description":{"description":"The description","type":"string"},"Module":{"description":"The module","type":"string"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"UpdateStamp":{"format":"date-time","description":"The update stamp","type":"string"},"UserName":{"description":"The user name","type":"string"},"UserId":{"format":"int32","description":"The user id","type":"integer"}}},"PortfolioPutDTO":{"required":["Title"],"type":"object","properties":{"Title":{"description":"The title","type":"string"},"Description":{"description":"The description","type":"string"},"Module":{"description":"The module","type":"string"}}},"PortfolioTagsetsGetDTO":{"type":"object","properties":{"Tagsets":{"description":"The list of tag sets","type":"array","items":{"$ref":"#/definitions/PortfolioTagsetGetDTO"}}}},"PortfolioTagsetGetDTO":{"type":"object","properties":{"TagSetId":{"format":"int32","description":"The tag set id","type":"integer"},"TagSetName":{"description":"The tag set name","type":"string"},"Tags":{"description":"A list of tags","type":"array","items":{"$ref":"#/definitions/PortfolioTagGetDTO"}}}},"PortfolioTagGetDTO":{"type":"object","properties":{"TagId":{"format":"int32","description":"The tag id","type":"integer"},"TagName":{"description":"The tag name","type":"string"},"SubTags":{"description":"A list of sub tags","type":"array","items":{"$ref":"#/definitions/PortfolioSubTagGetDTO"}}}},"PortfolioSubTagGetDTO":{"type":"object","properties":{"SubTagId":{"format":"int32","description":"The sub tag id","type":"integer"},"SubTagName":{"description":"The sub tag name","type":"string"}}},"StaticPagedList[PortfolioGetDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/PortfolioGetDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"PortfolioCommentGetDTO":{"required":["Message"],"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Message":{"type":"string"},"CreateStamp":{"format":"date-time","type":"string"},"PortfolioId":{"format":"int64","type":"integer"},"UserId":{"format":"int32","type":"integer"},"UserName":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"ProfilePictureURL":{"type":"string"},"ProfilePictureDataCentreProvider":{"type":"string"},"ProfilePictureDataCentreLocation":{"type":"string"},"ParentCommentId":{"format":"int64","type":"integer"},"ChildComments":{"$ref":"#/definitions/StaticPagedList[PortfolioCommentGetDTO]"}}},"StaticPagedList[PortfolioCommentGetDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/PortfolioCommentGetDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"PortfolioPostDTO":{"required":["Title"],"type":"object","properties":{"OrganisationId":{"format":"int32","description":"The organisation that this portfolio belongs to. If not supplied then this will be your default org.","type":"integer"},"Title":{"description":"The title","type":"string"},"Description":{"description":"The description","type":"string"},"Module":{"description":"The module","type":"string"},"IsDeleted":{"description":"The is deleted flag","type":"boolean"},"DeleteStamp":{"format":"date-time","description":"The delete stamp","type":"string"},"DeletedByUser":{"description":"The deleted by user","type":"string"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"UpdateStamp":{"format":"date-time","description":"The update stamp","type":"string"},"User_Id":{"description":"The user id","type":"string"}}},"PortfolioCommentPostDTO":{"required":["Message"],"type":"object","properties":{"Message":{"type":"string"},"ParentCommentId":{"format":"int64","type":"integer"}}},"PortfolioDocumentForListDTO":{"type":"object","properties":{"PortfolioId":{"format":"int64","description":"Get or sets the portfolio id","type":"integer"},"DocumentId":{"format":"int64","description":"Gets or sets the document id","type":"integer"},"Name":{"description":"Gets or sets the name","type":"string"},"UploadedStamp":{"format":"date-time","description":"Gets or sets the uploaded stamp","type":"string"},"UserId":{"format":"int32","description":"Gets or sets the user id","type":"integer"},"UserName":{"description":"Get or set the users name","type":"string"},"StatusId":{"format":"int32","description":"Gets or set the status of the document","type":"integer"},"CanDelete":{"description":"Gets or sets if the document can be deleted by the current user","type":"boolean"},"ThumbnailUrl":{"description":"Gets suggested thumbnail url","type":"string"}}},"PostCommentCreateDTO":{"type":"object","properties":{"Message":{"description":"The message","type":"string"},"PostId":{"format":"int32","description":"The post id","type":"integer"}}},"RegionLookupDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The region identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"LanguageCode":{"description":"The language code","type":"string"},"CountryCode":{"description":"The country code","type":"string"}}},"ReportingPostDTO":{"type":"object","properties":{"BotHighlightReportCriteria":{"$ref":"#/definitions/BotHighlightReportCriteria","description":"The bot highlight report criteria"},"TagSessionReportCriteria":{"$ref":"#/definitions/TagSessionReportCriteria","description":"The tag session report criteria"}}},"BotHighlightReportCriteria":{"type":"object","properties":{"BotId":{"format":"int32","description":"The bot id","type":"integer"},"ComparisonGroups":{"description":"A list of comparisons groups which contain a list of video id's to compare in each group","type":"array","items":{"$ref":"#/definitions/BotComparisonGroups"}}}},"TagSessionReportCriteria":{"type":"object","properties":{"ComparisonGroups":{"description":"A list of comparisons groups which contain a list of tag sessions id's to compare in each group","type":"array","items":{"$ref":"#/definitions/TagSessionComparisonGroups"}}}},"BotComparisonGroups":{"description":"A list of videos with a comparison group","type":"object","properties":{"VideoIds":{"type":"array","items":{"format":"int64","type":"integer"}}}},"TagSessionComparisonGroups":{"description":"A list of videos with a comparison group","type":"object","properties":{"TagSessions":{"type":"array","items":{"$ref":"#/definitions/TagSessionCriteria"}}}},"TagSessionCriteria":{"description":"The tag session critieria","type":"object","properties":{"Id":{"format":"int32","description":"The tag session id","type":"integer"},"VideoId":{"format":"int64","description":"The video id","type":"integer"}}},"StatisticTotalGetDTO":{"type":"object","properties":{"OrganisationCount":{"format":"int32","description":"The organisation count","type":"integer"},"UserCount":{"format":"int32","description":"The user count","type":"integer"},"VideoUploadCount":{"format":"int32","description":"The video upload count","type":"integer"},"VideoPlaybackCount":{"format":"int32","description":"The video playback count","type":"integer"}}},"StatisticSearchCriteriaGetDTO":{"type":"object","properties":{"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"},"StartDate":{"format":"date-time","description":"The start date","type":"string"},"EndDate":{"format":"date-time","description":"The end date","type":"string"}}},"StatisticGetDTO":{"type":"object","properties":{"OrganisationCount":{"format":"int32","description":"Total number of organisations","type":"integer"},"OrganisationActiveCount":{"format":"int32","type":"integer"},"UserCount":{"format":"int32","description":"Total number of users","type":"integer"},"UserDeletedCount":{"format":"int32","description":"Total number of deleted users","type":"integer"},"UserActiveCount":{"format":"int32","description":"Total number of active users","type":"integer"},"CommunityCount":{"format":"int32","description":"Total number of communities","type":"integer"},"CommunityDeletedCount":{"format":"int32","description":"Total number of deleted communities","type":"integer"},"CommunityActiveCount":{"format":"int32","description":"Total number of active communites","type":"integer"},"CourseCount":{"format":"int32","description":"Total number of courses","type":"integer"},"CourseCreatedCount":{"format":"int32","description":"Total number of created courses","type":"integer"},"CourseTimeAccessedCount":{"format":"int64","description":"Total accessed time for courses","type":"integer"},"CoursesSubmittedForReviewCount":{"format":"int32","description":"Total number of courses submitted for review","type":"integer"},"TagsCount":{"format":"int32","description":"Total number of tags and comments","type":"integer"},"CommentCount":{"format":"int32","description":"Total number of comments","type":"integer"},"VideoUploadTotalCountWithDeleted":{"format":"int32","description":"Total number of videos uploaded","type":"integer"},"VideoViewsCount":{"format":"int32","type":"integer"},"VideoStoredFileSizeCountWithDeleted":{"format":"int64","description":"Total file size of uploaded videos","type":"integer"},"VideoStoredTimeCountWithDeleted":{"format":"int64","description":"Total duration of uploaded videos","type":"integer"},"VideoDownloadTotalSizeCount":{"format":"int64","description":"The total download","type":"integer"},"VideoViewsLength":{"format":"int64","type":"integer"},"UserPendingInvitesCount":{"format":"int32","type":"integer"},"UserAcceptedInviteCount":{"format":"int32","type":"integer"},"VideoUploadTotalCountWithoutDeleted":{"format":"int32","type":"integer"},"VideoStoredFileSizeCountWithoutDeleted":{"format":"int64","type":"integer"},"VideoStoredTimeCountWithoutDeleted":{"format":"int64","type":"integer"},"TaggedVideoForOrganisationCount":{"format":"int32","type":"integer"},"TagsWithCommentsCount":{"format":"int32","type":"integer"}}},"TaggedVideoPostDTO":{"type":"object","properties":{"VideoId":{"format":"int64","description":"The video identifier","type":"integer"},"TagSetId":{"format":"int32","description":"The tagset identifier","type":"integer"},"IsPrivate":{"description":"The is private flag","type":"boolean"},"Status":{"format":"int32","description":"The tagged video status<br />1 = Autosaved, 2 = Complete","enum":[1,2],"type":"integer"},"Metadata":{"description":"The metadata list","type":"array","items":{"$ref":"#/definitions/TaggedVideoMetadataDTO"}},"Tags":{"description":"The tags list","type":"array","items":{"$ref":"#/definitions/TaggedVideoTagDTO"}},"Possessions":{"description":"The possessions list","type":"array","items":{"$ref":"#/definitions/TaggedVideoPossessionPostDTO"}},"Engagements":{"description":"The engagements list","type":"array","items":{"$ref":"#/definitions/TaggedVideoEngagementDTO"}}}},"TaggedVideoPossessionPostDTO":{"type":"object","properties":{"PossessionId":{"format":"int32","description":"The video possession id","type":"integer"},"Time":{"format":"int32","description":"The time","type":"integer"}}},"TaggedVideoTagNoteGetDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The tagged video tag note indentifier","type":"integer"},"UserId":{"format":"int64","description":"The user id","type":"integer"},"Note":{"description":"The message","type":"string"},"UserName":{"description":"The username","type":"string"},"UserProfilePicture":{"$ref":"#/definitions/UserGetForPortfolioSharingDTO","description":"The user image id"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"TagId":{"format":"int32","description":"The tag id","type":"integer"},"SubTagId":{"format":"int32","description":"The sub tag id","type":"integer"},"Time":{"format":"int32","description":"The time","type":"integer"},"TagName":{"description":"The tag name","type":"string"},"TaggedVideoTagId":{"format":"int32","description":"The tagged video tag id","type":"integer"},"ParentNoteId":{"format":"int64","description":"The parent note id","type":"integer"},"ChildNotes":{"description":"A paged list of child notes","type":"array","items":{"$ref":"#/definitions/TaggedVideoTagNoteGetDTO"}}}},"TaggedVideoTagNotePostDTO":{"required":["Note"],"type":"object","properties":{"ParentNoteId":{"format":"int32","description":"The parent note id","type":"integer"},"Note":{"description":"The note","type":"string"}}},"TagSetPostDTO":{"required":["Name","Description"],"type":"object","properties":{"Id":{"format":"int32","description":"The identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Description":{"description":"The description","type":"string"},"Published":{"description":"The published flag","type":"boolean"},"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"},"PublicallyAvailable":{"description":"The publically available","type":"boolean"},"PreRecordMetadataId":{"format":"int32","description":"The pre-record metadata id","type":"integer"},"VideoTagGroupId":{"format":"int32","description":"The video tag group id","type":"integer"},"PostRecordMetadataId":{"format":"int32","description":"The post record metadata id","type":"integer"}}},"TagSetBulkPublishPutDTO":{"type":"object","properties":{"Published":{"type":"boolean"},"Ids":{"type":"array","items":{"format":"int32","type":"integer"}}}},"TagSetBulkCopyToOrganisationPutDTO":{"type":"object","properties":{"OrganisationsIds":{"type":"array","items":{"format":"int32","type":"integer"}},"TagSetsIds":{"type":"array","items":{"format":"int32","type":"integer"}}}},"TagSetBulkDeleteDTO":{"type":"object","properties":{"Ids":{"type":"array","items":{"format":"int32","type":"integer"}}}},"PostCreateDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The region identifier","type":"integer"},"Text":{"description":"The text","type":"string"},"VideoId":{"format":"int32","description":"The video id","type":"integer"},"ActivityId":{"format":"int32","description":"The activity id","type":"integer"},"CreatedByCommunityId":{"format":"int32","description":"The created by community id","type":"integer"}}},"UserGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The user indentifier","type":"integer"},"FirstName":{"description":"The first name","type":"string"},"LastName":{"description":"The last name","type":"string"},"Email":{"description":"The email","type":"string"},"JobTitle":{"description":"The job title","type":"string"},"GenderId":{"format":"int32","description":"The gender id","type":"integer"},"TelephoneNumber":{"description":"The telephone number","type":"string"},"Image":{"description":"The image","type":"string"},"ImageType":{"description":"The image type","type":"string"},"IsActive":{"description":"The is active flag","type":"boolean"},"IsCrossOrganisationPassthroughEnabled":{"description":"The Is CrossOrganisation Passthrough Enabled flag","type":"boolean"},"DefaultOrganisationId":{"format":"int32","description":"The organisation identifier","type":"integer"},"DefaultOrganisationName":{"description":"The organisation name","type":"string"},"OrganisationIds":{"type":"array","items":{"format":"int32","type":"integer"}},"OrganisationNames":{"type":"string"},"RegionId":{"format":"int32","description":"The region id","type":"integer"},"UserPicture":{"$ref":"#/definitions/UserPicture"},"Roles":{"description":"The roles","type":"array","items":{"$ref":"#/definitions/RolePairDTO"}},"OrgIsMultiSite":{"type":"boolean"},"Preferences":{"$ref":"#/definitions/UserPreferenceGetDTO","description":"The user's preferences"},"ViewerOnlyOrganisations":{"type":"array","items":{"format":"int32","type":"integer"}}}},"UserPicture":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"UploadDate":{"format":"date-time","type":"string"},"FileName":{"type":"string"},"FileType":{"type":"string"},"FilePath":{"type":"string"},"FileKey":{"type":"string"},"FileSize":{"format":"int32","type":"integer"},"DataCentreProvider":{"type":"string"},"DataCentreLocation":{"type":"string"}}},"StaticPagedList[UserForListDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/UserForListDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"UserForListDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The unique indentifier","type":"integer"},"FirstName":{"description":"The first name","type":"string"},"LastName":{"description":"The last name","type":"string"},"Email":{"description":"The email","type":"string"},"DefaultOrganisationName":{"description":"The organisation name","type":"string"},"Roles":{"description":"The list of role ids per organisation.","type":"array","items":{"$ref":"#/definitions/RolePairDTO"}},"IsSuperUser":{"description":"Whether the user is a super user across VEO.","type":"boolean"}}},"UserPutDTOV2":{"required":["FirstName","LastName","Email","Roles"],"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"JobTitle":{"type":"string"},"Password":{"type":"string"},"GenderId":{"format":"int32","type":"integer"},"TelephoneNumber":{"type":"string"},"Image":{"type":"string"},"ImageType":{"type":"string"},"IsActive":{"type":"boolean"},"IsDeleted":{"type":"boolean"},"IsCrossOrganisationPassthroughEnabled":{"type":"boolean"},"Roles":{"type":"array","items":{"$ref":"#/definitions/UserOrganisationRolesDTO"}},"Preferences":{"$ref":"#/definitions/UserPreferencePutDTO","description":"The user's preferences"}}},"UserOrganisationRolesDTO":{"required":["Roles"],"type":"object","properties":{"OrganisationId":{"format":"int32","type":"integer"},"Roles":{"type":"array","items":{"format":"int32","type":"integer"}},"IsViewerOnly":{"type":"boolean"}}},"UserPutDTO":{"required":["FirstName","LastName","Email","Roles"],"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"JobTitle":{"type":"string"},"Password":{"type":"string"},"GenderId":{"format":"int32","type":"integer"},"TelephoneNumber":{"type":"string"},"Image":{"type":"string"},"ImageType":{"type":"string"},"IsActive":{"type":"boolean"},"IsDeleted":{"type":"boolean"},"IsCrossOrganisationPassthroughEnabled":{"type":"boolean"},"Roles":{"type":"array","items":{"format":"int32","type":"integer"}},"Preferences":{"$ref":"#/definitions/UserPreferencePutDTO","description":"The user's preferences"}}},"UserInviteBulkDeleteDTO":{"type":"object","properties":{"Ids":{"type":"array","items":{"format":"int32","type":"integer"}}}},"ResetPasswordDTO":{"required":["EmailAddress","ForgottenPasswordGuid","Password"],"type":"object","properties":{"EmailAddress":{"description":"The email address","type":"string"},"ForgottenPasswordGuid":{"description":"The forgotten password guid","type":"string"},"Password":{"description":"The password","type":"string"}}},"UserWithCommunitiesGetDTO":{"type":"object","properties":{"UserId":{"format":"int32","type":"integer"},"UserCommunitiyIds":{"type":"array","items":{"format":"int32","type":"integer"}}}},"UserInviteGetDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The user identifier","type":"integer"},"Email":{"description":"The email","type":"string"},"FirstName":{"description":"The firstname","type":"string"},"LastName":{"description":"The last name","type":"string"},"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"},"InvitedByUserId":{"format":"int32","description":"The invited by user id","type":"integer"},"InvitedDateTime":{"format":"date-time","description":"The invited date time","type":"string"},"BypassTermsAndConditions":{"description":"The bypass terms and conditions flag","type":"boolean"},"BypassPrivacy":{"description":"The bypass privacy flag","type":"boolean"},"OrganisationLanguageCode":{"description":"The organisation language code","type":"string"},"OrganisationCountryCode":{"description":"The organisation country code","type":"string"},"OrganisationRegionId":{"format":"int32","description":"The organisation region id","type":"integer"},"IsAdmin":{"type":"boolean"}}},"UserInvitesPostDTO":{"required":["Users"],"type":"object","properties":{"Users":{"description":"A list of emails","type":"array","items":{"$ref":"#/definitions/MultipleUserInviteUser"}},"OrganisationId":{"format":"int32","description":"The organsiaton id","type":"integer"}}},"MultipleUserInviteUser":{"type":"object","properties":{"Email":{"type":"string"},"IsOrgAdmin":{"type":"boolean"},"IsSiteAdmin":{"type":"boolean"},"IsViewerOnly":{"type":"boolean"},"IsTagSetAdmin":{"type":"boolean"},"Communities":{"type":"array","items":{"format":"int32","type":"integer"}}}},"StaticPagedList[UserInviteForListDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/UserInviteForListDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"UserInviteForListDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The user invite identifier","type":"integer"},"Email":{"description":"The email","type":"string"},"OrganisationName":{"description":"The organisation name","type":"string"},"ExpiryDate":{"format":"date-time","description":"The expiry date","type":"string"}}},"NewCoOwnerDTO":{"type":"object","properties":{"UserId":{"format":"int32","type":"integer"}}},"VideoPostDTO":{"required":["Title"],"type":"object","properties":{"Title":{"description":"The title","type":"string"},"Description":{"description":"The description","type":"string"},"RecordedStamp":{"format":"date-time","description":"The recorded stamp","type":"string"},"TagSetId":{"format":"int32","description":"The tag set id","type":"integer"},"VideoLength":{"format":"int64","description":"The video length","minimum":0,"type":"integer"},"IsFlaggedInapropriate":{"description":"The is flagged inappropiate flag","type":"boolean"},"VideoStreamId":{"format":"int32","description":"The video stream identifier","type":"integer"},"RestrictPlaybackToAllowedIPAddresses":{"description":"Only allow playback from a predefined list of IP addresses\r\nassociated with the organisation","type":"boolean"},"Metadata":{"description":"The list of metadata","type":"array","items":{"$ref":"#/definitions/TaggedVideoMetadataDTO"}},"Tags":{"description":"The list of tags","type":"array","items":{"$ref":"#/definitions/TaggedVideoTagDTO"}},"Possessions":{"description":"The list of possesssions","type":"array","items":{"$ref":"#/definitions/TaggedVideoPossessionPostDTO"}},"Engagements":{"description":"The list of engagements","type":"array","items":{"$ref":"#/definitions/TaggedVideoEngagementDTO"}}}},"StaticPagedList[VideoForListDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/VideoForListDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"VideoForListDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The video identifier","type":"integer"},"Title":{"description":"The title","type":"string"},"Description":{"description":"The description","type":"string"},"StatusId":{"format":"int32","description":"The video status id","type":"integer"},"VideoType":{"description":"Signifies the video type and should be one of the following values:\r\n- 2D Video\r\n- 3D Monoscopic\r\n- 2D Stereoscopic\r\n- 3D Stereoscopic\r\n- Unknown","type":"string"},"UploadedStamp":{"format":"date-time","description":"The uploaded stamp","type":"string"},"RecordedStamp":{"format":"date-time","description":"The recorded stamp","type":"string"},"TagSetId":{"format":"int32","description":"The tag set id","type":"integer"},"TagSetName":{"description":"The tag set name","type":"string"},"User":{"description":"The user","type":"string"},"Relevance":{"format":"int32","description":"The relevance","type":"integer"},"IsController":{"description":"The is controller flag","type":"boolean"},"IsWhiteListProtected":{"description":"The is white list protected","type":"boolean"},"UserEmail":{"description":"User's email","type":"string"},"UserId":{"format":"int32","description":"User's id","type":"integer"},"ExternalUrl":{"description":"External video's url","type":"string"},"HasThumbnails":{"description":"Has current video any thumbnails","type":"boolean"}}},"VideoPutDTO":{"type":"object","properties":{"Title":{"description":"The video title","type":"string"}}},"VideoAWSGetListV3DTO":{"type":"object","properties":{"CommunityId":{"format":"int32","type":"integer"},"VideoId":{"format":"int32","type":"integer"},"VideoTitle":{"type":"string"},"VideoPath":{"type":"string"},"VideoCreatedAt":{"format":"date-time","type":"string"},"VideoStatusId":{"format":"int32","type":"integer"},"Thumbnail":{"$ref":"#/definitions/VideoThumbnailForVideoListGetDTO"},"CreatedBy":{"$ref":"#/definitions/VideoCreatedByUserGetDTO"},"SessionCount":{"format":"int32","type":"integer"},"TranscodeProgress":{"format":"int32","description":"The transcrode progress percentage.","type":"integer"},"TranscodeDetail":{"description":"The transcode detail.","type":"string"},"IsAudioFile":{"description":"True if the file was originally an audio file which has been converted to video.","type":"boolean"},"IsVisualised":{"description":"True if the file was originally an audio file which has been converted to video and \r\nthat the audio wav forms have been encoded into the video feed.","type":"boolean"},"VideoType":{"description":"Signifies the video type and should be one of the following values:\r\n- 2D Video\r\n- 3D Monoscopic\r\n- 2D Stereoscopic\r\n- 3D Stereoscopic\r\n- Unknown","type":"string"}}},"VideoThumbnailForVideoListGetDTO":{"type":"object","properties":{"VideoId":{"format":"int32","type":"integer"},"ThumbnailId":{"format":"int32","type":"integer"},"ThumbnailFilePath":{"type":"string"}}},"VideoCreatedByUserGetDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"ProfilePicture":{"type":"string"},"ProfilePictureDataCentreProvider":{"type":"string"},"ProfilePictureDataCentreLocation":{"type":"string"}}},"VideoSearchResult":{"type":"object","properties":{"Videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"Users":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"Video":{"type":"object","properties":{"VideoId":{"format":"int64","type":"integer"},"VideoTitle":{"type":"string"},"VideoCreatedAt":{"format":"date-time","type":"string"},"VideoStatusId":{"format":"int32","type":"integer"},"CreatedBy":{"$ref":"#/definitions/User"}}},"User":{"type":"object","properties":{"Id":{"format":"int32","description":"The ID of the user","type":"integer"},"FirstName":{"description":"The users first name.","type":"string"},"LastName":{"description":"The users last name.","type":"string"},"ProfilePicture":{"description":"The users profile picture","type":"string"},"ProfilePictureDataCentreProvider":{"description":"The data centre it resides in.","type":"string"},"ProfilePictureDataCentreLocation":{"description":"The location it resides in.","type":"string"}}},"VideoSessionCount":{"type":"object","properties":{"VideoId":{"format":"int64","type":"integer"},"Count":{"format":"int32","type":"integer"}}},"NamedSpeaker":{"description":"Encapsulates a named speaker in a transcript.","type":"object","properties":{"SpeakerId":{"type":"string"},"Name":{"type":"string"},"UserId":{"format":"int64","type":"integer"}}},"VideoPlaybackDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"Gets or sets the identifier.","type":"integer"},"Duration":{"format":"int32","description":"Gets or sets the duration.","type":"integer"},"Tokens":{"description":"Gets or sets the tokens.","type":"array","items":{"$ref":"#/definitions/VideoPlaybackTokenDTO"}}}},"VideoPlaybackTokenDTO":{"type":"object","properties":{"Container":{"description":"Gets or sets the container.","type":"string"},"Width":{"format":"int32","description":"Gets or sets the width.","type":"integer"},"Height":{"format":"int32","description":"Gets or sets the height.","type":"integer"},"TranscodePresetId":{"description":"Gets or sets the transcode preset identifier.","type":"string"},"Url":{"description":"Gets or sets the URL.","type":"string"}}},"SpeakerDTO":{"type":"object","properties":{"SpeakerLabel":{"description":"The label for the speaker as referred to in transcripts, usually by a letter A, B, C etc.","type":"string"},"Name":{"description":"The name of the speaker as known by the user.","type":"string"},"TaggedUserId":{"format":"int32","description":"The user who is tagged in the video.","type":"integer"}}},"SpeakerPutDTO":{"type":"object","properties":{"Label":{"type":"string"},"Name":{"type":"string"},"UserId":{"format":"int32","type":"integer"}}},"VideoPreferencePutDTO":{"type":"object","properties":{"SendVideoTaggedEmail":{"description":"Send an email when a user's video is tagged. This overrides settings stored in UserPreference.","type":"boolean"},"SendVideoWatchedEmail":{"description":"send an email when a user's video is watched","type":"boolean"},"SendVideoCommentEmail":{"description":"send an email when a user's video receives a comment","type":"boolean"}}},"VideoPreferenceGetDTO":{"type":"object","properties":{"SendVideoTaggedEmail":{"description":"Send an email when a user's video is tagged. This overrides settings stored in UserPreference.","type":"boolean"},"SendVideoWatchedEmail":{"description":"send an email when a user's video is watched","type":"boolean"},"SendVideoCommentEmail":{"description":"send an email when a user's video receives a comment","type":"boolean"}}},"TranscriptDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"VideoId":{"format":"int64","type":"integer"},"BotId":{"format":"int64","type":"integer"},"BotKey":{"type":"string"},"LanguageCode":{"type":"string"},"Text":{"type":"string"},"Words":{"type":"array","items":{"$ref":"#/definitions/WordDTO"}},"Utterances":{"type":"array","items":{"$ref":"#/definitions/UtteranceDTO"}},"Confidence":{"format":"float","type":"number"},"AudioDuration":{"format":"int32","type":"integer"},"Punctuate":{"type":"boolean"},"FormatText":{"type":"boolean"},"DualChannel":{"type":"boolean"},"SpeedBoost":{"type":"boolean"},"TranscriptHighlights":{"type":"array","items":{"$ref":"#/definitions/TranscriptHighlightDTO"}},"AutoHighlights":{"type":"boolean"},"AudioStartFrom":{"format":"int32","type":"integer"},"AudioEndAt":{"format":"int32","type":"integer"},"FilterProfanity":{"type":"boolean"},"RedactPii":{"type":"boolean"},"RedactPiiAudio":{"type":"boolean"},"SpeakerLabels":{"type":"boolean"},"ContentSafety":{"type":"boolean"},"IabCategories":{"type":"boolean"},"ContentSafetyLabels":{"type":"array","items":{"$ref":"#/definitions/ContentSafetyLabelDTO"}},"IabCategorySummaries":{"type":"array","items":{"$ref":"#/definitions/IabCategorySummaryDTO"}},"IabCategoryItems":{"type":"array","items":{"$ref":"#/definitions/IabCategoryDTO"}},"LanguageDetection":{"type":"boolean"},"Disfluencies":{"type":"boolean"},"SentimentAnalysis":{"type":"boolean"},"AutoChapters":{"type":"boolean"},"Chapters":{"type":"array","items":{"$ref":"#/definitions/ChapterDTO"}},"SentimentAnalysisResults":{"type":"array","items":{"$ref":"#/definitions/SentimentAnalysisResultDTO"}},"EntityDetection":{"type":"boolean"},"Entities":{"type":"array","items":{"$ref":"#/definitions/EntityDTO"}}}},"WordDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Text":{"type":"string"},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"},"Confidence":{"format":"float","type":"number"},"Speaker":{"type":"string"}}},"UtteranceDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Text":{"type":"string"},"Labels":{"type":"array","items":{"$ref":"#/definitions/IabCategoryLabelDTO"}},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"}}},"TranscriptHighlightDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Count":{"format":"int32","type":"integer"},"Rank":{"format":"float","type":"number"},"Text":{"type":"string"},"Timestamps":{"type":"array","items":{"$ref":"#/definitions/TimestampDTO"}}}},"ContentSafetyLabelDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Text":{"type":"string"},"Items":{"type":"array","items":{"$ref":"#/definitions/ContentSafetyLabelItemDTO"}},"Timestamp":{"$ref":"#/definitions/TimestampDTO"}}},"IabCategorySummaryDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Category":{"type":"string"},"Confidence":{"format":"float","type":"number"}}},"IabCategoryDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Text":{"type":"string"},"Labels":{"type":"array","items":{"$ref":"#/definitions/IabCategoryLabelDTO"}},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"}}},"ChapterDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Summary":{"type":"string"},"Headline":{"type":"string"},"Gist":{"type":"string"},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"}}},"SentimentAnalysisResultDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Text":{"type":"string"},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"},"Sentiment":{"type":"string"},"Confidence":{"format":"float","type":"number"},"Speaker":{"type":"string"}}},"EntityDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"EntityType":{"type":"string"},"Text":{"type":"string"},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"}}},"IabCategoryLabelDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Relevance":{"format":"float","type":"number"},"Text":{"type":"string"}}},"TimestampDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"}}},"ContentSafetyLabelItemDTO":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Relevance":{"format":"float","type":"number"},"Text":{"type":"string"}}},"WordCountDTO":{"type":"object","properties":{"Word":{"type":"string"},"Count":{"format":"int32","type":"integer"},"Appearances":{"type":"array","items":{"$ref":"#/definitions/WordAppearanceDTO"}}}},"WordAppearanceDTO":{"type":"object","properties":{"Confidence":{"format":"float","type":"number"},"Start":{"format":"int32","type":"integer"},"End":{"format":"int32","type":"integer"},"Speaker":{"type":"string"}}},"BotHighlightFilterDTO":{"type":"object","properties":{"FilterToTypes":{"description":"If this is not provided then all highlights will be returned.","type":"array","items":{"type":"string"}},"FilterToBotKeys":{"type":"array","items":{"type":"string"}},"FilterToBotIds":{"type":"array","items":{"format":"int32","type":"integer"}}}},"BotHighlightDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The ID of the highlight generated.","type":"integer"},"StartTime":{"format":"int32","description":"The start time for the higlight.","type":"integer"},"Duration":{"format":"int32","description":"The duration of the highlight","type":"integer"},"BotId":{"format":"int32","description":"The ID of the bot.","type":"integer"},"CreateStamp":{"format":"date-time","description":"The time stamp.","type":"string"},"Text":{"description":"The text related to the highlight.","type":"string"},"MetadataItems":{"description":"Any related metadata.","type":"array","items":{"$ref":"#/definitions/BotHighlightMetadataItemDTO"}},"Type":{"description":"The type of highlight found.","type":"string"}}},"BotHighlightMetadataItemDTO":{"type":"object","properties":{"BotHighlightId":{"format":"int64","type":"integer"},"Subject":{"type":"string"},"Value":{"type":"string"}}},"VideoSearchCriteriaDTO":{"type":"object","properties":{"OrganisationId":{"format":"int32","description":"The organisation ID. If not supplied will default to the users default organisation ID.","type":"integer"},"SearchTerm":{"description":"The search term","type":"string"},"StartDate":{"format":"date-time","description":"The start date","type":"string"},"EndDate":{"format":"date-time","description":"The end date","type":"string"},"TagName":{"description":"The tag name","type":"string"},"TagSelections":{"description":"The tag selections","type":"array","items":{"format":"int32","type":"integer"}},"CommunityIds":{"description":"The list of community ids","type":"array","items":{"format":"int32","type":"integer"}},"VideoIdsToOmit":{"description":"The list of video id's to omit","type":"array","items":{"format":"int64","type":"integer"}},"StatusesToInclude":{"description":"The list of statues to include","type":"array","items":{"format":"int64","type":"integer"}},"IsWatchList":{"description":"The is watch list flag","type":"boolean"},"PageSize":{"format":"int32","description":"The page size","type":"integer"},"PageNumber":{"format":"int32","description":"The page number","type":"integer"},"OrderBy":{"description":"The order by column","type":"string"},"OrderByDirection":{"description":"The order by direction","type":"string"}}},"VideoStatsGetDTO":{"type":"object","properties":{"Views":{"format":"int32","description":"The view count","type":"integer"},"Favourites":{"format":"int32","description":"The favourites count","type":"integer"},"IsFavourited":{"description":"The is favourited flag","type":"boolean"},"IsWatched":{"description":"The is watched flag","type":"boolean"}}},"StaticPagedList[VideoCommentGetDTO]":{"type":"object","properties":{"Items":{"description":"The paginated result","type":"array","items":{"$ref":"#/definitions/VideoCommentGetDTO"}},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalItemCount":{"format":"int32","type":"integer"}}},"VideoCommentGetDTO":{"type":"object","properties":{"Id":{"format":"int64","description":"The video comment indentifier","type":"integer"},"UserId":{"format":"int64","description":"The user id","type":"integer"},"Message":{"description":"The message","type":"string"},"UserName":{"description":"The username","type":"string"},"CreateStamp":{"format":"date-time","description":"The create stamp","type":"string"},"FavouriteCount":{"format":"int32","description":"The favourite count","type":"integer"},"IsFavourited":{"description":"The is faviourited flag","type":"boolean"},"ChildComments":{"$ref":"#/definitions/StaticPagedList[VideoCommentGetDTO]","description":"A paged list of child comments"}}},"VideoCommentPostDTO":{"required":["Message"],"type":"object","properties":{"ParentCommentId":{"format":"int32","description":"The parent comment id","type":"integer"},"Message":{"description":"The message","type":"string"}}},"VideoCommentPutDTO":{"required":["Message"],"type":"object","properties":{"Message":{"description":"The message","type":"string"}}},"VideoCommunitiesPutDTO":{"type":"object","properties":{"Communities":{"description":"A list of community id's","type":"array","items":{"format":"int32","type":"integer"}}}},"UserForAssignmentListDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The unique user identifier","type":"integer"},"FirstName":{"description":"The first name","type":"string"},"LastName":{"description":"The second name","type":"string"},"IsMember":{"description":"The is member flag","type":"boolean"},"OrganisationName":{"description":"The organisation name","type":"string"}}},"VideoDocumentPostDTO":{"type":"object","properties":{"Name":{"description":"Gets or sets the name","type":"string"}}},"VideoDocumentForListDTO":{"type":"object","properties":{"VideoId":{"format":"int64","description":"Get or sets the video id","type":"integer"},"DocumentId":{"format":"int64","description":"Gets or sets the document id","type":"integer"},"Name":{"description":"Gets or sets the name","type":"string"},"UploadedStamp":{"format":"date-time","description":"Gets or sets the uploaded stamp","type":"string"},"UserId":{"format":"int32","description":"Gets or sets the user id","type":"integer"},"UserName":{"description":"Get or set the users name","type":"string"},"StatusId":{"format":"int32","description":"Gets or set the status of the document","type":"integer"},"CanDelete":{"description":"Gets or sets if the document can be deleted by the current user","type":"boolean"}}},"Report":{"description":"Encapsulates a report which can be run on a video.","type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"},"Description":{"type":"string"},"IsAvailableToAll":{"type":"boolean"},"ShouldAutomaticallyStart":{"type":"boolean"}}},"VideoTagGroupLookupDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The video tag group identifier","type":"integer"},"Name":{"description":"The name","type":"string"}}},"VideoTagGroupDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The video tag group identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"FontAwesomePositiveIconName":{"description":"The font awesome positive icon name","type":"string"},"FontAwesomeNeutralIconName":{"description":"The font awesome neutral icon name","type":"string"},"FontAwesomeNegativeIconName":{"description":"The font awesome negative icon name","type":"string"},"EngagementDescription":{"description":"The engagement description","type":"string"},"DisplayEngagement":{"description":"The display engagement flag","type":"boolean"},"OrganisationId":{"format":"int32","description":"The organisation identifier","type":"integer"},"Tags":{"description":"The list of tags","type":"array","items":{"$ref":"#/definitions/VideoTagDTO"}},"Possessions":{"description":"The list of possessions","type":"array","items":{"$ref":"#/definitions/PossessionDTO"}}}},"VideoTagDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The video tag identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"FontAwesomeIconName":{"description":"The font awesome icon name","type":"string"},"IconRotation":{"format":"int32","description":"The icon rotation","type":"integer"},"Colour":{"description":"The hex colour","type":"string"},"PositionId":{"format":"int32","description":"The posistion id","type":"integer"},"SubTagType":{"$ref":"#/definitions/SubTagSelectionTypeDTO","description":"The sub tags"},"SubTagScroller":{"$ref":"#/definitions/SubTagScrollerDTO"},"VideoTagSubTagCheckList":{"type":"array","items":{"$ref":"#/definitions/VideoTagSubTagCheckListGetDTO"}},"SubTags":{"type":"array","items":{"$ref":"#/definitions/VideoSubTagDTO"}}}},"PossessionDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The possession identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Colour":{"description":"The colour","type":"string"},"SelectedColour":{"description":"The selected colour","type":"string"},"FontAwesomeIconName":{"description":"The font awesome icon name","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"}}},"VideoTagSubTagCheckListGetDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"IsChecked":{"type":"boolean"},"SubTagCheckListItem":{"$ref":"#/definitions/SubTagCheckListItem"}}},"VideoSubTagDTO":{"type":"object","properties":{"Id":{"format":"int32","description":"The video sub tag identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"},"FontAwesomeIconName1":{"type":"string"},"FontAwesomeIconName2":{"type":"string"},"FontAwesomeIconName3":{"type":"string"}}},"VideoTagGroupPostDTO":{"required":["Name"],"type":"object","properties":{"OrganisationId":{"format":"int32","description":"The organisation id","type":"integer"},"Name":{"description":"The name","type":"string"},"DisplayEngagement":{"description":"The display engagement flag","type":"boolean"},"EngagementDescription":{"description":"The engagement description","type":"string"},"Tags":{"description":"The list of tags","type":"array","items":{"$ref":"#/definitions/VideoTagPostDTO"}},"Possessions":{"description":"The list of possesssions","type":"array","items":{"$ref":"#/definitions/PossessionPostDTO"}}}},"VideoTagPostDTO":{"required":["Name","FontAwesomeIconName","Colour"],"type":"object","properties":{"Id":{"format":"int32","description":"The video tag id","type":"integer"},"Name":{"description":"The name","type":"string"},"FontAwesomeIconName":{"description":"The font awesome icon name","type":"string"},"IconRotation":{"format":"int32","description":"The icon rotation","type":"integer"},"Colour":{"description":"The colour","type":"string"},"PositionId":{"format":"int32","description":"The position id","maximum":8,"minimum":1,"type":"integer"},"SubTags":{"description":"The list of sub tags","type":"array","items":{"$ref":"#/definitions/VideoSubTagPostDTO"}},"SubTagScroller":{"$ref":"#/definitions/SubTagScrollerPostDTO"},"SubTagTypeId":{"format":"int32","type":"integer"},"CheckList":{"$ref":"#/definitions/VideoTagChecklistPostDTO"}}},"PossessionPostDTO":{"required":["Name","Colour","SelectedColour","FontAwesomeIconName"],"type":"object","properties":{"Id":{"format":"int32","description":"The possession identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Colour":{"description":"The colour","type":"string"},"SelectedColour":{"description":"The selected colour","type":"string"},"FontAwesomeIconName":{"description":"The font awesome icon name","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"}}},"VideoSubTagPostDTO":{"required":["Name"],"type":"object","properties":{"Id":{"format":"int32","description":"The video sub tag identifier","type":"integer"},"Name":{"description":"The name","type":"string"},"Order":{"format":"int32","description":"The order","type":"integer"},"FontAwesomeIconName1":{"type":"string"},"FontAwesomeIconName2":{"type":"string"},"FontAwesomeIconName3":{"type":"string"}}},"SubTagScrollerPostDTO":{"type":"object","properties":{"MinValue":{"format":"int32","type":"integer"},"MaxValue":{"format":"int32","type":"integer"},"IntervalValue":{"format":"int32","type":"integer"},"ScrollerValue":{"format":"int32","type":"integer"}}},"VideoTagChecklistPostDTO":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"IsChecked":{"type":"boolean"},"SubTagCheckListItemId":{"format":"int32","type":"integer"}}},"ShareVideoWithUserPutDTO":{"type":"object","properties":{"UsersIds":{"type":"array","items":{"format":"int32","type":"integer"}},"VideosIds":{"type":"array","items":{"format":"int32","type":"integer"}}}}}}