Trendsic Platform Service

<back to all web services

VirtualPhoneNumberRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/VirtualPhoneNumber
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 VirtualPhoneNumber:
    id: Optional[str] = None
    phone: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_cancelled: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VirtualPhoneNumberResponse:
    user_id: Optional[str] = None
    virtual_phone_number: Optional[VirtualPhoneNumber] = None


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

Python VirtualPhoneNumberRequest 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.

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

<VirtualPhoneNumberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</VirtualPhoneNumberRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VirtualPhoneNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
  <VirtualPhoneNumber>
    <DateCancelled>0001-01-01T00:00:00</DateCancelled>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Phone>String</Phone>
  </VirtualPhoneNumber>
</VirtualPhoneNumberResponse>