Trendsic Platform Service

<back to all web services

CustomerNoteDoneRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/customercheckins/{Id}/notes/{NoteId}/done
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CustomerNote
            Public Overridable Property NoteId As Integer
            Public Overridable Property Scope As String
            Public Overridable Property Text As String
            Public Overridable Property IsPriority As Boolean
            Public Overridable Property CreatedByUserId As Guid?
            Public Overridable Property CreatedByName As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property DoneAt As Date?
            Public Overridable Property IsCarry As Boolean
            Public Overridable Property ShownAt As Date?
        End Class

        Public Partial Class CustomerNoteDoneRequest
            Public Overridable Property Id As Guid
            Public Overridable Property NoteId As Integer
        End Class

        Public Partial Class CustomerNoteResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Notes As List(Of CustomerNote) = New List(Of CustomerNote)
            Public Overridable Property Carry As List(Of CustomerNote) = New List(Of CustomerNote)
            Public Overridable Property CanPriority As Boolean
            Public Overridable Property Note As CustomerNote
        End Class
    End Namespace
End Namespace

VB.NET CustomerNoteDoneRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/customercheckins/{Id}/notes/{NoteId}/done HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 00000000000000000000000000000000,
	NoteId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Notes: 
	[
		{
			NoteId: 0,
			Scope: String,
			Text: String,
			IsPriority: False,
			CreatedByUserId: 00000000000000000000000000000000,
			CreatedByName: String,
			CreatedAt: 0001-01-01,
			DoneAt: 0001-01-01,
			IsCarry: False,
			ShownAt: 0001-01-01
		}
	],
	Carry: 
	[
		{
			NoteId: 0,
			Scope: String,
			Text: String,
			IsPriority: False,
			CreatedByUserId: 00000000000000000000000000000000,
			CreatedByName: String,
			CreatedAt: 0001-01-01,
			DoneAt: 0001-01-01,
			IsCarry: False,
			ShownAt: 0001-01-01
		}
	],
	CanPriority: False,
	Note: 
	{
		NoteId: 0,
		Scope: String,
		Text: String,
		IsPriority: False,
		CreatedByUserId: 00000000000000000000000000000000,
		CreatedByName: String,
		CreatedAt: 0001-01-01,
		DoneAt: 0001-01-01,
		IsCarry: False,
		ShownAt: 0001-01-01
	}
}