SimplicityCollect Web Services API

GetAccountTicklers

The following routes are available for this service:
All Verbs	/accounts/ticklers/get

**GetAccountTicklers** Parameters:
Name	Parameter	Data Type	Required
ApiToken	query	string	No
AccountId	query	string	No
ActiveTicklersOnly	query	bool	No

**GetAccountTicklersResponse** Parameters:
Name	Parameter	Data Type	Required
Status	form	string	No
Message	form	string	No
TicklerCount	form	int	No
Ticklers	form	List<Tickler>	No

**Tickler** Parameters:
Name	Parameter	Data Type	Required
ticklerId	form	string	No
caseId	form	string	No
ticklerTypeId	form	int	No
accountNum	form	string	No
collectorId	form	int	No
collectorName	form	string	No
dueDate	form	DateTime	No
dueHour	form	string	No
dueDateString	form	string	No
dueTimeString	form	string	No
completionDate	form	DateTime?	No
SnoozeUntil	form	DateTime?	No
SnoozeUntilHour	form	string	No
description	form	string	No
priority	form	int	No
enablePopup	form	bool	No
debtor	form	string	No
notes	form	string	No
repeats	form	string	No
isRepeating	form	bool	No

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetAccountTicklers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Accounts.Ticklers">
  <AccountId>String</AccountId>
  <ActiveTicklersOnly>false</ActiveTicklersOnly>
  <ApiToken>String</ApiToken>
</GetAccountTicklers>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAccountTicklersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Accounts.Ticklers">
  <Message>String</Message>
  <Status>String</Status>
  <TicklerCount>0</TicklerCount>
  <Ticklers xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Ticklers">
    <d2p1:Tickler>
      <d2p1:SnoozeUntil>0001-01-01T00:00:00</d2p1:SnoozeUntil>
      <d2p1:accountNum>String</d2p1:accountNum>
      <d2p1:caseId>String</d2p1:caseId>
      <d2p1:collectorId>0</d2p1:collectorId>
      <d2p1:collectorName>String</d2p1:collectorName>
      <d2p1:completionDate>0001-01-01T00:00:00</d2p1:completionDate>
      <d2p1:debtor>String</d2p1:debtor>
      <d2p1:description>String</d2p1:description>
      <d2p1:dueDate>0001-01-01T00:00:00</d2p1:dueDate>
      <d2p1:dueDateString>String</d2p1:dueDateString>
      <d2p1:dueHour>String</d2p1:dueHour>
      <d2p1:dueTimeString>String</d2p1:dueTimeString>
      <d2p1:enablePopup>false</d2p1:enablePopup>
      <d2p1:notes>String</d2p1:notes>
      <d2p1:priority>0</d2p1:priority>
      <d2p1:repeats>String</d2p1:repeats>
      <d2p1:ticklerId>String</d2p1:ticklerId>
      <d2p1:ticklerTypeId>0</d2p1:ticklerTypeId>
    </d2p1:Tickler>
  </Ticklers>
</GetAccountTicklersResponse>