Supported Onboarding Services¶
Lists the general naming conventions of the services supported for registration and onboarding purposes.
Whenever there is a change in the functionality, newer versions of onboarding services change in order to exchange data back and forth between client and server. Supported onboarding services to handle the requests that are OData compliant are:
Onboarding Service v1
¶
Initial version of the onboarding service. This service deviates from the standard OData compliant service in the sense
that HTTP PUT
requests can be used to change the individual properties, while parameters that are not included in the
request remain the same. When sending the complete entity payload, it, however, replaces the entity as expected. The
service also includes a PATCH
service, which must be accessed by tunneling the request as a POST
request with the header
X-HTTP-METHOD: MERGE
. Example PATCH
request (not all the headers are shown here):
POST/<someentity>
X-HTTP-METHOD:MERGE {"key":"value"}
This request updates the key field of the entity.
Note
Furthermore, the feature vector field is modeled as a collection of complex types, which is not a valid OData
version 2 construct. OData client libraries parsing the service metadata may report an error with v1
version of the
service.
Onboarding Service v2
¶
Introduced changes in the semantics of the OData to ensure OData compliance. The PUT
operation now updates/deletes any
fields from the entity if they are not included in the request payload. Clients must use a PATCH
operation as described
in the v1
service. Additionally, with v2
version, you can use the PATCH
HTTP verb, instead of tunneling it with the
special header in an HTTP POST
request. Example POST
request (not all the headers are shown here):
POST/<someentity>
X-HTTP-METHOD:MERGE{"key":"value"}
Or,
Sample PATCH
request:
PATCH/<someentity>
X-HTTP-METHOD:MERGE{"key":"value"}
The feature vector in v2
is now modeled as an entity and is referenced in this way from other entities. The metadata of
the v2
service should be parsable by OData client libraries. For more information, see Feature Restriction Policies.
Onboarding Service v3
¶
Introduced the device capabilities. For more information, see Create Application Connection with Capability Handling.
Onboarding Service v4
¶
Introduced a new onboarding contract for native applications only. This service has new application connection
properties, such as UserName
, UserLocale
, TimeZone
, LastKnownLocation
, CreatedAt
, PushGroup
,
Email
, IsWiped
, DeviceId
, NetworkPolicy
, LogMaxFileSize
, and LogMaxFileNum
. During onboarding,
the GET
operation can now receive a read-only property for UserName
and CreatedAt
.
Latest Onboarding Service¶
Always refers to the latest version of the onboarding service.
Note
The behavior of this service could change anytime if an updated version of the onboarding service is included in the server version. It is recommended to build your clients against a fixed server URL with a constant version.