| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator |
| GET,DELETE,POST,PUT,OPTIONS | /v1/Contact/{ContactId} | ||
|---|---|---|---|
| GET,POST,PUT,OPTIONS | /v1/Contact | ||
| GET,DELETE,POST,PUT,OPTIONS | /v1/Contact/{ContactId}/{AgentId} | ||
| GET,DELETE,POST,PUT,OPTIONS | /v1/Contact/{ContactId}/{AgentId}/{LocationId} |
export class Contact
{
public ContactId: number;
public ContactType: number;
public FirstName: string;
public LastName: string;
public Name: string;
public Role: string;
public Title: string;
public EmailWork: string;
public EmailPersonal: string;
public District: string;
public DistrictID: number;
public School: string;
public SchoolID: number;
public State: string;
public StateName: string;
public StateID: number;
public CountyID: number;
public County: string;
public Phone: string;
public Department: string;
public Flow: string;
public LastContact: string;
public DoNotContact: boolean;
public Active: boolean;
public AgentId: number;
public PhoneAlt: string;
public PeraContactId: number;
public RoomNumber: string;
public SourceTypeId: number;
public SourceTypeDesc: string;
public SourceNote: string;
public ContactStatusId: number;
public ContactStatusDesc: string;
public SSN: string;
public DateOfBirth: string;
public Deleted: boolean;
public IsShared: boolean;
public address_line1: string;
public address_city: string;
public address_state: string;
public address_zip: string;
public DeletedBy: string;
public DeletedDateTimeUtc?: string;
public HasNBC: boolean;
public HasFactFinderSheet: boolean;
public MiddleInitial: string;
public Tags: string;
public DateCreated: string;
public PhoneLabel: string;
public AltPhoneLabel: string;
public Carriers: string;
public ContactImage: string;
public CompanyAffiliation: string;
public AdditionalInformation: string;
public HasGiftCard: boolean;
public ContactCategory: number;
public WritingAgentId: number;
public WritingAgentName: string;
public MaritalStatus: string;
public TotalDebtAmount: number;
public NumberOfDebtAccounts: number;
public FactFinderCodeId: number;
public BusinessName: string;
public DBA: string;
public ContactGUID: string;
public ProjectEndDate: string;
public Rate: number;
public JobID: number;
public JobName: string;
public JobCount: number;
public Locked: boolean;
public LockedByAgentId: number;
public LockedTimestamp: string;
public Initials: string;
public ContactCategoryName: string;
public SMSOptIn: boolean;
public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}
export class ContactResponse
{
public ResponseStatus: ResponseStatus;
public Contact: Contact[] = [];
public constructor(init?: Partial<ContactResponse>) { (Object as any).assign(this, init); }
}
export class ContactRequest
{
public Contact: Contact[] = [];
public ContactId: number;
public AgentId: number;
public LocationId: string;
public constructor(init?: Partial<ContactRequest>) { (Object as any).assign(this, init); }
}
TypeScript ContactRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Contact/{ContactId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
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,"LocationId":"00000000000000000000000000000000"}
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"}},"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}]}