Trendsic Platform Service

<back to all web services

KpiV2VisitsRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/kpiv2/visits
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class KpiV2VisitsRequest
{
    open var BranchId:UUID? = null
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var StationId:UUID? = null
    open var EmployeeId:UUID? = null
    open var Outcome:String? = null
    open var LineId:UUID? = null
    open var Page:Int? = null
    open var PageSize:Int? = null
}

open class KpiV2VisitsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Visits:SvcVisitPage? = null
}

open class SvcVisitPage
{
    open var Rows:ArrayList<SvcVisitRow> = ArrayList<SvcVisitRow>()
    open var TotalRows:Int? = null
    open var Page:Int? = null
    open var PageSize:Int? = null
    open var OutcomeCounts:HashMap<String,Int> = HashMap<String,Int>()
    open var Services:ArrayList<SvcChip> = ArrayList<SvcChip>()
    open var CanSeeStaff:Boolean? = null
    open var CanSeeFinancial:Boolean? = null
}

open class SvcVisitRow
{
    open var CheckinId:UUID? = null
    open var TicketLabel:String? = null
    open var LocalDate:Date? = null
    open var LineId:UUID? = null
    open var ServiceName:String? = null
    open var StationId:UUID? = null
    open var StationName:String? = null
    open var EmployeeId:UUID? = null
    open var EmployeeName:String? = null
    open var CustomerName:String? = null
    open var ContactId:Int? = null
    open var ContactAgentId:Int? = null
    open var CustomerId:UUID? = null
    open var IsAppointment:Boolean? = null
    open var LocalHere:Date? = null
    open var LocalCalled:Date? = null
    open var LocalStart:Date? = null
    open var LocalEnd:Date? = null
    open var WaitSec:Int? = null
    open var ServeSec:Int? = null
    open var Outcome:String? = null
    open var Fee:BigDecimal? = null
}

open class SvcChip
{
    open var LineId:UUID? = null
    open var Name:String? = null
    open var N:Int? = null
}

Kotlin KpiV2VisitsRequest 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.

POST /v1/dashboard/kpiv2/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"BranchId":"00000000000000000000000000000000","FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","StationId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","Outcome":"String","LineId":"00000000000000000000000000000000","Page":0,"PageSize":0}
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":{"Rows":[{"CheckinId":"00000000000000000000000000000000","TicketLabel":"String","LocalDate":"0001-01-01T00:00:00.0000000","LineId":"00000000000000000000000000000000","ServiceName":"String","StationId":"00000000000000000000000000000000","StationName":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","CustomerName":"String","ContactId":0,"ContactAgentId":0,"CustomerId":"00000000000000000000000000000000","IsAppointment":false,"LocalHere":"0001-01-01T00:00:00.0000000","LocalCalled":"0001-01-01T00:00:00.0000000","LocalStart":"0001-01-01T00:00:00.0000000","LocalEnd":"0001-01-01T00:00:00.0000000","WaitSec":0,"ServeSec":0,"Outcome":"String","Fee":0}],"TotalRows":0,"Page":0,"PageSize":0,"OutcomeCounts":{"String":0},"Services":[{"LineId":"00000000000000000000000000000000","Name":"String","N":0}],"CanSeeStaff":false,"CanSeeFinancial":false}}