HomeWiki
HomeWiki
  1. Import
  • Back to home
  • 2. Connectivity
  • Introduction
  • Custom Script
  • Playground
  • Database Explorer
  • Log Stream
  • Direct Communication
  • Softone
    • Getting Started
  • Datapump
    • Getting Started
    • Crons
    • Legacy Windows Support
    • SDK
      • DB
        • _executeQuery
        • _executeStoreProcedure
        • _executeInsertQuery
        • _executeInsertQueriesInTransaction
      • Import
        • _productsImport
        • _categoriesImport
        • _brandsImport
        • _attributesImport
        • _attributeSetsImport
        • _unitsImport
        • _quantityImport
        • _customersImport
        • _contactsImport
        • _callsImport
        • _eventsImport
        • _tasksImport
        • _ordersImport
        • _usersImport
        • _customerSourceTagsImport
        • _productSourceTagsImport
      • Log
        • _logDebug
        • _logInfo
        • _logWarn
        • _logError
      • Web Requests
        • _httpGetJson
        • _httpPostJson
        • _httpPutJson
        • _httpDeleteJson
        • _httpPatchJson
      • Variables
        • _saveVariable
        • _getVariable
        • _deleteVariable
      • Blob
        • _blobConnect
        • _blobExists
        • _blobGet
        • _blobFind
      • Utils
        • _encodeBase64
        • _sleep
        • _getLastSyncDate
        • _updateLastSyncDate
        • _resetLastSyncDate
  1. Import

_eventsImport

Documentation: _eventsImport Function#

The _eventsImport function is designed to import a batch of event data into the Shopranos platform. It manages authentication, sends a POST request with the event data to the Shopranos API, and processes the response and potential errors. The function returns a structured result indicating the outcome of the import operation.

Function Signature:#

Parameters:#

payload (Array of events):
Description: An array of event objects to be sent in the POST request body. Each object should represent an event with its relevant details. This data is used by the Shopranos platform to process the import operation.
Type: Array<Object>
Example:

Return Value:#

Returns:
A JSON object containing the result of the HTTP POST request to the Shopranos platform. The object includes:
StatusCode: The HTTP status code of the response from the Shopranos platform.
Content: The content of the response body from the Shopranos platform, typically containing success or error messages.
Type: Object
Example:

Function Workflow:#

1.
Retrieve Certificate:
The function retrieves a certificate required for authentication. If the certificate cannot be obtained, it logs an error and returns a JSON object indicating "NO CERTIFICATE".
2.
Retrieve Access Token:
It then retrieves an access token for authorization. If the token is not available or is empty, it logs an error and returns a JSON object indicating "NO TOKEN".
3.
Prepare and Send HTTP Request:
The function creates an HTTP client and configures it with the access token and base address for the Shopranos platform.
It sets the request headers, including the Authorization header with the Bearer token and x-companyid header with the company ID from the certificate.
The payload is converted to a JSON string and sent in the request body.
4.
Handle HTTP Response:
The function sends the POST request to the specified URL and checks if the response is successful. If not, it logs an error with the status code.
It reads the response content and logs it for debugging purposes.
It then constructs a JSON object with the StatusCode and Content from the response.
5.
Exception Handling:
If any exception occurs during the process, it logs the exception message and returns a JSON object with StatusCode set to "EXCEPTION" and the exception message as the Content.

Example Usage:#

Important Considerations:#

Error Handling:
Ensure proper handling of cases where the certificate or token cannot be retrieved. The function handles these errors by returning appropriate messages.
Payload Format:
The payload parameter must be an array of event objects formatted according to the Shopranos API requirements.
Task.Api.Features.Events.EventImportDTO
id
string  | null 
optional
updateDate
string <date-time> | null 
optional
subject
string  | null 
optional
taskType
enum<integer> <int32>
optional
Allowed values:
0123456
assignedToType
enum<integer> <int32>
optional
Allowed values:
01
assignedToId
string  | null 
optional
relatedToType
enum<integer> <int32>
optional
Allowed values:
012
relatedToId
string  | null 
optional
contactType
enum<integer> <int32>
optional
Allowed values:
01
contactIds
array[string] | null 
optional
description
string  | null 
optional
editorBody
string  | null 
optional
priorityId
string  | null 
optional
location
object (Task.Api.Features.Events.LocationDTO) 
optional
longitude
string  | null 
optional
latitude
string  | null 
optional
startDate
string <date-time> | null 
optional
endDate
string <date-time> | null 
optional
reminderSet
boolean  | null 
optional
createdBy
string  | null 
optional
lastModifiedBy
string  | null 
optional
position
integer <int32> | null 
optional
parentId
string  | null 
optional
repeat
string  | null 
optional
eventStatus
enum<integer> <int32>
optional
Allowed values:
0123
eventResultId
string  | null 
optional
recurrenceInterval
string  | null 
optional
sourceId
string  | null 
optional
sourceAssignedToId
string  | null 
optional
sourceRelatedToId
string  | null 
optional
sourceContactIds
array[string] | null 
optional
teamMembers
array[string] | null 
optional
Timeouts:
The HTTP client has a timeout of 120 seconds. Ensure that this is sufficient for the Shopranos platform to process the request.
By using _eventsImport, you can automate the import of event data into the Shopranos platform, ensuring that the data is sent securely and that any issues are handled and reported appropriately.
Previous
_callsImport
Next
_tasksImport
Built with