Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 5.18 KB

ConnectionsApi.md

File metadata and controls

123 lines (90 loc) · 5.18 KB
Raw

floriday_supplier_client.ConnectionsApi

All URIs are relative to https://api.staging.floriday.io/suppliers-api-2024v1

Method HTTP request Description
get_connections_by_sequence_number GET /connections/sync/{sequenceNumber} network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 connections starting from a specified sequence number.
get_connections_max_sequence GET /connections/current-max-sequence network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in connections.

get_connections_by_sequence_number

SyncResultOfConnection get_connections_by_sequence_number(sequence_number, limit_result=limit_result)

network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 connections starting from a specified sequence number.

Synchronization endpoint Fetches the succeeding modified records (including deleted records) based on Limit and the given SequenceNumber. Note Your data is up to date when your given SequenceNumber is equal to the received MaximumSequenceNumber.

Example

from __future__ import print_function
import time
import floriday_supplier_client
from floriday_supplier_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT Token
configuration = floriday_supplier_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: X-Api-Key
configuration = floriday_supplier_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = floriday_supplier_client.ConnectionsApi(floriday_supplier_client.ApiClient(configuration))
sequence_number = 789 # int | 
limit_result = 1000 # int |  (optional) (default to 1000)

try:
    # network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 connections starting from a specified sequence number.
    api_response = api_instance.get_connections_by_sequence_number(sequence_number, limit_result=limit_result)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectionsApi->get_connections_by_sequence_number: %s\n" % e)

Parameters

Name Type Description Notes
sequence_number int
limit_result int [optional] [default to 1000]

Return type

SyncResultOfConnection

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_connections_max_sequence

int get_connections_max_sequence()

network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in connections.

Example

from __future__ import print_function
import time
import floriday_supplier_client
from floriday_supplier_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: JWT Token
configuration = floriday_supplier_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: X-Api-Key
configuration = floriday_supplier_client.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = floriday_supplier_client.ConnectionsApi(floriday_supplier_client.ApiClient(configuration))

try:
    # network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in connections.
    api_response = api_instance.get_connections_max_sequence()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectionsApi->get_connections_max_sequence: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

int

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]