Trendsic Platform Service

<back to all web services

ContactConnectionRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/ContactConnections/{ContactId}
"use strict";
export class Contact {
    /** @param {{ContactId?:number,ContactType?:number,FirstName?:string,LastName?:string,Name?:string,Role?:string,Title?:string,EmailWork?:string,EmailPersonal?:string,District?:string,DistrictID?:number,School?:string,SchoolID?:number,State?:string,StateName?:string,StateID?:number,CountyID?:number,County?:string,Phone?:string,Department?:string,Flow?:string,LastContact?:string,DoNotContact?:boolean,Active?:boolean,AgentId?:number,PhoneAlt?:string,PeraContactId?:number,RoomNumber?:string,SourceTypeId?:number,SourceTypeDesc?:string,SourceNote?:string,ContactStatusId?:number,ContactStatusDesc?:string,SSN?:string,DateOfBirth?:string,Deleted?:boolean,IsShared?:boolean,address_line1?:string,address_city?:string,address_state?:string,address_zip?:string,DeletedBy?:string,DeletedDateTimeUtc?:string,HasNBC?:boolean,HasFactFinderSheet?:boolean,MiddleInitial?:string,Tags?:string,DateCreated?:string,PhoneLabel?:string,AltPhoneLabel?:string,Carriers?:string,ContactImage?:string,CompanyAffiliation?:string,AdditionalInformation?:string,HasGiftCard?:boolean,ContactCategory?:number,WritingAgentId?:number,WritingAgentName?:string,MaritalStatus?:string,TotalDebtAmount?:number,NumberOfDebtAccounts?:number,FactFinderCodeId?:number,BusinessName?:string,DBA?:string,ContactGUID?:string,ProjectEndDate?:string,Rate?:number,JobID?:number,JobName?:string,JobCount?:number,Locked?:boolean,LockedByAgentId?:number,LockedTimestamp?:string,Initials?:string,ContactCategoryName?:string,SMSOptIn?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactId;
    /** @type {number} */
    ContactType;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Name;
    /** @type {string} */
    Role;
    /** @type {string} */
    Title;
    /** @type {string} */
    EmailWork;
    /** @type {string} */
    EmailPersonal;
    /** @type {string} */
    District;
    /** @type {number} */
    DistrictID;
    /** @type {string} */
    School;
    /** @type {number} */
    SchoolID;
    /** @type {string} */
    State;
    /** @type {string} */
    StateName;
    /** @type {number} */
    StateID;
    /** @type {number} */
    CountyID;
    /** @type {string} */
    County;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Department;
    /** @type {string} */
    Flow;
    /** @type {string} */
    LastContact;
    /** @type {boolean} */
    DoNotContact;
    /** @type {boolean} */
    Active;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    PhoneAlt;
    /** @type {number} */
    PeraContactId;
    /** @type {string} */
    RoomNumber;
    /** @type {number} */
    SourceTypeId;
    /** @type {string} */
    SourceTypeDesc;
    /** @type {string} */
    SourceNote;
    /** @type {number} */
    ContactStatusId;
    /** @type {string} */
    ContactStatusDesc;
    /** @type {string} */
    SSN;
    /** @type {string} */
    DateOfBirth;
    /** @type {boolean} */
    Deleted;
    /** @type {boolean} */
    IsShared;
    /** @type {string} */
    address_line1;
    /** @type {string} */
    address_city;
    /** @type {string} */
    address_state;
    /** @type {string} */
    address_zip;
    /** @type {string} */
    DeletedBy;
    /** @type {?string} */
    DeletedDateTimeUtc;
    /** @type {boolean} */
    HasNBC;
    /** @type {boolean} */
    HasFactFinderSheet;
    /** @type {string} */
    MiddleInitial;
    /** @type {string} */
    Tags;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    PhoneLabel;
    /** @type {string} */
    AltPhoneLabel;
    /** @type {string} */
    Carriers;
    /** @type {string} */
    ContactImage;
    /** @type {string} */
    CompanyAffiliation;
    /** @type {string} */
    AdditionalInformation;
    /** @type {boolean} */
    HasGiftCard;
    /** @type {number} */
    ContactCategory;
    /** @type {number} */
    WritingAgentId;
    /** @type {string} */
    WritingAgentName;
    /** @type {string} */
    MaritalStatus;
    /** @type {number} */
    TotalDebtAmount;
    /** @type {number} */
    NumberOfDebtAccounts;
    /** @type {number} */
    FactFinderCodeId;
    /** @type {string} */
    BusinessName;
    /** @type {string} */
    DBA;
    /** @type {string} */
    ContactGUID;
    /** @type {string} */
    ProjectEndDate;
    /** @type {number} */
    Rate;
    /** @type {number} */
    JobID;
    /** @type {string} */
    JobName;
    /** @type {number} */
    JobCount;
    /** @type {boolean} */
    Locked;
    /** @type {number} */
    LockedByAgentId;
    /** @type {string} */
    LockedTimestamp;
    /** @type {string} */
    Initials;
    /** @type {string} */
    ContactCategoryName;
    /** @type {boolean} */
    SMSOptIn;
}
export class ContactResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Contact?:Contact[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Contact[]} */
    Contact = [];
}
export class ContactConnectionRequest {
    /** @param {{Contact?:Contact[],ContactId?:number,AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Contact[]} */
    Contact = [];
    /** @type {number} */
    ContactId;
    /** @type {number} */
    AgentId;
}

JavaScript ContactConnectionRequest 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/ContactConnections/{ContactId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Contact":[{"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}],"ContactId":0,"AgentId":0}

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"}},"Contact":[{"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}]}