Trendsic Platform Service

<back to all web services

ContactGUIDRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,DELETE,POST,PUT,OPTIONS/v1/ContactGUID/{ContactGUID}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Contact
            Public Overridable Property ContactId As Integer
            Public Overridable Property ContactType As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Name As String
            Public Overridable Property Role As String
            Public Overridable Property Title As String
            Public Overridable Property EmailWork As String
            Public Overridable Property EmailPersonal As String
            Public Overridable Property District As String
            Public Overridable Property DistrictID As Integer
            Public Overridable Property School As String
            Public Overridable Property SchoolID As Long
            Public Overridable Property State As String
            Public Overridable Property StateName As String
            Public Overridable Property StateID As Long
            Public Overridable Property CountyID As Long
            Public Overridable Property County As String
            Public Overridable Property Phone As String
            Public Overridable Property Department As String
            Public Overridable Property Flow As String
            Public Overridable Property LastContact As Date
            Public Overridable Property DoNotContact As Boolean
            Public Overridable Property Active As Boolean
            Public Overridable Property AgentId As Integer
            Public Overridable Property PhoneAlt As String
            Public Overridable Property PeraContactId As Integer
            Public Overridable Property RoomNumber As String
            Public Overridable Property SourceTypeId As Integer
            Public Overridable Property SourceTypeDesc As String
            Public Overridable Property SourceNote As String
            Public Overridable Property ContactStatusId As Integer
            Public Overridable Property ContactStatusDesc As String
            Public Overridable Property SSN As String
            Public Overridable Property DateOfBirth As Date
            Public Overridable Property Deleted As Boolean
            Public Overridable Property IsShared As Boolean
            Public Overridable Property address_line1 As String
            Public Overridable Property address_city As String
            Public Overridable Property address_state As String
            Public Overridable Property address_zip As String
            Public Overridable Property DeletedBy As String
            Public Overridable Property DeletedDateTimeUtc As Date?
            Public Overridable Property HasNBC As Boolean
            Public Overridable Property HasFactFinderSheet As Boolean
            Public Overridable Property MiddleInitial As String
            Public Overridable Property Tags As String
            Public Overridable Property DateCreated As Date
            Public Overridable Property PhoneLabel As String
            Public Overridable Property AltPhoneLabel As String
            Public Overridable Property Carriers As String
            Public Overridable Property ContactImage As String
            Public Overridable Property CompanyAffiliation As String
            Public Overridable Property AdditionalInformation As String
            Public Overridable Property HasGiftCard As Boolean
            Public Overridable Property ContactCategory As Integer
            Public Overridable Property WritingAgentId As Integer
            Public Overridable Property WritingAgentName As String
            Public Overridable Property MaritalStatus As String
            Public Overridable Property TotalDebtAmount As Decimal
            Public Overridable Property NumberOfDebtAccounts As Integer
            Public Overridable Property FactFinderCodeId As Integer
            Public Overridable Property BusinessName As String
            Public Overridable Property DBA As String
            Public Overridable Property ContactGUID As Guid
            Public Overridable Property ProjectEndDate As Date
            Public Overridable Property Rate As Integer
            Public Overridable Property JobID As Integer
            Public Overridable Property JobName As String
            Public Overridable Property JobCount As Integer
            Public Overridable Property Locked As Boolean
            Public Overridable Property LockedByAgentId As Integer
            Public Overridable Property LockedTimestamp As Date
            Public Overridable Property Initials As String
            Public Overridable Property ContactCategoryName As String
            Public Overridable Property SMSOptIn As Boolean
        End Class

        Public Partial Class ContactGUIDRequest
            Public Overridable Property ContactGUID As Guid
        End Class

        Public Partial Class ContactResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Contact As List(Of Contact) = New List(Of Contact)
        End Class
    End Namespace
End Namespace

VB.NET ContactGUIDRequest 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/ContactGUID/{ContactGUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactGUID: 00000000000000000000000000000000
}
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
		}
	]
}