Trendsic Platform Service

ContactLockRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/Contact/{ContactId}/lock

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ContactLockRequest
{
    open var ContactId:Int? = null
    open var Locked:Boolean? = null
}

open class ContactResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Contact:ArrayList<Contact> = ArrayList<Contact>()
}

open class Contact
{
    open var ContactId:Int? = null
    open var ContactType:Int? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var Name:String? = null
    open var Role:String? = null
    open var Title:String? = null
    open var EmailWork:String? = null
    open var EmailPersonal:String? = null
    open var District:String? = null
    open var DistrictID:Int? = null
    open var School:String? = null
    open var SchoolID:Long? = null
    open var State:String? = null
    open var StateName:String? = null
    open var StateID:Long? = null
    open var CountyID:Long? = null
    open var County:String? = null
    open var Phone:String? = null
    open var Department:String? = null
    open var Flow:String? = null
    open var LastContact:Date? = null
    open var DoNotContact:Boolean? = null
    open var Active:Boolean? = null
    open var AgentId:Int? = null
    open var PhoneAlt:String? = null
    open var PeraContactId:Int? = null
    open var RoomNumber:String? = null
    open var SourceTypeId:Int? = null
    open var SourceTypeDesc:String? = null
    open var SourceNote:String? = null
    open var ContactStatusId:Int? = null
    open var ContactStatusDesc:String? = null
    open var SSN:String? = null
    open var DateOfBirth:Date? = null
    open var Deleted:Boolean? = null
    open var IsShared:Boolean? = null
    open var address_line1:String? = null
    open var address_city:String? = null
    open var address_state:String? = null
    open var address_zip:String? = null
    open var DeletedBy:String? = null
    open var DeletedDateTimeUtc:Date? = null
    open var HasNBC:Boolean? = null
    open var HasFactFinderSheet:Boolean? = null
    open var MiddleInitial:String? = null
    open var Tags:String? = null
    open var DateCreated:Date? = null
    open var PhoneLabel:String? = null
    open var AltPhoneLabel:String? = null
    open var Carriers:String? = null
    open var ContactImage:String? = null
    open var CompanyAffiliation:String? = null
    open var AdditionalInformation:String? = null
    open var HasGiftCard:Boolean? = null
    open var ContactCategory:Int? = null
    open var WritingAgentId:Int? = null
    open var WritingAgentName:String? = null
    open var MaritalStatus:String? = null
    open var TotalDebtAmount:BigDecimal? = null
    open var NumberOfDebtAccounts:Int? = null
    open var FactFinderCodeId:Int? = null
    open var BusinessName:String? = null
    open var DBA:String? = null
    open var ContactGUID:UUID? = null
    open var ProjectEndDate:Date? = null
    open var Rate:BigDecimal? = null
    open var JobID:Int? = null
    open var JobName:String? = null
    open var JobCount:Int? = null
    open var Locked:Boolean? = null
    open var LockedByAgentId:Int? = null
    open var LockedTimestamp:Date? = null
    open var Initials:String? = null
    open var ContactCategoryName:String? = null
    open var SMSOptIn:Boolean? = null
    open var IsPlaceholder:Boolean? = null
    open var Skills:ArrayList<String> = ArrayList<String>()
    open var Departments:ArrayList<Department> = ArrayList<Department>()
    open var BranchId:UUID? = null
    open var BranchName:String? = null
    open var UnionLocalId:Int? = null
    open var WorkerClassificationId:Int? = null
    open var SeniorityDate:Date? = null
    open var UnionMemberNumber:String? = null
    open var VoiceConsent:Boolean? = null
    open var VoiceConsentAtUtc:Date? = null
    open var VoiceConsentSource:String? = null
}

open class Department
{
    open var DepartmentID:Int? = null
    open var DepartmentUID:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var Code:String? = null
    open var Color:String? = null
    open var Budget:BigDecimal? = null
    open var BillingMethod:String? = null
    open var CostCenter:String? = null
    open var BillingContact:String? = null
    open var BillingEmail:String? = null
    open var ApprovalOn:Boolean? = null
    open var Threshold:BigDecimal? = null
    open var Active:Boolean? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var Members:Int? = null
}

Kotlin ContactLockRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactId: 0,
	Locked: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			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-01,
			Deleted: False,
			IsShared: False,
			address_line1: String,
			address_city: String,
			address_state: String,
			address_zip: String,
			DeletedBy: String,
			DeletedDateTimeUtc: 0001-01-01,
			HasNBC: False,
			HasFactFinderSheet: False,
			MiddleInitial: String,
			Tags: String,
			DateCreated: 0001-01-01,
			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-01,
			Rate: 0,
			JobID: 0,
			JobName: String,
			JobCount: 0,
			Locked: False,
			LockedByAgentId: 0,
			LockedTimestamp: 0001-01-01,
			Initials: String,
			ContactCategoryName: String,
			SMSOptIn: False,
			IsPlaceholder: False,
			Skills: 
			[
				String
			],
			Departments: 
			[
				{
					DepartmentID: 0,
					DepartmentUID: 00000000000000000000000000000000,
					Name: String,
					Description: String,
					Code: String,
					Color: String,
					Budget: 0,
					BillingMethod: String,
					CostCenter: String,
					BillingContact: String,
					BillingEmail: String,
					ApprovalOn: False,
					Threshold: 0,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					Members: 0
				}
			],
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			UnionLocalId: 0,
			WorkerClassificationId: 0,
			SeniorityDate: 0001-01-01,
			UnionMemberNumber: String,
			VoiceConsent: False,
			VoiceConsentAtUtc: 0001-01-01,
			VoiceConsentSource: String
		}
	]
}