Bulwark Web API Service Host

<back to all web services

TextMessageRequest

Get TextMessage

The following routes are available for this service:
GET,POST/api/Vanguard/TextMessage

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/TextMessageRequest HTTP/1.1 
Host: vghost.bulwarkpestcontrol.com 
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	ActiveOnly: False,
	SId: String,
	Number: String,
	AlreadySent: False,
	SendMmsTestMessage: False,
	Employee_Id: 0,
	SendSingleBranchText: False,
	SendWelcomeText: False,
	Test: False,
	SendingEmployee_Id: 0,
	Office_Id: 0,
	EmployeesToExcludeFromBranchText: 
	[
		0
	],
	SendBranchText: False,
	Body: String,
	SpencerNielsenText: False,
	Customer_Id: 0,
	SendChocolateCakeText: False,
	SendGrmnText: False,
	SendFleaTickText: False,
	IsNc: False,
	NewRoute: False,
	NewTime: False,
	TextSent: False,
	IsFlea: False,
	DataObj: 
	[
		{
			Id: 0,
			AccountSid: String,
			ApiVersion: String,
			MessageType_Id: 0,
			Body: String,
			DateCreated: "0001-01-01T00:00:00.0000000Z",
			DateSent: "0001-01-01T00:00:00.0000000Z",
			DateUpdated: "0001-01-01T00:00:00.0000000Z",
			Direction: String,
			From: String,
			Price: 0,
			Sid: String,
			Status: String,
			To: String,
			RestException: String,
			Employee_Id: 0,
			Active: False,
			ModifiedOn: "0001-01-01T00:00:00.0000000Z"
		}
	],
	Error: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	HashedId: String,
	IsFirstText: False,
	IsThirdText: False,
	City: String,
	WeedsAdCampaignFirst: False,
	WeedsAdCampaignSecond: False,
	WeedsAdCampaignThird: False,
	AccountNumber: String,
	TermiteUpsellCampaign: False,
	IsPriceIncrease: False,
	PriceIncreaseAmount: 0,
	ChargeAfterIncrease: 0,
	OfficePhoneNumber: String,
	ChargeFrequency: String,
	IsCheckPaymentCustomerAnnouncement: False,
	Is3BMosquitoCampaign: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	ActiveOnly: False,
	SId: String,
	Number: String,
	AlreadySent: False,
	SendMmsTestMessage: False,
	Employee_Id: 0,
	SendSingleBranchText: False,
	SendWelcomeText: False,
	Test: False,
	SendingEmployee_Id: 0,
	Office_Id: 0,
	EmployeesToExcludeFromBranchText: 
	[
		0
	],
	SendBranchText: False,
	Body: String,
	SpencerNielsenText: False,
	Customer_Id: 0,
	SendChocolateCakeText: False,
	SendGrmnText: False,
	SendFleaTickText: False,
	IsNc: False,
	NewRoute: False,
	NewTime: False,
	TextSent: False,
	IsFlea: False,
	DataObj: 
	[
		{
			Id: 0,
			AccountSid: String,
			ApiVersion: String,
			MessageType_Id: 0,
			Body: String,
			DateCreated: "0001-01-01T00:00:00.0000000Z",
			DateSent: "0001-01-01T00:00:00.0000000Z",
			DateUpdated: "0001-01-01T00:00:00.0000000Z",
			Direction: String,
			From: String,
			Price: 0,
			Sid: String,
			Status: String,
			To: String,
			RestException: String,
			Employee_Id: 0,
			Active: False,
			ModifiedOn: "0001-01-01T00:00:00.0000000Z"
		}
	],
	Error: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	HashedId: String,
	IsFirstText: False,
	IsThirdText: False,
	City: String,
	WeedsAdCampaignFirst: False,
	WeedsAdCampaignSecond: False,
	WeedsAdCampaignThird: False,
	AccountNumber: String,
	TermiteUpsellCampaign: False,
	IsPriceIncrease: False,
	PriceIncreaseAmount: 0,
	ChargeAfterIncrease: 0,
	OfficePhoneNumber: String,
	ChargeFrequency: String,
	IsCheckPaymentCustomerAnnouncement: False,
	Is3BMosquitoCampaign: False
}