Bombshell Agency Platform Service

<back to all web services

ContactRequest

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Contact
GET,DELETE,POST,PUT,OPTIONS/v1/Contact/{ContactId}
GET,DELETE,POST,PUT,OPTIONS/v1/Contact/{ContactId}/{AgentId}

To override the Content-type in your clients 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 /jsv/reply/ContactRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: text/jsv
Content-Length: length

{
	Contact: 
	[
		{
			ContactId: 0,
			ContactType: 0,
			FirstName: String,
			LastName: 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,
			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,
			SharedWithAgent: String,
			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,
			ModifiedByUserId: 00000000000000000000000000000000,
			ModifiedDate: 0001-01-01,
			ModifiedAction: String,
			SourceOfModification: String,
			FactFinderCodeId: 0,
			ContactGUID: 00000000000000000000000000000000,
			Licensed: False,
			OutstandContactId: 0,
			Licenses: 
			[
				{
					Id: 0,
					AgentId: 0,
					ContactId: 0,
					AgentRegistrationTempId: 0,
					LicenseTypeId: 0,
					SecurityLicenseTypeId: 0,
					LicenseTypeName: String,
					SecuritiesLicenseTypeName: String,
					LicenseState: String,
					LicenseNumber: String,
					Temporary: False,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					DateAcquired: 0001-01-01,
					ExpirationDate: 0001-01-01,
					IsResident: False
				}
			],
			ActivityIds: 
			[
				0
			],
			Policies: {},
			TagList: {},
			NextAppointmentDate: 0001-01-01
		}
	],
	ContactId: 0,
	OutstandContactId: 0,
	AgentId: 0
}
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
			}
		]
	},
	Contact: 
	[
		{
			ContactId: 0,
			ContactType: 0,
			FirstName: String,
			LastName: 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,
			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,
			SharedWithAgent: String,
			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,
			ModifiedByUserId: 00000000000000000000000000000000,
			ModifiedDate: 0001-01-01,
			ModifiedAction: String,
			SourceOfModification: String,
			FactFinderCodeId: 0,
			ContactGUID: 00000000000000000000000000000000,
			Licensed: False,
			OutstandContactId: 0,
			Licenses: 
			[
				{
					Id: 0,
					AgentId: 0,
					ContactId: 0,
					AgentRegistrationTempId: 0,
					LicenseTypeId: 0,
					SecurityLicenseTypeId: 0,
					LicenseTypeName: String,
					SecuritiesLicenseTypeName: String,
					LicenseState: String,
					LicenseNumber: String,
					Temporary: False,
					DateCreated: 0001-01-01,
					DateModified: 0001-01-01,
					DateAcquired: 0001-01-01,
					ExpirationDate: 0001-01-01,
					IsResident: False
				}
			],
			ActivityIds: 
			[
				0
			],
			Policies: {},
			TagList: {},
			NextAppointmentDate: 0001-01-01
		}
	]
}