Trendsic Platform Service

KpiV2VisitsRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/kpiv2/visits

**KpiV2VisitsRequest** Parameters:
Name	Parameter	Data Type	Required
BranchId	body	Guid	No
FromDate	body	DateTime	No
ToDate	body	DateTime	No
StationId	body	Guid?	No
EmployeeId	body	Guid?	No
Outcome	body	string	No
LineId	body	Guid?	No
Page	body	int	No
PageSize	body	int	No

**KpiV2VisitsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Visits	form	SvcVisitPage	No

**SvcVisitPage** Parameters:
Name	Parameter	Data Type	Required
Rows	form	List<SvcVisitRow>	No
TotalRows	form	int	No
Page	form	int	No
PageSize	form	int	No
OutcomeCounts	form	Dictionary<string, int>	No
Services	form	List<SvcChip>	No
CanSeeStaff	form	bool	No
CanSeeFinancial	form	bool	No

**SvcVisitRow** Parameters:
Name	Parameter	Data Type	Required
CheckinId	form	Guid	No
TicketLabel	form	string	No
LocalDate	form	DateTime	No
LineId	form	Guid	No
ServiceName	form	string	No
StationId	form	Guid?	No
StationName	form	string	No
EmployeeId	form	Guid?	No
EmployeeName	form	string	No
CustomerName	form	string	No
ContactId	form	int?	No
ContactAgentId	form	int?	No
CustomerId	form	Guid	No
IsAppointment	form	bool	No
LocalHere	form	DateTime?	No
LocalCalled	form	DateTime?	No
LocalStart	form	DateTime?	No
LocalEnd	form	DateTime?	No
WaitSec	form	int?	No
ServeSec	form	int?	No
Outcome	form	string	No
Fee	form	decimal?	No

**SvcChip** Parameters:
Name	Parameter	Data Type	Required
LineId	form	Guid	No
Name	form	string	No
N	form	int	No

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.

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

<KpiV2VisitsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <LineId>00000000-0000-0000-0000-000000000000</LineId>
  <Outcome>String</Outcome>
  <Page>0</Page>
  <PageSize>0</PageSize>
  <StationId>00000000-0000-0000-0000-000000000000</StationId>
  <ToDate>0001-01-01T00:00:00</ToDate>
</KpiV2VisitsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KpiV2VisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Visits>
    <CanSeeFinancial>false</CanSeeFinancial>
    <CanSeeStaff>false</CanSeeStaff>
    <OutcomeCounts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringint>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>0</d3p1:Value>
      </d3p1:KeyValueOfstringint>
    </OutcomeCounts>
    <Page>0</Page>
    <PageSize>0</PageSize>
    <Rows>
      <SvcVisitRow>
        <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
        <ContactAgentId>0</ContactAgentId>
        <ContactId>0</ContactId>
        <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
        <CustomerName>String</CustomerName>
        <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
        <EmployeeName>String</EmployeeName>
        <Fee>0</Fee>
        <IsAppointment>false</IsAppointment>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <LocalCalled>0001-01-01T00:00:00</LocalCalled>
        <LocalDate>0001-01-01T00:00:00</LocalDate>
        <LocalEnd>0001-01-01T00:00:00</LocalEnd>
        <LocalHere>0001-01-01T00:00:00</LocalHere>
        <LocalStart>0001-01-01T00:00:00</LocalStart>
        <Outcome>String</Outcome>
        <ServeSec>0</ServeSec>
        <ServiceName>String</ServiceName>
        <StationId>00000000-0000-0000-0000-000000000000</StationId>
        <StationName>String</StationName>
        <TicketLabel>String</TicketLabel>
        <WaitSec>0</WaitSec>
      </SvcVisitRow>
    </Rows>
    <Services>
      <SvcChip>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <N>0</N>
        <Name>String</Name>
      </SvcChip>
    </Services>
    <TotalRows>0</TotalRows>
  </Visits>
</KpiV2VisitsResponse>