Trendsic Platform Service

<back to all web services

CrewMembersRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Crew/Members
GET,POST,PUT,DELETE,OPTIONS/v1/Crew/Members/{CrewID]
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class Contact implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ContactId=0,
        /** @var int */
        public int $ContactType=0,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Role=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $EmailWork=null,
        /** @var string|null */
        public ?string $EmailPersonal=null,
        /** @var string|null */
        public ?string $District=null,
        /** @var int */
        public int $DistrictID=0,
        /** @var string|null */
        public ?string $School=null,
        /** @var int */
        public int $SchoolID=0,
        /** @var string|null */
        public ?string $State=null,
        /** @var string|null */
        public ?string $StateName=null,
        /** @var int */
        public int $StateID=0,
        /** @var int */
        public int $CountyID=0,
        /** @var string|null */
        public ?string $County=null,
        /** @var string|null */
        public ?string $Phone=null,
        /** @var string|null */
        public ?string $Department=null,
        /** @var string|null */
        public ?string $Flow=null,
        /** @var DateTime */
        public DateTime $LastContact=new DateTime(),
        /** @var bool|null */
        public ?bool $DoNotContact=null,
        /** @var bool|null */
        public ?bool $Active=null,
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $PhoneAlt=null,
        /** @var int */
        public int $PeraContactId=0,
        /** @var string|null */
        public ?string $RoomNumber=null,
        /** @var int */
        public int $SourceTypeId=0,
        /** @var string|null */
        public ?string $SourceTypeDesc=null,
        /** @var string|null */
        public ?string $SourceNote=null,
        /** @var int */
        public int $ContactStatusId=0,
        /** @var string|null */
        public ?string $ContactStatusDesc=null,
        /** @var string|null */
        public ?string $SSN=null,
        /** @var DateTime */
        public DateTime $DateOfBirth=new DateTime(),
        /** @var bool|null */
        public ?bool $Deleted=null,
        /** @var bool|null */
        public ?bool $IsShared=null,
        /** @var string|null */
        public ?string $address_line1=null,
        /** @var string|null */
        public ?string $address_city=null,
        /** @var string|null */
        public ?string $address_state=null,
        /** @var string|null */
        public ?string $address_zip=null,
        /** @var string|null */
        public ?string $DeletedBy=null,
        /** @var DateTime|null */
        public ?DateTime $DeletedDateTimeUtc=null,
        /** @var bool|null */
        public ?bool $HasNBC=null,
        /** @var bool|null */
        public ?bool $HasFactFinderSheet=null,
        /** @var string|null */
        public ?string $MiddleInitial=null,
        /** @var string|null */
        public ?string $Tags=null,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var string|null */
        public ?string $PhoneLabel=null,
        /** @var string|null */
        public ?string $AltPhoneLabel=null,
        /** @var string|null */
        public ?string $Carriers=null,
        /** @var string|null */
        public ?string $ContactImage=null,
        /** @var string|null */
        public ?string $CompanyAffiliation=null,
        /** @var string|null */
        public ?string $AdditionalInformation=null,
        /** @var bool|null */
        public ?bool $HasGiftCard=null,
        /** @var int */
        public int $ContactCategory=0,
        /** @var int */
        public int $WritingAgentId=0,
        /** @var string|null */
        public ?string $WritingAgentName=null,
        /** @var string|null */
        public ?string $MaritalStatus=null,
        /** @var float */
        public float $TotalDebtAmount=0.0,
        /** @var int */
        public int $NumberOfDebtAccounts=0,
        /** @var int */
        public int $FactFinderCodeId=0,
        /** @var string|null */
        public ?string $BusinessName=null,
        /** @var string|null */
        public ?string $DBA=null,
        /** @var string */
        public string $ContactGUID='',
        /** @var DateTime */
        public DateTime $ProjectEndDate=new DateTime(),
        /** @var int */
        public int $Rate=0,
        /** @var int */
        public int $JobID=0,
        /** @var string|null */
        public ?string $JobName=null,
        /** @var int */
        public int $JobCount=0,
        /** @var bool|null */
        public ?bool $Locked=null,
        /** @var int */
        public int $LockedByAgentId=0,
        /** @var DateTime */
        public DateTime $LockedTimestamp=new DateTime(),
        /** @var string|null */
        public ?string $Initials=null,
        /** @var string|null */
        public ?string $ContactCategoryName=null,
        /** @var bool|null */
        public ?bool $SMSOptIn=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
        if (isset($o['ContactType'])) $this->ContactType = $o['ContactType'];
        if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Role'])) $this->Role = $o['Role'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['EmailWork'])) $this->EmailWork = $o['EmailWork'];
        if (isset($o['EmailPersonal'])) $this->EmailPersonal = $o['EmailPersonal'];
        if (isset($o['District'])) $this->District = $o['District'];
        if (isset($o['DistrictID'])) $this->DistrictID = $o['DistrictID'];
        if (isset($o['School'])) $this->School = $o['School'];
        if (isset($o['SchoolID'])) $this->SchoolID = $o['SchoolID'];
        if (isset($o['State'])) $this->State = $o['State'];
        if (isset($o['StateName'])) $this->StateName = $o['StateName'];
        if (isset($o['StateID'])) $this->StateID = $o['StateID'];
        if (isset($o['CountyID'])) $this->CountyID = $o['CountyID'];
        if (isset($o['County'])) $this->County = $o['County'];
        if (isset($o['Phone'])) $this->Phone = $o['Phone'];
        if (isset($o['Department'])) $this->Department = $o['Department'];
        if (isset($o['Flow'])) $this->Flow = $o['Flow'];
        if (isset($o['LastContact'])) $this->LastContact = JsonConverters::from('DateTime', $o['LastContact']);
        if (isset($o['DoNotContact'])) $this->DoNotContact = $o['DoNotContact'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['PhoneAlt'])) $this->PhoneAlt = $o['PhoneAlt'];
        if (isset($o['PeraContactId'])) $this->PeraContactId = $o['PeraContactId'];
        if (isset($o['RoomNumber'])) $this->RoomNumber = $o['RoomNumber'];
        if (isset($o['SourceTypeId'])) $this->SourceTypeId = $o['SourceTypeId'];
        if (isset($o['SourceTypeDesc'])) $this->SourceTypeDesc = $o['SourceTypeDesc'];
        if (isset($o['SourceNote'])) $this->SourceNote = $o['SourceNote'];
        if (isset($o['ContactStatusId'])) $this->ContactStatusId = $o['ContactStatusId'];
        if (isset($o['ContactStatusDesc'])) $this->ContactStatusDesc = $o['ContactStatusDesc'];
        if (isset($o['SSN'])) $this->SSN = $o['SSN'];
        if (isset($o['DateOfBirth'])) $this->DateOfBirth = JsonConverters::from('DateTime', $o['DateOfBirth']);
        if (isset($o['Deleted'])) $this->Deleted = $o['Deleted'];
        if (isset($o['IsShared'])) $this->IsShared = $o['IsShared'];
        if (isset($o['address_line1'])) $this->address_line1 = $o['address_line1'];
        if (isset($o['address_city'])) $this->address_city = $o['address_city'];
        if (isset($o['address_state'])) $this->address_state = $o['address_state'];
        if (isset($o['address_zip'])) $this->address_zip = $o['address_zip'];
        if (isset($o['DeletedBy'])) $this->DeletedBy = $o['DeletedBy'];
        if (isset($o['DeletedDateTimeUtc'])) $this->DeletedDateTimeUtc = JsonConverters::from('DateTime', $o['DeletedDateTimeUtc']);
        if (isset($o['HasNBC'])) $this->HasNBC = $o['HasNBC'];
        if (isset($o['HasFactFinderSheet'])) $this->HasFactFinderSheet = $o['HasFactFinderSheet'];
        if (isset($o['MiddleInitial'])) $this->MiddleInitial = $o['MiddleInitial'];
        if (isset($o['Tags'])) $this->Tags = $o['Tags'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['PhoneLabel'])) $this->PhoneLabel = $o['PhoneLabel'];
        if (isset($o['AltPhoneLabel'])) $this->AltPhoneLabel = $o['AltPhoneLabel'];
        if (isset($o['Carriers'])) $this->Carriers = $o['Carriers'];
        if (isset($o['ContactImage'])) $this->ContactImage = $o['ContactImage'];
        if (isset($o['CompanyAffiliation'])) $this->CompanyAffiliation = $o['CompanyAffiliation'];
        if (isset($o['AdditionalInformation'])) $this->AdditionalInformation = $o['AdditionalInformation'];
        if (isset($o['HasGiftCard'])) $this->HasGiftCard = $o['HasGiftCard'];
        if (isset($o['ContactCategory'])) $this->ContactCategory = $o['ContactCategory'];
        if (isset($o['WritingAgentId'])) $this->WritingAgentId = $o['WritingAgentId'];
        if (isset($o['WritingAgentName'])) $this->WritingAgentName = $o['WritingAgentName'];
        if (isset($o['MaritalStatus'])) $this->MaritalStatus = $o['MaritalStatus'];
        if (isset($o['TotalDebtAmount'])) $this->TotalDebtAmount = $o['TotalDebtAmount'];
        if (isset($o['NumberOfDebtAccounts'])) $this->NumberOfDebtAccounts = $o['NumberOfDebtAccounts'];
        if (isset($o['FactFinderCodeId'])) $this->FactFinderCodeId = $o['FactFinderCodeId'];
        if (isset($o['BusinessName'])) $this->BusinessName = $o['BusinessName'];
        if (isset($o['DBA'])) $this->DBA = $o['DBA'];
        if (isset($o['ContactGUID'])) $this->ContactGUID = $o['ContactGUID'];
        if (isset($o['ProjectEndDate'])) $this->ProjectEndDate = JsonConverters::from('DateTime', $o['ProjectEndDate']);
        if (isset($o['Rate'])) $this->Rate = $o['Rate'];
        if (isset($o['JobID'])) $this->JobID = $o['JobID'];
        if (isset($o['JobName'])) $this->JobName = $o['JobName'];
        if (isset($o['JobCount'])) $this->JobCount = $o['JobCount'];
        if (isset($o['Locked'])) $this->Locked = $o['Locked'];
        if (isset($o['LockedByAgentId'])) $this->LockedByAgentId = $o['LockedByAgentId'];
        if (isset($o['LockedTimestamp'])) $this->LockedTimestamp = JsonConverters::from('DateTime', $o['LockedTimestamp']);
        if (isset($o['Initials'])) $this->Initials = $o['Initials'];
        if (isset($o['ContactCategoryName'])) $this->ContactCategoryName = $o['ContactCategoryName'];
        if (isset($o['SMSOptIn'])) $this->SMSOptIn = $o['SMSOptIn'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
        if (isset($this->ContactType)) $o['ContactType'] = $this->ContactType;
        if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Role)) $o['Role'] = $this->Role;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->EmailWork)) $o['EmailWork'] = $this->EmailWork;
        if (isset($this->EmailPersonal)) $o['EmailPersonal'] = $this->EmailPersonal;
        if (isset($this->District)) $o['District'] = $this->District;
        if (isset($this->DistrictID)) $o['DistrictID'] = $this->DistrictID;
        if (isset($this->School)) $o['School'] = $this->School;
        if (isset($this->SchoolID)) $o['SchoolID'] = $this->SchoolID;
        if (isset($this->State)) $o['State'] = $this->State;
        if (isset($this->StateName)) $o['StateName'] = $this->StateName;
        if (isset($this->StateID)) $o['StateID'] = $this->StateID;
        if (isset($this->CountyID)) $o['CountyID'] = $this->CountyID;
        if (isset($this->County)) $o['County'] = $this->County;
        if (isset($this->Phone)) $o['Phone'] = $this->Phone;
        if (isset($this->Department)) $o['Department'] = $this->Department;
        if (isset($this->Flow)) $o['Flow'] = $this->Flow;
        if (isset($this->LastContact)) $o['LastContact'] = JsonConverters::to('DateTime', $this->LastContact);
        if (isset($this->DoNotContact)) $o['DoNotContact'] = $this->DoNotContact;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->PhoneAlt)) $o['PhoneAlt'] = $this->PhoneAlt;
        if (isset($this->PeraContactId)) $o['PeraContactId'] = $this->PeraContactId;
        if (isset($this->RoomNumber)) $o['RoomNumber'] = $this->RoomNumber;
        if (isset($this->SourceTypeId)) $o['SourceTypeId'] = $this->SourceTypeId;
        if (isset($this->SourceTypeDesc)) $o['SourceTypeDesc'] = $this->SourceTypeDesc;
        if (isset($this->SourceNote)) $o['SourceNote'] = $this->SourceNote;
        if (isset($this->ContactStatusId)) $o['ContactStatusId'] = $this->ContactStatusId;
        if (isset($this->ContactStatusDesc)) $o['ContactStatusDesc'] = $this->ContactStatusDesc;
        if (isset($this->SSN)) $o['SSN'] = $this->SSN;
        if (isset($this->DateOfBirth)) $o['DateOfBirth'] = JsonConverters::to('DateTime', $this->DateOfBirth);
        if (isset($this->Deleted)) $o['Deleted'] = $this->Deleted;
        if (isset($this->IsShared)) $o['IsShared'] = $this->IsShared;
        if (isset($this->address_line1)) $o['address_line1'] = $this->address_line1;
        if (isset($this->address_city)) $o['address_city'] = $this->address_city;
        if (isset($this->address_state)) $o['address_state'] = $this->address_state;
        if (isset($this->address_zip)) $o['address_zip'] = $this->address_zip;
        if (isset($this->DeletedBy)) $o['DeletedBy'] = $this->DeletedBy;
        if (isset($this->DeletedDateTimeUtc)) $o['DeletedDateTimeUtc'] = JsonConverters::to('DateTime', $this->DeletedDateTimeUtc);
        if (isset($this->HasNBC)) $o['HasNBC'] = $this->HasNBC;
        if (isset($this->HasFactFinderSheet)) $o['HasFactFinderSheet'] = $this->HasFactFinderSheet;
        if (isset($this->MiddleInitial)) $o['MiddleInitial'] = $this->MiddleInitial;
        if (isset($this->Tags)) $o['Tags'] = $this->Tags;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->PhoneLabel)) $o['PhoneLabel'] = $this->PhoneLabel;
        if (isset($this->AltPhoneLabel)) $o['AltPhoneLabel'] = $this->AltPhoneLabel;
        if (isset($this->Carriers)) $o['Carriers'] = $this->Carriers;
        if (isset($this->ContactImage)) $o['ContactImage'] = $this->ContactImage;
        if (isset($this->CompanyAffiliation)) $o['CompanyAffiliation'] = $this->CompanyAffiliation;
        if (isset($this->AdditionalInformation)) $o['AdditionalInformation'] = $this->AdditionalInformation;
        if (isset($this->HasGiftCard)) $o['HasGiftCard'] = $this->HasGiftCard;
        if (isset($this->ContactCategory)) $o['ContactCategory'] = $this->ContactCategory;
        if (isset($this->WritingAgentId)) $o['WritingAgentId'] = $this->WritingAgentId;
        if (isset($this->WritingAgentName)) $o['WritingAgentName'] = $this->WritingAgentName;
        if (isset($this->MaritalStatus)) $o['MaritalStatus'] = $this->MaritalStatus;
        if (isset($this->TotalDebtAmount)) $o['TotalDebtAmount'] = $this->TotalDebtAmount;
        if (isset($this->NumberOfDebtAccounts)) $o['NumberOfDebtAccounts'] = $this->NumberOfDebtAccounts;
        if (isset($this->FactFinderCodeId)) $o['FactFinderCodeId'] = $this->FactFinderCodeId;
        if (isset($this->BusinessName)) $o['BusinessName'] = $this->BusinessName;
        if (isset($this->DBA)) $o['DBA'] = $this->DBA;
        if (isset($this->ContactGUID)) $o['ContactGUID'] = $this->ContactGUID;
        if (isset($this->ProjectEndDate)) $o['ProjectEndDate'] = JsonConverters::to('DateTime', $this->ProjectEndDate);
        if (isset($this->Rate)) $o['Rate'] = $this->Rate;
        if (isset($this->JobID)) $o['JobID'] = $this->JobID;
        if (isset($this->JobName)) $o['JobName'] = $this->JobName;
        if (isset($this->JobCount)) $o['JobCount'] = $this->JobCount;
        if (isset($this->Locked)) $o['Locked'] = $this->Locked;
        if (isset($this->LockedByAgentId)) $o['LockedByAgentId'] = $this->LockedByAgentId;
        if (isset($this->LockedTimestamp)) $o['LockedTimestamp'] = JsonConverters::to('DateTime', $this->LockedTimestamp);
        if (isset($this->Initials)) $o['Initials'] = $this->Initials;
        if (isset($this->ContactCategoryName)) $o['ContactCategoryName'] = $this->ContactCategoryName;
        if (isset($this->SMSOptIn)) $o['SMSOptIn'] = $this->SMSOptIn;
        return empty($o) ? new class(){} : $o;
    }
}

class CrewMembersResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<Contact>|null */
        public ?array $CrewMembers=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['CrewMembers'])) $this->CrewMembers = JsonConverters::fromArray('Contact', $o['CrewMembers']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->CrewMembers)) $o['CrewMembers'] = JsonConverters::toArray('Contact', $this->CrewMembers);
        return empty($o) ? new class(){} : $o;
    }
}

class CrewMembersRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CrewID=0,
        /** @var string|null */
        public ?string $Tags=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CrewID'])) $this->CrewID = $o['CrewID'];
        if (isset($o['Tags'])) $this->Tags = $o['Tags'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CrewID)) $o['CrewID'] = $this->CrewID;
        if (isset($this->Tags)) $o['Tags'] = $this->Tags;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CrewMembersRequest DTOs

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

HTTP + OTHER

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

POST /v1/Crew/Members HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CrewID":0,"Tags":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"CrewMembers":[{"ContactId":0,"ContactType":0,"FirstName":"String","LastName":"String","Name":"String","Role":"String","Title":"String","EmailWork":"String","EmailPersonal":"String","District":"String","DistrictID":0,"School":"String","SchoolID":0,"State":"String","StateName":"String","StateID":0,"CountyID":0,"County":"String","Phone":"String","Department":"String","Flow":"String","LastContact":"0001-01-01T00:00:00.0000000","DoNotContact":false,"Active":false,"AgentId":0,"PhoneAlt":"String","PeraContactId":0,"RoomNumber":"String","SourceTypeId":0,"SourceTypeDesc":"String","SourceNote":"String","ContactStatusId":0,"ContactStatusDesc":"String","SSN":"String","DateOfBirth":"0001-01-01T00:00:00.0000000","Deleted":false,"IsShared":false,"address_line1":"String","address_city":"String","address_state":"String","address_zip":"String","DeletedBy":"String","DeletedDateTimeUtc":"0001-01-01T00:00:00.0000000","HasNBC":false,"HasFactFinderSheet":false,"MiddleInitial":"String","Tags":"String","DateCreated":"0001-01-01T00:00:00.0000000","PhoneLabel":"String","AltPhoneLabel":"String","Carriers":"String","ContactImage":"String","CompanyAffiliation":"String","AdditionalInformation":"String","HasGiftCard":false,"ContactCategory":0,"WritingAgentId":0,"WritingAgentName":"String","MaritalStatus":"String","TotalDebtAmount":0,"NumberOfDebtAccounts":0,"FactFinderCodeId":0,"BusinessName":"String","DBA":"String","ContactGUID":"00000000000000000000000000000000","ProjectEndDate":"0001-01-01T00:00:00.0000000","Rate":0,"JobID":0,"JobName":"String","JobCount":0,"Locked":false,"LockedByAgentId":0,"LockedTimestamp":"0001-01-01T00:00:00.0000000","Initials":"String","ContactCategoryName":"String","SMSOptIn":false}]}