CabmanCloudPlatformVersion: 42.0

Subscribe

Container: CCPService
Namespace: System.Data.Objects

Summary

Subscribes to an entityset so you would receive pushnotifications

Method

The HTTP method for this function import is POST

Parameters

Name Type Summary
deviceId* Edm.Int32 Id of your device as known in CCPService
entitySetId* Edm.Int32 Id of the entity you want to recieve notifications from
subscriptionFilter Edm.String Not implemented yet
entityIds* Edm.Int32 When you only want notifications of some objects of this entityset, you can specify its key values here
properties* Edm.String When you only want notifications on some properties of this entity, you can specify its properties here
operations* Edm.String The operations you want to subscribe to: Add, Update, Delete
alertStringFormat Edm.String Formated string you want to display on phone, when recieve notification
alertLocale Edm.String Locale of the formated string
alertSound Edm.String The alert sound.
filterProviderName Edm.String Name of the filter provider.
Parameters marked with a * are required

Return

Type: Edm.Int32
Is collection: false
Summary: SubscriptionId

Example

Request URL: https://ccp.dispatchconnect.nl/CCPService/DataServiceCCP.svc/Subscribe
Example body (sent with POST-request): 
{
  "deviceId" : 1,
  "entitySetId" : 1,
  "subscriptionFilter" : "subscriptionfilter",
  "entityIds" : 1,
  "properties" : "properties",
  "operations" : "operations",
  "alertStringFormat" : "alertstringformat",
  "alertLocale" : "alertlocale",
  "alertSound" : "alertsound",
  "filterProviderName" : "Name"
}