| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/contact/{ContactId}/visits |
|---|
export class ContactQueueVisit
{
public CheckinId: string;
public BranchId: string;
public BranchName: string;
public LineId: string;
public ServiceName: string;
public Outcome: number;
public OutcomeLabel: string;
public IsAppointment: boolean;
public SignInUtc?: string;
public CalledUtc?: string;
public FirstStartUtc?: string;
public CompletedTime?: string;
public WaitMinutes?: number;
public ServiceMinutes?: number;
public WindowName: string;
public TicketLabel: string;
public HoldReason: string;
public ReturnedTime?: string;
public PausedMinutes: number;
public constructor(init?: Partial<ContactQueueVisit>) { (Object as any).assign(this, init); }
}
export class ContactQueueVisitSummary
{
public Visits: number;
public Completed: number;
public NoShows: number;
public NoShows90d: number;
public Cancelled: number;
public Unfulfilled: number;
public Appointments: number;
public LastVisitUtc?: string;
public LastNoShowUtc?: string;
public AvgWaitMinutes?: number;
public SmsOptIn: boolean;
public TextsSent90d: number;
public SayNameAs: string;
public constructor(init?: Partial<ContactQueueVisitSummary>) { (Object as any).assign(this, init); }
}
export class ContactVisitsResponse
{
public ResponseStatus: ResponseStatus;
public Visits: ContactQueueVisit[] = [];
public Summary: ContactQueueVisitSummary;
public constructor(init?: Partial<ContactVisitsResponse>) { (Object as any).assign(this, init); }
}
export class ContactVisitsRequest
{
public ContactId: number;
public Take: number;
public constructor(init?: Partial<ContactVisitsRequest>) { (Object as any).assign(this, init); }
}
TypeScript ContactVisitsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/contact/{ContactId}/visits HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
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"}}