Trendsic Platform Service

<back to all web services

PortalVisitsRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/visits
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerVisit:
    agreement_job_i_d: int = 0
    visit_date: Optional[datetime.datetime] = None
    completed_at: Optional[datetime.datetime] = None
    service_name: Optional[str] = None
    crew_notes: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerVisitPhoto:
    project_location_attachment_i_d: int = 0
    agreement_job_i_d: Optional[int] = None
    doc_title: Optional[str] = None
    mime_type: Optional[str] = None
    upload_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalVisitsResponse:
    response_status: Optional[ResponseStatus] = None
    visits: List[CustomerVisit] = field(default_factory=list)
    photos: List[CustomerVisitPhoto] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalVisitsRequest:
    token: Optional[str] = None

Python PortalVisitsRequest DTOs

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.

GET /portal/{Token}/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PortalVisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Photos>
    <CustomerVisitPhoto>
      <AgreementJobID>0</AgreementJobID>
      <DocTitle>String</DocTitle>
      <MimeType>String</MimeType>
      <ProjectLocationAttachmentID>0</ProjectLocationAttachmentID>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
    </CustomerVisitPhoto>
  </Photos>
  <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>
    <CustomerVisit>
      <AgreementJobID>0</AgreementJobID>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <CrewNotes>String</CrewNotes>
      <ServiceName>String</ServiceName>
      <VisitDate>0001-01-01T00:00:00</VisitDate>
    </CustomerVisit>
  </Visits>
</PortalVisitsResponse>