SimplicityCollect Web Services API

<back to all web services

GetAccountTicklers

The following routes are available for this service:
All Verbs/accounts/ticklers/get
GetAccountTicklers Parameters:
NameParameterData TypeRequiredDescription
ApiTokenquerystringNo
AccountIdquerystringNo
ActiveTicklersOnlyqueryboolNo
GetAccountTicklersResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
MessageformstringNo
TicklerCountformintNo
TicklersformList<Tickler>No
Tickler Parameters:
NameParameterData TypeRequiredDescription
ticklerIdformstringNo
caseIdformstringNo
ticklerTypeIdformintNo
accountNumformstringNo
collectorIdformintNo
collectorNameformstringNo
dueDateformDateTimeNo
dueHourformstringNo
dueDateStringformstringNo
dueTimeStringformstringNo
completionDateformDateTime?No
SnoozeUntilformDateTime?No
SnoozeUntilHourformstringNo
descriptionformstringNo
priorityformintNo
enablePopupformboolNo
debtorformstringNo
notesformstringNo
repeatsformstringNo
isRepeatingformboolNo

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 /accounts/ticklers/get HTTP/1.1 
Host: app.simplicitycollect.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiToken: String,
	AccountId: String,
	ActiveTicklersOnly: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: String,
	Message: String,
	TicklerCount: 0,
	Ticklers: 
	[
		{
			ticklerId: String,
			caseId: String,
			ticklerTypeId: 0,
			accountNum: String,
			collectorId: 0,
			collectorName: String,
			dueDate: 0001-01-01,
			dueHour: String,
			dueDateString: String,
			dueTimeString: String,
			completionDate: 0001-01-01,
			SnoozeUntil: 0001-01-01,
			SnoozeUntilHour: 0,
			description: String,
			priority: 0,
			enablePopup: False,
			debtor: String,
			notes: String,
			repeats: String,
			isRepeating: True
		}
	]
}