| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Contacts:
[
{
ContactId: 0,
ContactGuid: 00000000000000000000000000000000,
Name: String,
Phone: String,
Email: String,
PastVisits: 0,
LastVisitLocal: 0001-01-01,
NextLocal: 0001-01-01,
PhoneMatch: False,
EmailMatch: False
}
],
Duplicate:
{
ContactId: 0,
ContactGuid: 00000000000000000000000000000000,
Name: String,
Phone: String,
Email: String,
PastVisits: 0,
LastVisitLocal: 0001-01-01,
NextLocal: 0001-01-01,
PhoneMatch: False,
EmailMatch: False
}
}