| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/queue/appointments/contacts |
|---|
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 BranchApptContact:
contact_id: int = 0
contact_guid: Optional[str] = None
name: Optional[str] = None
phone: Optional[str] = None
email: Optional[str] = None
past_visits: int = 0
last_visit_local: Optional[datetime.datetime] = None
next_local: Optional[datetime.datetime] = None
phone_match: bool = False
email_match: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchApptContactsResponse:
response_status: Optional[ResponseStatus] = None
contacts: List[BranchApptContact] = field(default_factory=list)
duplicate: Optional[BranchApptContact] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchApptContactsRequest:
location_id: Optional[str] = None
q: Optional[str] = None
phone: Optional[str] = None
email: Optional[str] = None
Python BranchApptContactsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/queue/appointments/contacts HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BranchApptContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Contacts>
<BranchApptContact>
<ContactGuid>00000000-0000-0000-0000-000000000000</ContactGuid>
<ContactId>0</ContactId>
<Email>String</Email>
<EmailMatch>false</EmailMatch>
<LastVisitLocal>0001-01-01T00:00:00</LastVisitLocal>
<Name>String</Name>
<NextLocal>0001-01-01T00:00:00</NextLocal>
<PastVisits>0</PastVisits>
<Phone>String</Phone>
<PhoneMatch>false</PhoneMatch>
</BranchApptContact>
</Contacts>
<Duplicate>
<ContactGuid>00000000-0000-0000-0000-000000000000</ContactGuid>
<ContactId>0</ContactId>
<Email>String</Email>
<EmailMatch>false</EmailMatch>
<LastVisitLocal>0001-01-01T00:00:00</LastVisitLocal>
<Name>String</Name>
<NextLocal>0001-01-01T00:00:00</NextLocal>
<PastVisits>0</PastVisits>
<Phone>String</Phone>
<PhoneMatch>false</PhoneMatch>
</Duplicate>
<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>
</BranchApptContactsResponse>