=============================================== API Schema | PROD Discussion API - Http | 2.1.0 =============================================== -------------------- CreateCommentCommand -------------------- ------- Request ------- TraceOne.Api.Discussion.Default.Messages.Commands.Comments.CreateCommentCommand DiscussionId Guid ContentText String XfdfAnnotation String AuthorUserId Nullable ExternalCode String ReplyToCommentId Nullable ReplyToExternalCode String OverwriteExisting Boolean MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Discussion.Default.Messages.Commands.Comments.CreateCommentCommand+CreateCommentResponse Id Guid ExternalCode String -------- Security -------- CreateCommentCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1467e10-f360-4bcc-9a4c-f5765d0ca808 Forbidden 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound c6691641-730e-4dcd-adcb-e443b352c25f ImpossibleToGetAuthorUserId ca6b49fe-8dbb-49e1-be97-2b61efbdf0db EmptyDiscussionId 74b8b02c-db98-4108-8e58-cafcdfb0b71f EmptyContentText e536bb17-fede-48ac-bfde-cbd0b3143da1 InvalidXfdfAnnotation 86f953a3-ccab-4513-b4d8-051c70bed95e InvalidReplyToComment 62d30547-fd16-48bb-b687-9cc45fbbb058 InvalidUserId a8633150-3cff-4457-a5f1-01aa0d1ab52f TooManyCommentsWithSameExternalCodeAlreadyExists ----------------------- CreateDiscussionCommand ----------------------- ------- Request ------- TraceOne.Api.Discussion.Default.Messages.Commands.Discussions.CreateDiscussionCommand DiscussionIdentifier String OwnerCompanyId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Discussion.Default.Messages.Commands.Discussions.CreateDiscussionCommand+CreateDiscussionResponse Id Guid -------- Security -------- CreateDiscussionCommand requests require an identity token for an authenticated identity with authorisation to permissions discussions.write ----------- Error Codes ----------- d0a9771f-9bdb-491c-8b8b-4fd4fda4099f Forbidden 4f528354-cf2e-44f4-bcd4-f4a5eea4d1de EmptyDiscussionIdentifier ca39ede4-6cbc-4ead-a3b6-f2c285fe6287 EmptyOwnerCompanyId 6748402e-1b7e-4a1b-8b0c-761ddf901cc1 DiscussionIdentifierIsNotUnique a1853968-2f75-4202-be8c-18ec477bf9c5 ImpossibleToGetOwnerCompanyId 61c90190-3658-4b98-99d2-89dd020fefda InvalidCompanyId ---------------------------------- DeleteCommentByExternalCodeCommand ---------------------------------- TraceOne.Api.Discussion.Default.Messages.Commands.Comments.DeleteCommentByExternalCodeCommand DiscussionId Guid ExternalCode String MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- DeleteCommentByExternalCodeCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1467e10-f360-4bcc-9a4c-f5765d0ca808 Forbidden 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound -------------------- DeleteCommentCommand -------------------- TraceOne.Api.Discussion.Default.Messages.Commands.Comments.DeleteCommentCommand CommentId Guid MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- DeleteCommentCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1467e10-f360-4bcc-9a4c-f5765d0ca808 Forbidden 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound ---------------------------- BulkImportDiscussionsCommand ---------------------------- TraceOne.Api.Discussion.Default.Messages.Commands.Import.BulkImportDiscussionsCommand Discussions IEnumerable TraceOne.Api.Discussion.Default.Messages.Commands.Import.BulkImportDiscussionsCommand+DiscussionViewModel Id Guid DiscussionIdentifier String OwnerCompanyId Guid Comments IEnumerable TraceOne.Api.Discussion.Default.Messages.Commands.Import.BulkImportDiscussionsCommand+CommentViewModel Id Guid ContentText String XfdfAnnotation String AuthorUserId Guid ExternalCode String ReplyToCommentId Nullable Position Int32 MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- BulkImportDiscussionsCommand requests require an identity token for an authenticated identity with authorisation to permissions discussions.write ---------------------------------- UpdateCommentByExternalCodeCommand ---------------------------------- TraceOne.Api.Discussion.Default.Messages.Commands.Comments.UpdateCommentByExternalCodeCommand DiscussionId Guid ExternalCode String ContentText String XfdfAnnotation String MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- UpdateCommentByExternalCodeCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1467e10-f360-4bcc-9a4c-f5765d0ca808 Forbidden 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound 59e9abc0-e616-407f-841d-5fc10244c71f EmptyContentText 0644bca3-0cf7-4a7f-8301-9f5a437bc601 InvalidXfdfAnnotation -------------------- UpdateCommentCommand -------------------- TraceOne.Api.Discussion.Default.Messages.Commands.Comments.UpdateCommentCommand CommentId Guid ContentText String XfdfAnnotation String MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- UpdateCommentCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1467e10-f360-4bcc-9a4c-f5765d0ca808 Forbidden 4b6c2099-cb41-4acb-ba2d-89499b011879 NotFound 59e9abc0-e616-407f-841d-5fc10244c71f EmptyContentText 0644bca3-0cf7-4a7f-8301-9f5a437bc601 InvalidXfdfAnnotation =============================================== ------------------------ 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