Trendsic Platform Service

<back to all web services

AvailableFactFinderCodeRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,DELETE,OPTIONS/v1/AvailableFactFinderCode/{AgentId}
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 FactFinderCode:
    id: int = 0
    agent_id: int = 0
    serial_number: int = 0
    ship_date: datetime.datetime = datetime.datetime(1, 1, 1)
    tracking_number: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    contact_id: int = 0
    assigned_date: datetime.datetime = datetime.datetime(1, 1, 1)
    agent_name: Optional[str] = None
    contact_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FactFinderCodeResponse:
    response_status: Optional[ResponseStatus] = None
    fact_finder_code: List[FactFinderCode] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableFactFinderCodeRequest:
    agent_id: int = 0
    start_code: int = 0
    end_code: int = 0
    tracking_number: Optional[str] = None
    ship_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python AvailableFactFinderCodeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/AvailableFactFinderCode/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"FactFinderCode":[{"Id":0,"AgentId":0,"SerialNumber":0,"ShipDate":"0001-01-01T00:00:00.0000000","TrackingNumber":"String","CreatedDate":"0001-01-01T00:00:00.0000000","ContactId":0,"AssignedDate":"0001-01-01T00:00:00.0000000","AgentName":"String","ContactName":"String"}]}