Click or drag to resize
WebCrmApi Methods

The WebCrmApi type exposes the following members.

Methods
  NameDescription
Public methodCode exampleAuthenticate
Verifies webCRM credentials. The authentication is automatically expired in 20 minutes if there is no activity.
Public methodCode exampleChangeOrganisationForOpportunity
Change organisation ID for opportunity.
Public methodCode exampleDeleteLinkedData
Deletes all linked data for the specified entity type.
Public methodCode exampleDeletePossibleQuotations
Deletes all possible quotations.
Public methodCode exampleDeleteQuotation
Deletes one or all quotation lines for a specific Opportunity.
Public methodCode exampleDownloadPersonImage
Returns a person image.
Public methodCode exampleEndSession
Terminates current session. Authentication performed with Authenticate method will not be valid any longer.
Public methodCode exampleGetIpInfo
Help method. Shows ticket IP address and UserHostAddress.
Public methodCode exampleQuickSearch
Searches for an Organisation/Person basing on the given parameters. This method performs its own separate authentication and does not require calling Authenticate and EndSession methods.
Public methodCode exampleReadDocument
Returns a document.
Public methodCode exampleReadFromWebcrmByDates
Returns a list of entities basing on date criteria.

ReadFromWebcrmByDates is deprecated, please use ReadFromWebcrmByDatesDirect instead.

Public methodCode exampleReadFromWebcrmByDatesDirect
Returns a list of entities basing on date criteria.
Public methodCode exampleReadFromWebcrmById
Returns a list of entities basing on the given organisationID and recordID. If entityType is Organisations then organisationID and recordID must me equal.

ReadFromWebcrmById is deprecated, please use ReadFromWebcrmByIdDirect instead.

Public methodCode exampleReadFromWebcrmByIdDirect
Returns a list of entities basing on the given organisationID and recordID. If entityType is Organisations then organisationID and recordID must me equal.
Public methodCode exampleReadLinkedData
Returns linked data for the specified entity type.
Public methodCode exampleReadPossibleQuotations
Returns a list of possible quotations.
Public methodCode exampleReadQuotationLines
Returns a list of quotation lines (max 10000).
Public methodCode exampleRetrieveByQuery
Returns data basing on the given SELECT SQL parameters.
Public methodCode exampleReturnAllFieldDescription
Returns meta data for all fields.
Public methodCode exampleReturnAllUsers
Returns list of all users with access level > 4.
Public methodCode exampleReturnFieldDescription
Returns meta data for the specified entity field.
Public methodCode exampleReturnUserDetails
Returns the user details for a specific user identified by loginName.
Public methodCode exampleSaveDocument
Registers or updates a webCRM document.
Public methodCode exampleSearchDelivery
Returns a list of Delivery_ID’s (max 10000). The list is sorted by delivery number and creation date.
Public methodCode exampleSearchOpportunity
Returns a list of Opportunity_ID’s (max 10000). The list is sorted by opportunity number and creation date.
Public methodCode exampleSearchOrganisation
Returns a list of Organisation_ID’s (max 10000). The list is sorted by name.
Public methodCode exampleSearchPerson
Returns a list of Organisation_ID and Person_ID pairs (max 10000). The list is sorted by name.
Public methodCode exampleSearchQuotationData
Returns a list of quotation lines (=Product records) (max 10000) linked to the Opportunity. The list is sorted by created date-time and contains all the field values for each Product record.
Public methodCode exampleSearchQuotationID
Returns a list of ProductId’s (max 10000) linked to the Opportunity. The list is sorted by created date-time.
Public methodCode exampleUpdateLinkedData
Updates or creates records of linked data for the specified entity type.
Public methodCode exampleUploadPersonImage
Registers or updates a person image.
Public methodCode exampleWriteCollectionToWebcrm
Updates or creates collection of entities.

WriteCollectionToWebcrm is deprecated, please use WriteCollectionToWebcrmDirect instead.

Public methodCode exampleWriteCollectionToWebcrmDirect
Updates or creates collection of entities.
Public methodCode exampleWritePossibleQuotations
Writes a list of possible quotations.
Public methodCode exampleWriteQuotationLines
Writes a list of quotation lines.
Public methodCode exampleWriteToWebcrm
Updates an existing entity specified by organisationID and recordID or creates a new one if the ids are empty. If entityType is Organisations then organisationID and recordID must be equal.

WriteToWebcrm is deprecated, please use WriteToWebcrmDirect instead.

Public methodCode exampleWriteToWebcrmDirect
Updates an existing entity specified by organisationID and recordID or creates a new one if the ids are empty. If entityType is Organisations then organisationID and recordID must be equal.
Top
See Also