Trendsic Platform Service

<back to all web services

ContactSayNameAsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/contact/{ContactId}/say-name-as
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 ContactQueueVisit() = 
        member val CheckinId:Guid = new Guid() with get,set
        member val BranchId:Guid = new Guid() with get,set
        member val BranchName:String = null with get,set
        member val LineId:Guid = new Guid() with get,set
        member val ServiceName:String = null with get,set
        member val Outcome:Int32 = new Int32() with get,set
        member val OutcomeLabel:String = null with get,set
        member val IsAppointment:Boolean = new Boolean() with get,set
        member val SignInUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CalledUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FirstStartUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CompletedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val WaitMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ServiceMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WindowName:String = null with get,set
        member val TicketLabel:String = null with get,set
        member val HoldReason:String = null with get,set
        member val ReturnedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PausedMinutes:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ContactQueueVisitSummary() = 
        member val Visits:Int32 = new Int32() with get,set
        member val Completed:Int32 = new Int32() with get,set
        member val NoShows:Int32 = new Int32() with get,set
        member val NoShows90d:Int32 = new Int32() with get,set
        member val Cancelled:Int32 = new Int32() with get,set
        member val Unfulfilled:Int32 = new Int32() with get,set
        member val Appointments:Int32 = new Int32() with get,set
        member val LastVisitUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastNoShowUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AvgWaitMinutes:Nullable<Double> = new Nullable<Double>() with get,set
        member val SmsOptIn:Boolean = new Boolean() with get,set
        member val TextsSent90d:Int32 = new Int32() with get,set
        member val SayNameAs:String = null with get,set

    [<AllowNullLiteral>]
    type ContactVisitsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Visits:ResizeArray<ContactQueueVisit> = new ResizeArray<ContactQueueVisit>() with get,set
        member val Summary:ContactQueueVisitSummary = null with get,set

    [<AllowNullLiteral>]
    type ContactSayNameAsRequest() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val SayNameAs:String = null with get,set

F# ContactSayNameAsRequest DTOs

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

HTTP + OTHER

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

PUT /v1/contact/{ContactId}/say-name-as HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":0,"SayNameAs":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Visits":[{"CheckinId":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000","BranchName":"String","LineId":"00000000000000000000000000000000","ServiceName":"String","Outcome":0,"OutcomeLabel":"String","IsAppointment":false,"SignInUtc":"0001-01-01T00:00:00.0000000","CalledUtc":"0001-01-01T00:00:00.0000000","FirstStartUtc":"0001-01-01T00:00:00.0000000","CompletedTime":"0001-01-01T00:00:00.0000000","WaitMinutes":0,"ServiceMinutes":0,"WindowName":"String","TicketLabel":"String","HoldReason":"String","ReturnedTime":"0001-01-01T00:00:00.0000000","PausedMinutes":0}],"Summary":{"Visits":0,"Completed":0,"NoShows":0,"NoShows90d":0,"Cancelled":0,"Unfulfilled":0,"Appointments":0,"LastVisitUtc":"0001-01-01T00:00:00.0000000","LastNoShowUtc":"0001-01-01T00:00:00.0000000","AvgWaitMinutes":0,"SmsOptIn":false,"TextsSent90d":0,"SayNameAs":"String"}}