| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Contact/{ContactId}/lock |
|---|
"use strict";
export class Department {
/** @param {{DepartmentID?:number,DepartmentUID?:string,Name?:string,Description?:string,Code?:string,Color?:string,Budget?:number,BillingMethod?:string,CostCenter?:string,BillingContact?:string,BillingEmail?:string,ApprovalOn?:boolean,Threshold?:number,Active?:boolean,CreatedBy?:string,CreatedAt?:string,Members?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DepartmentID;
/** @type {string} */
DepartmentUID;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Code;
/** @type {string} */
Color;
/** @type {number} */
Budget;
/** @type {string} */
BillingMethod;
/** @type {string} */
CostCenter;
/** @type {string} */
BillingContact;
/** @type {string} */
BillingEmail;
/** @type {boolean} */
ApprovalOn;
/** @type {number} */
Threshold;
/** @type {boolean} */
Active;
/** @type {string} */
CreatedBy;
/** @type {string} */
CreatedAt;
/** @type {number} */
Members;
}
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,IsPlaceholder?:boolean,Skills?:string[],Departments?:Department[],BranchId?:string,BranchName?:string,UnionLocalId?:number,WorkerClassificationId?:number,SeniorityDate?:string,UnionMemberNumber?:string,VoiceConsent?:boolean,VoiceConsentAtUtc?:string,VoiceConsentSource?:string}} [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;
/** @type {boolean} */
IsPlaceholder;
/** @type {string[]} */
Skills = [];
/** @type {Department[]} */
Departments = [];
/** @type {string} */
BranchId;
/** @type {string} */
BranchName;
/** @type {?number} */
UnionLocalId;
/** @type {?number} */
WorkerClassificationId;
/** @type {?string} */
SeniorityDate;
/** @type {string} */
UnionMemberNumber;
/** @type {boolean} */
VoiceConsent;
/** @type {?string} */
VoiceConsentAtUtc;
/** @type {string} */
VoiceConsentSource;
}
export class ContactResponse {
/** @param {{ResponseStatus?:ResponseStatus,Contact?:Contact[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Contact[]} */
Contact = [];
}
export class ContactLockRequest {
/** @param {{ContactId?:number,Locked?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactId;
/** @type {boolean} */
Locked;
}
JavaScript ContactLockRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Contact/{ContactId}/lock HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ContactLockRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ContactId>0</ContactId>
<Locked>false</Locked>
</ContactLockRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Contact>
<Contact>
<Active>false</Active>
<AdditionalInformation>String</AdditionalInformation>
<AgentId>0</AgentId>
<AltPhoneLabel>String</AltPhoneLabel>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<BranchName>String</BranchName>
<BusinessName>String</BusinessName>
<Carriers>String</Carriers>
<CompanyAffiliation>String</CompanyAffiliation>
<ContactCategory>0</ContactCategory>
<ContactCategoryName>String</ContactCategoryName>
<ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
<ContactId>0</ContactId>
<ContactImage>String</ContactImage>
<ContactStatusDesc>String</ContactStatusDesc>
<ContactStatusId>0</ContactStatusId>
<ContactType>0</ContactType>
<County>String</County>
<CountyID>0</CountyID>
<DBA>String</DBA>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Deleted>false</Deleted>
<DeletedBy>String</DeletedBy>
<DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
<Department>String</Department>
<Departments>
<Department>
<Active>false</Active>
<ApprovalOn>false</ApprovalOn>
<BillingContact>String</BillingContact>
<BillingEmail>String</BillingEmail>
<BillingMethod>String</BillingMethod>
<Budget>0</Budget>
<Code>String</Code>
<Color>String</Color>
<CostCenter>String</CostCenter>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<DepartmentID>0</DepartmentID>
<DepartmentUID>00000000-0000-0000-0000-000000000000</DepartmentUID>
<Description>String</Description>
<Members>0</Members>
<Name>String</Name>
<Threshold>0</Threshold>
</Department>
</Departments>
<District>String</District>
<DistrictID>0</DistrictID>
<DoNotContact>false</DoNotContact>
<EmailPersonal>String</EmailPersonal>
<EmailWork>String</EmailWork>
<FactFinderCodeId>0</FactFinderCodeId>
<FirstName>String</FirstName>
<Flow>String</Flow>
<HasFactFinderSheet>false</HasFactFinderSheet>
<HasGiftCard>false</HasGiftCard>
<HasNBC>false</HasNBC>
<Initials>String</Initials>
<IsPlaceholder>false</IsPlaceholder>
<IsShared>false</IsShared>
<JobCount>0</JobCount>
<JobID>0</JobID>
<JobName>String</JobName>
<LastContact>0001-01-01T00:00:00</LastContact>
<LastName>String</LastName>
<Locked>false</Locked>
<LockedByAgentId>0</LockedByAgentId>
<LockedTimestamp>0001-01-01T00:00:00</LockedTimestamp>
<MaritalStatus>String</MaritalStatus>
<MiddleInitial>String</MiddleInitial>
<Name>String</Name>
<NumberOfDebtAccounts>0</NumberOfDebtAccounts>
<PeraContactId>0</PeraContactId>
<Phone>String</Phone>
<PhoneAlt>String</PhoneAlt>
<PhoneLabel>String</PhoneLabel>
<ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
<Rate>0</Rate>
<Role>String</Role>
<RoomNumber>String</RoomNumber>
<SMSOptIn>false</SMSOptIn>
<SSN>String</SSN>
<School>String</School>
<SchoolID>0</SchoolID>
<SeniorityDate>0001-01-01T00:00:00</SeniorityDate>
<Skills xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Skills>
<SourceNote>String</SourceNote>
<SourceTypeDesc>String</SourceTypeDesc>
<SourceTypeId>0</SourceTypeId>
<State>String</State>
<StateID>0</StateID>
<StateName>String</StateName>
<Tags>String</Tags>
<Title>String</Title>
<TotalDebtAmount>0</TotalDebtAmount>
<UnionLocalId>0</UnionLocalId>
<UnionMemberNumber>String</UnionMemberNumber>
<VoiceConsent>false</VoiceConsent>
<VoiceConsentAtUtc>0001-01-01T00:00:00</VoiceConsentAtUtc>
<VoiceConsentSource>String</VoiceConsentSource>
<WorkerClassificationId>0</WorkerClassificationId>
<WritingAgentId>0</WritingAgentId>
<WritingAgentName>String</WritingAgentName>
<address_city>String</address_city>
<address_line1>String</address_line1>
<address_state>String</address_state>
<address_zip>String</address_zip>
</Contact>
</Contact>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ContactResponse>