Trendsic Platform Service

<back to all web services

CustomerNoteDeleteRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/customercheckins/{Id}/notes/{NoteId}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CustomerNote() = 
        member val NoteId:Int32 = new Int32() with get,set
        member val Scope:String = null with get,set
        member val Text:String = null with get,set
        member val IsPriority:Boolean = new Boolean() with get,set
        member val CreatedByUserId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val CreatedByName:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DoneAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsCarry:Boolean = new Boolean() with get,set
        member val ShownAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CustomerNoteResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Notes:ResizeArray<CustomerNote> = new ResizeArray<CustomerNote>() with get,set
        member val Carry:ResizeArray<CustomerNote> = new ResizeArray<CustomerNote>() with get,set
        member val CanPriority:Boolean = new Boolean() with get,set
        member val Note:CustomerNote = null with get,set

    [<AllowNullLiteral>]
    type CustomerNoteDeleteRequest() = 
        member val Id:Guid = new Guid() with get,set
        member val NoteId:Int32 = new Int32() with get,set

F# CustomerNoteDeleteRequest DTOs

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

HTTP + XML

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

DELETE /v1/customercheckins/{Id}/notes/{NoteId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerNoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanPriority>false</CanPriority>
  <Carry>
    <CustomerNote>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedByName>String</CreatedByName>
      <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
      <DoneAt>0001-01-01T00:00:00</DoneAt>
      <IsCarry>false</IsCarry>
      <IsPriority>false</IsPriority>
      <NoteId>0</NoteId>
      <Scope>String</Scope>
      <ShownAt>0001-01-01T00:00:00</ShownAt>
      <Text>String</Text>
    </CustomerNote>
  </Carry>
  <Note>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedByName>String</CreatedByName>
    <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
    <DoneAt>0001-01-01T00:00:00</DoneAt>
    <IsCarry>false</IsCarry>
    <IsPriority>false</IsPriority>
    <NoteId>0</NoteId>
    <Scope>String</Scope>
    <ShownAt>0001-01-01T00:00:00</ShownAt>
    <Text>String</Text>
  </Note>
  <Notes>
    <CustomerNote>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedByName>String</CreatedByName>
      <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
      <DoneAt>0001-01-01T00:00:00</DoneAt>
      <IsCarry>false</IsCarry>
      <IsPriority>false</IsPriority>
      <NoteId>0</NoteId>
      <Scope>String</Scope>
      <ShownAt>0001-01-01T00:00:00</ShownAt>
      <Text>String</Text>
    </CustomerNote>
  </Notes>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CustomerNoteResponse>