=============================================== API Schema | PROD Discussion API - Http | 2.1.0 =============================================== ------------------------------------ GetDiscussionCommentsWebSocketsQuery ------------------------------------ ------- Request ------- TraceOne.Api.Discussion.Default.Messages.Websockets.Discussions.GetDiscussionCommentsWebSocketsQuery DiscussionId Guid MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Discussion.Default.Messages.Websockets.Discussions.GetDiscussionCommentsWebSocketsQuery+GetDiscussionCommentsResponse CommentsChanges List TraceOne.Api.Discussion.Default.Messages.Websockets.Discussions.GetDiscussionCommentsWebSocketsQuery+CommentChangeViewModel ChangeType String CommentId Guid ExternalCode String AuthorUserId Guid DiscussionId Guid ContentText String XfdfAnnotation String ReplyToCommentId Nullable CreatedDate DateTime ModifiedDate DateTime LastModifiedByUserId Guid IsParentCommentRecreatedBecauseOfReply Boolean -------- Security -------- GetDiscussionCommentsWebSocketsQuery requests require an identity token for an authenticated identity. ----------- Error Codes ----------- 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound 6ee6a9bc-545f-4658-bfde-6df33dc6acd2 EmptyDiscussionId ------------------------------------- GetDiscussionsRootCommentsCountsQuery ------------------------------------- ------- Request ------- TraceOne.Api.Discussion.Default.Messages.Queries.Discussions.GetDiscussionsRootCommentsCountsQuery DiscussionIds List MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Discussion.Default.Messages.Queries.Discussions.GetDiscussionsRootCommentsCountsQuery+GetDiscussionsRootCommentsCountsResponse CommentsCounts List TraceOne.Api.Discussion.Default.Messages.Queries.Discussions.GetDiscussionsRootCommentsCountsQuery+RootCommentsCountModel DiscussionId Guid CommentsCount Int32 -------- Security -------- GetDiscussionsRootCommentsCountsQuery requests require an identity token for an authenticated identity with authorisation to permissions discussions.read ----------- Error Codes ----------- b36e5bee-edd7-4290-904f-39eb2bfa1d4a EmptyDiscussionIds fd99c406-fbd5-4925-89ab-b844f84df7b0 DiscussionIdsAreNotAllDistinct ------------------------------ GetDiscussionsWithFiltersQuery ------------------------------ ------- Request ------- TraceOne.Api.Discussion.Default.Messages.Queries.Discussions.GetDiscussionsWithFiltersQuery OwnerCompanyId Nullable IdsIn List IdentifiersIn List Skip Int32 Take Int32 MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Discussion.Default.Messages.Queries.Discussions.GetDiscussionsWithFiltersQuery+GetDiscussionsWithFiltersResponse SkipAndTakeQueryStats TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats TotalCount Int32 CurrentCount Int32 Discussions List TraceOne.Api.Discussion.Default.Messages.Queries.Discussions.GetDiscussionsWithFiltersQuery+DiscussionModel Id Guid Identifier String OwnerCompanyId Guid -------- Security -------- GetDiscussionsWithFiltersQuery requests require an identity token for an authenticated identity with authorisation to permissions discussions.read ----------- Error Codes ----------- ee01c488-f150-472e-96d1-51cbebf6d946 IdsCountGreaterThanMaxLimit 4edc22c8-5fdd-406a-a6e2-a3ce7ed33ba3 IdentifiersCountGreaterThanMaxLimit ------------------------------------------- GetDiscussionUserConnectionsWebSocketsQuery ------------------------------------------- ------- Request ------- TraceOne.Api.Discussion.Default.Messages.Websockets.Discussions.GetDiscussionUserConnectionsWebSocketsQuery DiscussionId Guid MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Discussion.Default.Messages.Websockets.Discussions.GetDiscussionUserConnectionsWebSocketsQuery+GetDiscussionUserConnectionsResponse UserConnectionsChanges List TraceOne.Api.Discussion.Default.Messages.Websockets.Discussions.GetDiscussionUserConnectionsWebSocketsQuery+UserConnectionChangeViewModel UserConnectionId Guid ChangeType String DiscussionId Guid UserId Guid ConnectedDateTime DateTime -------- Security -------- GetDiscussionUserConnectionsWebSocketsQuery requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1467e10-f360-4bcc-9a4c-f5765d0ca808 Forbidden 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound 6ee6a9bc-545f-4658-bfde-6df33dc6acd2 EmptyDiscussionId =============================================== ------------------------ API Platform Error Codes ------------------------ 2f65ced1-ee26-400a-aa79-e0ce02092962 ApiMessageWithMessageIdHasAlreadyBeenProcessed 15541748-28da-4753-807e-7a8104c45d74 MessageLogItemCreationFailure 7520255f-152f-4e08-a081-f1bda0ff4d43 AuthenticatorFailure 6a86426a-6082-4a9e-a295-937a81ea393f AuthenticationRequired e3fcfb67-4e06-413c-8a8f-4519e01c5a87 AuthorisationFailure d4b50726-e3d1-432c-ab70-46baec1dbf8c AuthorisationRequired