Client
WinDeed interface to supply search functionality. This interface requires a valid WinDeed account. If you do not have a valid WinDeed account you should please contact WinDeed support at support@windeed.co.za to arrange for an account.
The following operations are supported. For a formal definition, please review the Service Description.
- AcceptEula
-
Authenticate
This method is used to validate a user's login credentials. -
AuthenticateBillingModelImpersonatorUserAndCreateToken
Authenticates the user and if successful, creates a new user authentication token. -
AuthenticateUserAndCreateNewToken
Authenticates the user and if successful, generates a new, independent token. -
AuthenticateUserAndCreateToken
Authenticates the user and if successful, creates a new user authentication token. -
AuthenticateUserAndUpdateToken
Authenticates the user and if successful, updates the password of the existing user authentication token. -
AvailableDocuments
Use this method to check for available Deeds Document copies. - BilledSearches
- BilledSearchesCsv
- CanCompanySeeSearch
- CanOfflineCompanySeeSearch
- ChangePassword
-
CheckCredentials
This method is used to validate a user's login credentials returning Valid, Invalid, Disabled Company or Disabled User -
CheckDeedsOfficeStatus
This method returns a value indicating whether the Deeds Office is currently offline. In the event of the Deeds Office being offline clients can set their Deeds Office requests to Offline mode to ensure uninterrupted Deeds Office searching. - CheckPermissionsByRequestId
- CheckPermissionsForAtLeastOneProduct
- CheckPermissionsForSingleProduct
- ClearUsersFromCache
- CompanyHiddenSearches
-
DeedsOfficeAcceptsDocumentRequests
This method returns a boolean value which indicates whether the Deeds Office passed to the method accepts Document Copy requests. - DefaultRegistrar
-
DocumentPageCount
Use this method to check the number of pages a Deeds Office document will be. -
DocumentsAvailable
Use this method to check for available Deeds Document copies. - DownloadCompletePriceList
- DownloadEula
- DownloadPriceList
- DownloadProductPrices
- DownloadProductPricesSafe
- DownloadProductPricesWithBillTypeIds
- DownloadTransUnionDefaultPriceList
- DownloadTransUnionPriceList
- DownloadTransUnionPriceListWithProductIds
-
GenerateDotsProgressPNG
This method returns the byte array for the progress of a DOTS search. - GetBillableSearchDescription
- GetCompanyCreditInformation
-
GetDocumentCopiesByPage
This method gets the document copy details for a particular page. -
GetDocumentInclusionList
This method will return the document inclusion list -
GetLast12Periods
This method will return the last 12 periods - GetResponseTypeByReference
- GetSearchInsureSubjectDescription
- GetSearchInsureUpdates
- GetVatFactor
-
HistoricSearchesFilteredPage
Retrieves the search on a page for the current filter -
HistoricSearchesFilteredPageCount
Retrieves the number of pages for the current filter -
HistoricSearchesFilteredPageSingleResponse
Retrieves the search on a page for the current filter, returns a response -
HistoricSearchesFilteredPageSingleResponseWithResponseTypeIds
Retrieves the search on a page for the current filter, returns a response -
HistoricSearchesForMobile
Retrieves the search on a page for the current filter -
HistoricSearchesPage
Retrieves the search on a page for the current filter -
HistoricSearchesPageCount
Retrieves the number of pages for the current filter -
HistoricSearchesPageSingleResponse
Retrieves the search on a page for the current filter, returns a response - IsSearchMonitoringActive
-
IsSupplierOnline
Checks whether a specified supplier is online or not - LoadCampaignDates
- LoadUser
- LoggedOutCompanyHiddenSearches
-
MarkDocumentCopyDeleted
Use this method to mark a document request as deleted. request is still in the DB. -
MarkUserAuthenticationTokenForDeletion
This method should be called when a user is being redirected from the old to new windeed url. -
OctopusVersion
Return the execution folder and consequently the octopus version - PasswordActivationKeyIsValid
-
Ping
This method returns the string 'Pong'. It can be used to test the responsiveness of the WinDeed server. -
PingAuthenticated
This method returns the string 'Authenticated pong'. It can be used to test the responsiveness of the WinDeed server. -
PlaceDocumentRequest
This method accepts BaseDocumentCopyRequest objects. Use this method to request Deeds Document copies. -
RemoveUserAuthenticationToken
This method should be called when a user is logged off the WinDeed search site whilst using token credentials. - RequestBilledSearchCost
- RequestPasswordChange
- RequestPasswordChangeByClient
- RequestPrintout
-
RequestedDeedsDocumentStatuses
Use this method to find out what a requested deeds document's status is for each format. -
RequestedDeedsDocuments
Use this method to check for requested Deeds Office Document copies. -
RequestedJudgmentCopies
Use this method to check for requested Judgment Copies. -
RequestedSurveyorGeneralDiagrams
Use this method to check for requested Surveyor General diagrams. - ResetPassword
-
RetrieveBillsearchDescriptions
This method retrieves the search descriptions for the specified search reference numbers. -
RetrieveDisabledEnquiryReasons
This method returns a list of disabled enquiry reasons. -
RetrieveDisabledTpnEnquiryReasons
This method returns a list of disabled TPN enquiry reasons. -
RetrieveDisputeNotes
This method returns a list of dispute notes. -
RetrieveDocuments
Use this method to download Deeds Document copies. -
RetrieveEnquiryReasons
This method returns a list of enquiry reasons. -
RetrieveInoxicoJudgmentDocuments
Use this method to download Judgment Copies. -
RetrieveLists
This method accept a Nullableas parameter which is the current version of the client's lists. It will return a list of new and deleted items. -
RetrievePrescribedPurposeEnquiryReasons
This method returns a list of Presribed Purpose enquiry reasons. -
RetrieveSurveyorGeneralDiagrams
Use this method to download Surveyor General diagrams. -
RetrieveTpnEnquiryReasons
This method returns a list of TPN enquiry reasons. -
RetrieveUserCompanyResponses
Retrieves the search on a page for the current filter, returns a response - RetrieveUserDetails
-
RetrieveVccbEnquiryReasons
This method returns a list of VCCB enquiry reasons. - SearchInsureSearchSuccessful
-
SetDeedsOfficeStatus
This method set a value indicating whether the Deeds Office is currently offline. In the event of the Deeds Office being offline clients can set their Deeds Office requests to Offline mode to ensure uninterrupted Deeds Office searching. - SetPassword
- SetPasswordReturnUserId
- SetResponsiveSearchInsureState
-
SetSupplierStatus
Sets the online status for a specified supplier - ToggleSearchWarnings
- UpdateUserDetails
- UsedCredit
- UserHasAcceptedEula
-
Version
This method returns the version of the Engine.