subscriptionmatching.pinnedsubscription

Description

Provides the namespace for operations on Pinned Subscriptions

Namespace:

subscriptionmatching.pinnedsubscription

Method: create

HTTP POST

Description:

Creates a Pinned Subscription based on given subscription and system

Parameters:

  • string sessionKey - Session token, issued at login

  • int subscriptionId - Subscription ID

  • int sid - System ID

Returns:

  • * struct pinned subscription

    • int "id"

    • int "subscription_id"

    • int "system_id"

Method: delete

HTTP POST

Description:

Deletes Pinned Subscription with given id

Parameters:

  • string sessionKey - Session token, issued at login

  • int subscriptionId - Pinned Subscription ID

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: list

HTTP POST

Description:

Lists all PinnedSubscriptions

Parameters:

  • string sessionKey - Session token, issued at login

Returns:

  • array :

  • struct pinned subscription

    • int "id"

    • int "subscription_id"

    • int "system_id"