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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ContactSayNameAsRequest
{
    open var ContactId:Int? = null
    open var SayNameAs:String? = null
}

open class ContactVisitsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Visits:ArrayList<ContactQueueVisit> = ArrayList<ContactQueueVisit>()
    open var Summary:ContactQueueVisitSummary? = null
}

open class ContactQueueVisit
{
    open var CheckinId:UUID? = null
    open var BranchId:UUID? = null
    open var BranchName:String? = null
    open var LineId:UUID? = null
    open var ServiceName:String? = null
    open var Outcome:Int? = null
    open var OutcomeLabel:String? = null
    open var IsAppointment:Boolean? = null
    open var SignInUtc:Date? = null
    open var CalledUtc:Date? = null
    open var FirstStartUtc:Date? = null
    open var CompletedTime:Date? = null
    open var WaitMinutes:Int? = null
    open var ServiceMinutes:Int? = null
    open var WindowName:String? = null
    open var TicketLabel:String? = null
    open var HoldReason:String? = null
    open var ReturnedTime:Date? = null
    open var PausedMinutes:Int? = null
}

open class ContactQueueVisitSummary
{
    open var Visits:Int? = null
    open var Completed:Int? = null
    open var NoShows:Int? = null
    open var NoShows90d:Int? = null
    open var Cancelled:Int? = null
    open var Unfulfilled:Int? = null
    open var Appointments:Int? = null
    open var LastVisitUtc:Date? = null
    open var LastNoShowUtc:Date? = null
    open var AvgWaitMinutes:Double? = null
    open var SmsOptIn:Boolean? = null
    open var TextsSent90d:Int? = null
    open var SayNameAs:String? = null
}

Kotlin 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"}}