subscribers-changelog-tpw-operator
Release 8.0
RDTP-17092
What's Changed
GET
/subscribers/{subscriberUid}/users
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
New required properties:
federatedIdentities
New optional properties:
-
lastConnection
-
Added property
federatedIdentities
(array) -
Changed property
lastConnection
(integer)Date of the last connection, epoch time in milliseconds
-
POST
/subscribers/{subscriberUid}/users
Return Type:
Changed response : 201 Created
Successful CREATE
New required properties:
federatedIdentities
-
Added property
federatedIdentities
(array) -
Added property
lastConnection
(integer)Date of the last connection, epoch time in milliseconds
GET
/subscribers/{subscriberUid}/users/{userUid}
Return Type:
Changed response : 200 OK
Successful CREATE
New required properties:
federatedIdentities
-
Added property
federatedIdentities
(array) -
Added property
lastConnection
(integer)Date of the last connection, epoch time in milliseconds
PUT
/subscribers/{subscriberUid}/users/{userUid}
Return Type:
Changed response : 200 OK
Successful CREATE
New required properties:
federatedIdentities
-
Added property
federatedIdentities
(array) -
Added property
lastConnection
(integer)Date of the last connection, epoch time in milliseconds
RDTP-19650 / RDTP-21963
What's New
GET
/subscribers/{subscriberUid}/users/{userUid}
Retrieve a user account
PUT
/subscribers/{subscriberUid}/users/{userUid}
Update a user account
DELETE
/subscribers/{subscriberUid}/users/{userUid}
Delete a user account
What's Deprecated
GET
/subscribers/{subscriberUid}/news/latest
Retrieve Latest News
POST
/subscribers/{subscriberUid}/news/latest
Create Latest News
PUT
/subscribers/{subscriberUid}/news/latest
Update Latest News
DELETE
/subscribers/{subscriberUid}/news/latest
Delete Latest News
GET
/subscribers/{subscriberUid}/applications/notifications
Retrieve Notifications
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/notifications
Retrieve NotificationsApplication
DELETE
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/notifications/{notificationUid}
Delete Notification
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/notifications/{notificationUid}/read
Update Read
GET
/subscribers/{subscriberUid}/depot
Retrieve Depot
PUT
/subscribers/{subscriberUid}/depot
Update Depot
GET
/subscribers/{subscriberUid}/users/{userUid}/domainRestrictions
Retrieve User's Domain Restrictions
PUT
/subscribers/{subscriberUid}/users/{userUid}/domainRestrictions
Update User's Domain Restrictions
GET
/subscribers/{subscriberUid}/users/{userUid}/groups
Retrieve group memberships
PUT
/subscribers/{subscriberUid}/users/{userUid}/groups
Update group memberships
What's Changed
All paths /subscribers/\{subscriberUid\}/*
Parameters:
Changed: subscriberUid
in path
Unique identifier of the subscriber, either
- the string
mine
to reference the subscriber of the authenticated user requesting the API- the identifier (
ID
) of the subscriber prefixed byid:
- the sequential integer (
UID
) of the subscriber
POST
/subscribers/{subscriberUid}/offers/unsubscribe
POST
/subscribers/{subscriberUid}/subscriptions
Access rights:
Changed to <SubscriberAccount>.acl/RA
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/associate
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/dissociate
DELETE
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/notifications/{notificationUid}
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/notifications/{notificationUid}/read
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/x509Certif/generation
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/x509Certif/invalidate
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/x509Certif/regeneration
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/check
DELETE
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/pendingRequests/{pendingRequestUid}
DELETE
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/offers/{offerUid}
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/abort
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/validate
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/process
Access rights:
Changed to <Subscription>.acl/RA
GET
/subscribers/{subscriberUid}
Retrieve Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
- Added property
clientIdPrefix
(string)Mandatory prefix service accounts must have.
PUT
/subscribers/{subscriberUid}
Update Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
- Added property
clientIdPrefix
(string)Mandatory prefix service accounts must have.
GET
/subscribers/{subscriberUid}/applications
Retrieve ApplicationsSubscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
- Added property
description
(string)
- Added property
-
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/accessCode
Create AccessCode
Request:
The request body is optional: when not set, the access code is generated for the authenticated end-user.
Return Type:
Changed response : 201 Created
Successful CREATE
- Added property
href
(string)
POST
/subscribers/{subscriberUid}/users
Create User
Access rights:
Changed to <SubscriberAccount>.acl/RA
if password
is provided in the request
Request:
-
Added property
domainRestrictions
(object)User's domain restrictions:
- If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
- Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions
-
Property
and
(array)A resource matches if it matches all
and
items.Items (object):
A resource matches if it is associated with a domain satisfying the following requirements:
- The group name of the resource domain is
group.name
(exact match) - If
type
isPREFIX
:- The name of the resource domain is prefixed with
name
- The name of the resource domain is prefixed with
- Else: (
type
isFULL
)- The name of the resource domain is
name
(exact match)
- The name of the resource domain is
-
Property
type
(string)Type of domain restriction:
FULL
: restriction on full domainPREFIX
: restriction on domain prefix
Enum values:
FULL
PREFIX
-
Property
name
(string)Name of the full domain or domain prefix
-
Property
group
(object)Domain group associated with the domain restriction
- Property
name
(string)Name of the domain group
- Property
- The group name of the resource domain is
-
Added property
groupIDs
(array)Items (string):
-
Added property
language
(string)User's language
Return Type:
Changed response : 201 Created
Successful CREATE
-
Added property
domainRestrictions
(object)User's domain restrictions:
- If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
- Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions
-
Property
and
(array)A resource matches if it matches all
and
items.Items (object):
A resource matches if it is associated with a domain satisfying the following requirements:
- The group name of the resource domain is
group.name
(exact match) - If
type
isPREFIX
:- The name of the resource domain is prefixed with
name
- The name of the resource domain is prefixed with
- Else: (
type
isFULL
)- The name of the resource domain is
name
(exact match)
- The name of the resource domain is
-
Property
type
(string)Type of domain restriction:
FULL
: restriction on full domainPREFIX
: restriction on domain prefix
Enum values:
FULL
PREFIX
-
Property
name
(string)Name of the full domain or domain prefix
-
Property
group
(object)Domain group associated with the domain restriction
- Property
name
(string)Name of the domain group
- Property
- The group name of the resource domain is
-
Added property
groupIDs
(array)Items (string):
-
Added property
language
(string)User's language
-
Added property
state
(string)State of the relation between the Subscriber and the User
-
Added property
userState
(string)State of the User
Release 7.3
RDTP-16917
What's New
GET
/subscribers/{subscriberUid}/serviceAccounts
POST
/subscribers/{subscriberUid}/serviceAccounts
GET
| PUT
| DELETE
/subscribers/{subscriberUid}/serviceAccounts/{serviceAccountId}
POST
/subscribers/{subscriberUid}/serviceAccounts/{serviceAccountId}/secret
GET
/subscribers/{subscriberUid}/serviceAccounts/groups
RDTP-17900
What's Changed
All paths /subscribers/\{subscriberUid\}/*
Parameters:
Changed: subscriberUid
in path
Unique identifier of the subscriber, either
- the sequential integer (
UID
) of the subscriber- the identifier (
ID
) of the subscriber prefixed byid:
RDTP-19834
What's Changed
GET
/subscribers/{subscriberUid}
Retrieve Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
The following properties are now optional:
chargingAnniversary
nextChargingDate
PUT
/subscribers/{subscriberUid}
Update Subscriber
Request:
The following properties are now optional:
chargingAnniversary
nextChargingDate
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
The following properties are now optional:
chargingAnniversary
nextChargingDate
GET
/subscribers/{subscriberUid}/applications
Retrieve ApplicationsSubscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
The following properties are now optional:
place
-
GET
/subscribers/{subscriberUid}/applications/applicationCompatibility
Retrieve ApplicationCompatibility
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
The following properties are now optional:
place
-
GET
/subscribers/{subscriberUid}/nodes/{nodeUid}/applications
Retrieve ApplicationsSubscriberNode
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
The following properties are now optional:
place
-
GET
/subscribers/{subscriberUid}/nodes/{nodeUid}/applications/applicationCompatibility
Retrieve ApplicationCompatibilityNode
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
The following properties are now optional:
place
-
GET
/subscribers/{subscriberUid}/offers
Retrieve Offers
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
The following properties are now optional:
currency
-
GET
/subscribers/{subscriberUid}/orders
Retrieve Orders
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
-
Changed property
offers
(object)-
Changed property
offer
(array)Changed items (object):
The following properties are now optional:
initialFreePeriod
-
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
The following properties are now optional:
shippingMode
-
-
-
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}
Retrieve Application
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
The following properties are now optional:
place
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}
Update Application
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
The following properties are now optional:
place
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/offers/{offerUid}
Retrieve Offer
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
The following properties are now optional:
currency
-
Changed property
products
(object)-
Changed property
product
(array)Changed items (object):
The following properties are now optional:
currency
place
-
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders
Create CreateOrder
Request:
The following properties are now optional:
billingAddress
: no billing address by defaultshippingAddress
: no shipping address by default
-
Changed property
offers
(object)-
Changed property
offer
(array)Changed items (object):
The following properties are now optional:
currency
: the vendor currency is used by defaultrecurringPeriod
:P0M
by defaultrecurringPriceExclTax
: 0 by defaultrecurringTax
: 0 by defaultupfrontPriceExclTax
: 0 by defaultupfrontTax
: 0 by default
-
-
Changed property
suppliers
(object)-
Changed property
supplier
(array)Changed items (object):
-
Changed property
items
(object)-
Changed property
item
(array)Changed items (object):
The following properties are now optional:
place
: no place by default
-
-
-
Return Type:
Changed response : 201 Created
Successful CREATE
-
Changed property
suppliers
(object)-
Changed property
supplier
(array)Changed items (object):
-
Changed property
items
(object)-
Changed property
item
(array)Changed items (object):
The following properties are now optional:
place
-
-
-
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}
Retrieve Order
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
offers
(object)-
Changed property
offer
(array)Changed items (object):
The following properties are now optional:
currency
-
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
The following properties are now optional:
shippingMode
-
RDTP-21689
What's Changed
GET
/subscribers/{subscriberUid}/users
Retrieve Users
Parameters:
Deprecated: apiOnly
in query
Either
true
to return API only users orfalse
to return non API only users. All types of users are returned if the query param is not provided.This property must no longer be used: service accounts must be used to access the API.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
- Deprecated property
apiOnly
(boolean)true
if the user account is specifically designed to be used by an application.This property must no longer be used: service accounts must be used to access the API.
- Deprecated property
-
POST
/subscribers/{subscriberUid}/users
Create User
Request:
- Deprecated property
apiOnly
(boolean)true
if the user account is specifically designed to be used by an application.apiOnly
user accounts are not subject to password expiration.This property must no longer be used: service accounts must be used to access the API.
Return Type:
Changed response : 201 Created
Successful CREATE
- Deprecated property
apiOnly
(boolean)true
if the user account is specifically designed to be used by an application.apiOnly
user accounts are not subject to password expiration.This property must no longer be used: service accounts must be used to access the API.
Release 7.2
RDTP-17770
What's Changed
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/abort
An Order Batch in the PROCESSING state can now be aborted.
RDTP-8479
What's New
GET
/subscribers/{subscriberUid}/domainGroups
Retrieve Domain Groups
POST
/subscribers/{subscriberUid}/domainGroups
Create Domain Group
GET
/subscribers/{subscriberUid}/domainGroups/{domainGroupUid}
Retrieve a Domain Group
PUT
/subscribers/{subscriberUid}/domainGroups/{domainGroupUid}
Update a Domain Group
DELETE
/subscribers/{subscriberUid}/domainGroups/{domainGroupUid}
Delete a Domain Group
GET
/subscribers/{subscriberUid}/domains
Retrieve Domains
POST
/subscribers/{subscriberUid}/domains
Create Domain
GET
/subscribers/{subscriberUid}/domains/{domainUid}
Retrieve a Domain
PUT
/subscribers/{subscriberUid}/domains/{domainUid}
Update a Domain
DELETE
/subscribers/{subscriberUid}/domains/{domainUid}
Delete a Domain
GET
/subscribers/{subscriberUid}/domains/suggestions
Retrieve Domain Suggestions
GET
/subscribers/{subscriberUid}/users/{userUid}/domainRestrictions
Retrieve User's Domain Restrictions
PUT
/subscribers/{subscriberUid}/users/{userUid}/domainRestrictions
Update User's Domain Restrictions
What's Changed
GET
/subscribers/{subscriberUid}/users
Retrieve Users
Access rights:
Changed to <SubscriberAccount>.acl/a
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
-
Added property
domainRestrictions
(object)User's domain restrictions:
- If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
- Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions
-
Property
and
(array)A resource matches if it matches all
and
items.Items (object):
A resource matches if it is associated with a domain satisfying the following requirements:
- The group name of the resource domain is
group.name
(exact match) - If
type
isPREFIX
:- The name of the resource domain is prefixed with
name
- The name of the resource domain is prefixed with
- Else: (
type
isFULL
)- The name of the resource domain is
name
(exact match)
- The name of the resource domain is
-
Property
type
(string)Type of domain restriction:
FULL
: restriction on full domainPREFIX
: restriction on domain prefix
Enum values:
FULL
PREFIX
-
Property
name
(string)Name of the full domain or domain prefix
-
Property
group
(object)Domain group associated with the domain restriction
- Property
name
(string)Name of the domain group
- Property
- The group name of the resource domain is
-
-
GET
/subscribers/{subscriberUid}/users/{userUid}/groups
Retrieve group memberships
Access rights:
Changed to:
<SubscriberAccount>.acl/a
- Access is granted to user on its own account (hardcoded without ACL Permission)
Release 7.1
RDTP-15026
What's Changed
GET
/subscribers/{subscriberUid}/modules
Retrieve Modules
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
-
Added property
authentication
(string)Authentication protocol used by the module to authenticate the admin user.
Enum values:
SMP
OIDC
-
-
Release 7.0
RDTP-15723
What's Deprecated
GET
/subscribers/{subscriberUid}/addresses
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/addresses
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/addresses/{addressUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/addresses/{addressUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
DELETE
/subscribers/{subscriberUid}/addresses/{addressUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/aliases
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/aliases
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/aliases/{aliasUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/aliases/{aliasUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
DELETE
/subscribers/{subscriberUid}/aliases/{aliasUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/applications/applicationCompatibility
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/gateways
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/helpers/models
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/invoices
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/nodes
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/nodes/nodeCompatibility
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/nodes/{nodeUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/nodes/{nodeUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
DELETE
/subscribers/{subscriberUid}/nodes/{nodeUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/nodes/{nodeUid}/applications
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/nodes/{nodeUid}/applications/applicationCompatibility
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/places
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/places
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/places/{placeUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/places/{placeUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
DELETE
/subscribers/{subscriberUid}/places/{placeUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/places/{placeUid}/applications
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/places/{placeUid}/gateways
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/places/{placeUid}/include
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/places/{placeUid}/nodes
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/places/{placeUid}/settings
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/recurrings
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/associate
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/categories
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/dissociate
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/nodeCompatibility
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}/nodes/places
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/x509Certif/generation
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/x509Certif/invalidate
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/x509Certif/regeneration
This endpoint must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/check
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/pendingRequests
This endpoint must no longer be used: the associated feature is no more available in the product.
DELETE
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/gateways/{gatewayUid}/pendingRequests/{pendingRequestUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/validate
This endpoint must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/process
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/transactions
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/recurrings/{recurringUid}
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/recurrings/{recurringUid}/transactions
This endpoint must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}
Return Type:
Changed response : 200 OK
-
Deprecated property
chargingAnniversary
(integer)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
nextChargingDate
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
vatNumber
(string)This property must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}
Request:
- Deprecated property
vatNumber
(string)This property must no longer be used: the associated feature is no more available in the product.
Return Type:
Changed response : 200 OK
-
Deprecated property
chargingAnniversary
(integer)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
nextChargingDate
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
vatNumber
(string)This property must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/applications
Return Type:
Changed response : 200 OK
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
- Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
- Deprecated property
-
GET
/subscribers/{subscriberUid}/offers
Return Type:
Changed response : 200 OK
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
-
Deprecated property
currency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
initialFreePeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
periodicity
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
GET
/subscribers/{subscriberUid}/orders
Return Type:
Changed response : 200 OK
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
-
Deprecated property
billing
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
offers
(object)-
Changed property
offer
(array)Changed items (object):
-
Deprecated property
currency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
initialFreePeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringPeriodicity
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
-
Deprecated property
attachments
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
products
(object)-
Changed property
product
(array)Changed items (object):
-
Deprecated property
supplierCurrency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
supplierUpfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
supplierUpfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
shippingMode
(object)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
shipping
(object)This property must no longer be used: the associated feature is no more available in the product.
-
-
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}
Return Type:
Changed response : 200 OK
- Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
PUT
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/applications/{applicationUid}
Request:
- Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
Return Type:
Changed response : 200 OK
- Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/offers/{offerUid}
Return Type:
Changed response : 200 OK
-
Deprecated property
currency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
delayedDeactivationDate
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
firstChargingDate
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
initialFreePeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
nextCharingDate
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
periodicity
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
products
(object)-
Changed property
product
(array)Changed items (object):
-
Deprecated property
currency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
initialFreePeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
periodicity
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
supplierRecurringPrice
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
supplierUpfrontPrice
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
recurringPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders
Parameters:
Deprecated: processOrder
in query
This parameter must no longer be used: the associated feature is no more available in the product.
Request:
-
Deprecated property
billingAddress
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
contactPermission
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
offers
(object)-
Changed property
offer
(array)Changed items (object):
-
Deprecated property
currency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
initialFreePeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringPeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
shippingAddress
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
suppliers
(object)-
Changed property
supplier
(array)Changed items (object):
-
Changed property
items
(object)-
Changed property
item
(array)Changed items (object):
- Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
- Deprecated property
-
-
Deprecated property
shippingMode
(object)This property must no longer be used: the associated feature is no more available in the product.
-
-
Return Type:
Changed response : 201 Created
-
Changed property
suppliers
(object)-
Changed property
supplier
(array)Changed items (object):
-
Changed property
items
(object)-
Changed property
item
(array)Changed items (object):
-
Deprecated property
b2bUpfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
b2bUpfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
place
(object)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
shippingMode
(object)This property must no longer be used: the associated feature is no more available in the product.
-
-
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}
Return Type:
Changed response : 200 OK
-
Deprecated property
billing
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
offers
(object)-
Changed property
offer
(array)Changed items (object):
-
Deprecated property
currency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
initialFreePeriod
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
periodicity
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
recurringTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
upfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
-
Deprecated property
attachments
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Changed property
products
(object)-
Changed property
product
(array)Changed items (object):
-
Deprecated property
supplierCurrency
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
supplierUpfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
supplierUpfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
shippingMode
(object)This property must no longer be used: the associated feature is no more available in the product.
-
-
-
Deprecated property
shipping
(object)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
totalChargedUpfrontPriceExclTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
totalChargedUpfrontTax
(number)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
vatNumber
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
vendorCaptureStatus
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
vendorPSP
(string)This property must no longer be used: the associated feature is no more available in the product.
POST
/subscribers/{subscriberUid}/users
Request:
-
Deprecated property
facebookID
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
googleID
(string)This property must no longer be used: the associated feature is no more available in the product.
Return Type:
Changed response : 201 Created
-
Deprecated property
facebookID
(string)This property must no longer be used: the associated feature is no more available in the product.
-
Deprecated property
googleID
(string)This property must no longer be used: the associated feature is no more available in the product.
RDTP-7922
What's Changed
GET
/subscribers/{subscriberUid}
Retrieve Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
- Added property
marketplaceUrl
(string)Marketplace URL
PUT
/subscribers/{subscriberUid}
Update Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
- Added property
marketplaceUrl
(string)Marketplace URL
Release 6.1
RDTP-16840
What's Changed
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/abort
An Order Batch in the TRYING state can now be aborted.
RDTP-2232
What's Changed
GET
/subscribers/{subscriberUid}
Retrieve Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
Following properties are now optional:
contactEmail
contactName
PUT
/subscribers/{subscriberUid}
Update Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
Following properties are now optional:
contactEmail
contactName
RDTP-6628 / RDTP-8975
What's Changed
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}
Retrieve Order
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
- Added property
ID
(string)Order Context ID
- Added property
-
Release 6.0
RDTP-10108
What's Changed
GET
/subscribers/{subscriberUid}/users
Retrieve Users
Parameters:
Added: apiOnly
in query
Either
true
to return API only users orfalse
to return non API only users. All types of users are returned if the query param is not provided.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
- Added property
apiOnly
(boolean)TRUE if the user account is specifically designed to be used by an application to make automatic requests to the SMP platform.
- Added property
-
POST
/subscribers/{subscriberUid}/users
Create User
Request:
- Added property
apiOnly
(boolean)true
if the user account is specifically designed to be used by an application to make automatic requests to the SMP platform.apiOnly
user accounts are not subject to password expiration.
Return Type:
Changed response : 201 Created
Successful CREATE
- Added property
apiOnly
(boolean)true
if the user account is specifically designed to be used by an application to make automatic requests to the SMP platform.apiOnly
user accounts are not subject to password expiration.
RDTP-2488
What's New
GET
/subscribers/{subscriberUid}/users/groups
Retrieve user groups
GET
/subscribers/{subscriberUid}/users/{userUid}/groups
Retrieve group memberships
PUT
/subscribers/{subscriberUid}/users/{userUid}/groups
Update group memberships
What's Changed
GET
/subscribers/{subscriberUid}/users
Retrieve Users
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
New required properties:
-
ctxHref
-
groupIDs
-
Added property
ctxHref
(string)User HREF in Subscriber context
-
Added property
groupIDs
(array)Group IDs
Items (string):
-
-
POST
/subscribers/{subscriberUid}/users
Create User
Parameters:
Added: noGroup
in query
If true, the created user is not associated to any group, else user id added to ADMINS group.
Return Type:
Changed response : 201 Created
Successful CREATE
New required properties:
ctxHref
- Added property
ctxHref
(string)User HREF in Subscriber context
RDTP-6886
What's New
GET
/subscribers/{subscriberUid}/helpers/customFieldSets/{customFieldSetUid}
Retrieve Custom Field Set
What's Changed
GET
/subscribers/{subscriberUid}
Retrieve Subscriber
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
customFields
(object)-
Changed property
customField
(array)List of Custom Fields
Changed items (object):
-
Deleted property
enumerate
(object) -
Changed property
enumValue
(array -> object)enumerate value (only applicable if type is ENUMERATE)
Items (object):
-
Added property
ID
(string)enumerate value ID
-
Added property
name
(string)enumerate value name
-
-
-
-
Changed property
customFieldSet
(object)New required properties:
-
href
- Added property
href
(string)HREF to retrieve the Custom Field Set using helpers WS
-
PUT
/subscribers/{subscriberUid}
Update Subscriber
Request:
-
Changed property
customFields
(object)-
Changed property
customField
(array)List of Custom Fields
Changed items (object):
-
Changed property
enumValue
(array -> object)enumerate value (only applicable if type is ENUMERATE)
Items (object):
- Added property
ID
(string)enumerate value ID
- Added property
-
-
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
customFields
(object)-
Changed property
customField
(array)List of Custom Fields
Changed items (object):
-
Deleted property
enumerate
(object) -
Changed property
enumValue
(array -> object)enumerate value (only applicable if type is ENUMERATE)
Items (object):
-
Added property
ID
(string)enumerate value ID
-
Added property
name
(string)enumerate value name
-
-
-
-
Changed property
customFieldSet
(object)New required properties:
-
href
- Added property
href
(string)HREF to retrieve the Custom Field Set using helpers WS
-
RDTP-7448
What's New
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/process
Process Order
What's Changed
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders
Create CreateOrder
Parameters:
Added: processOrder
in query
Automatically process the order without waiting for payment confirmation. This query parameter only applies when checkConstraintsOnly=false and vendor prices are set to 0. When vendor prices are greater than 0, the order is not processed and the payment confirmation is required.
TRUE is considered by default if the query parameter is not specified.
Request:
-
Added property
contactPermission
(string)Indicates if the subscriber accepts to be contacted for this order.
Enum values:
ACCEPT
DECLINE
RDTP-8035
What's New
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}/abort
Abort Order
DELETE
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}
Delete Order
What's Changed
GET
/subscribers/{subscriberUid}/orders
Retrieve Orders
Parameters:
Added: offerID
in query
Only return orders matching the offer ID
Changed: aggregatedState
in query
Only return Order Batches matching the aggregated current state (exact match):
- COMPLETED = COMPLETED*
- ABORTED = ABORTING*, ABORTED*
- IN-PROGRESS = any - COMPLETED*, ABORTING*, ABORTED*, LOGGED
- ALL = any - LOGGED
- NOT-INIT = any - INIT
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
briefs
(object)-
Changed property
brief
(array)Changed items (object):
-
Added property
billing
(object)- Property
name
(string)Billing address name
- Property
-
Added property
shipping
(object)- Property
name
(string)Shipping address name
- Property
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
-
Added property
attachments
(object)-
Property
attachment
(array)List of attachments included in the order context
Items (object):
-
Property
filename
(string)Attachment filename
-
Property
type
(string)Attachment type
-
Property
url
(string)Attachment URL
-
-
-
Added property
products
(object)-
Property
product
(array)List of products included in the order context
Items (object):
-
Property
ID
(string) -
Property
supplierCurrency
(string)Currency of product supplier upfront price
-
Property
supplierUpfrontPriceExclTax
(number)Product supplier upfront price excluding tax
-
Property
supplierUpfrontTax
(number)Product supplier upfront tax
-
-
-
Changed property
shippingMode
(object)-
Added property
supplierCurrency
(string)Currency of shipping supplier upfront price
-
Added property
supplierUpfrontPrice
(number)Shipping supplier upfront price excluding tax
-
Added property
supplierUpfrontTax
(number)Shipping supplier upfront tax
-
-
-
-
-
GET
/subscribers/{subscriberUid}/recurrings
Retrieve Recurrings
Parameters:
Changed: aggregatedState
in query
Only return Order Batches matching the aggregated current state (exact match):
- COMPLETED = COMPLETED*
- ABORTED = ABORTING*, ABORTED*
- IN-PROGRESS = any - COMPLETED*, ABORTING*, ABORTED*, LOGGED
- ALL = any - LOGGED
- NOT-INIT = any - INIT
GET
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders/{orderUid}
Retrieve Order
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Added property
vendorCaptureStatus
(string)Status of the vendor capture transaction
Enum values:
CAPTURED
NOT_CAPTURED
-
Added property
vendorPSP
(string)PSP used to charge the vendor
Enum value:
STRIPE
-
Changed property
orderContexts
(object)-
Changed property
orderContext
(array)Changed items (object):
-
Added property
attachments
(object)-
Property
attachment
(array)List of attachments included in the order context
Items (object):
-
Property
filename
(string)Attachment filename
-
Property
type
(string)Attachment type
-
Property
url
(string)Attachment URL
-
-
-
Changed property
products
(object)-
Changed property
product
(array)Changed items (object):
Product: Can be an application, an application option, a device or a gateway.
-
Added property
SKU
(string)Stock Keeping Unit
-
Added property
supplierCurrency
(string)Currency of product supplier upfront price
-
Added property
supplierUpfrontPriceExclTax
(number)Product supplier upfront price excluding tax
-
Added property
supplierUpfrontTax
(number)Product supplier upfront tax
-
-
-
Changed property
shippingMode
(object)- Added property
supplierUpfrontTax
(number)Shipping supplier upfront tax
- Added property
-
-
Release 5.2.2
No change
Release 5.1
General
No change
Release 5.0.1
General
What's New
GET
/subscribers/{subscriberUid}/news/latest
Retrieve Latest News
PUT
/subscribers/{subscriberUid}/news/latest
Update Latest News
POST
/subscribers/{subscriberUid}/news/latest
Create Latest News
DELETE
/subscribers/{subscriberUid}/news/latest
Delete Latest News
What's Changed
GET
/subscribers/{subscriberUid}
Retrieve Subscriber
Parameters:
Added: customFields
in query
Return custom fields. When this query parameter is not specified in the request, custom fields are not returned.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Added property
customFields
(object) -
Added property
customFieldSet
(object)
PUT
/subscribers/{subscriberUid}
Update Subscriber
Request:
- Added property
customFields
(object)
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Added property
customFields
(object) -
Added property
customFieldSet
(object)
POST
/subscribers/{subscriberUid}/subscriptions/{subscriptionUid}/orders
Create CreateOrder
Return Type:
Changed response : 201 Created
Successful CREATE
-
Changed property
suppliers
(object)-
Changed property
supplier
(object)-
Changed property
shippingMode
(object)Mandatory when the Supplier is associated with a shipping process, otherwise forbidden.
Note: Upfront price and tax are the vendor shipping price
-
Added property
b2bUpfrontPriceExclTax
(number) -
Added property
b2bUpfrontTax
(number)
-
-
Changed property
items
(object)-
Changed property
item
(object)-
Added property
b2bUpfrontPriceExclTax
(number) -
Added property
b2bUpfrontTax
(number)
-
-
-
-
GET
/subscribers/{subscriberUid}/users
Retrieve Users
Parameters:
Added: query
in query
Search users with a firstName or lastName or email containing the provided term (prefix match).
Release 4.3
NFR432
Following web service is updated:
R /subscribers/\{subscriberUid\}/modules
Attribute name | XSD type | Resp. | Description | ||
---|---|---|---|---|---|
briefs[]/index | integer | O | Module index If the index is > 0: the Module TAB must be displayed to the right of SMP TABs. If the index is < 0: the Module TAB must be displayed to the left of SMP TABs. Then Module TABs are sorted relatively to their indexes: a Module with a greater index is displayed to the right. Modules without index are displayed to the right and sorted by "name" (lexicographic order). |
Release 4.2
NFR232
Following web service is updated:
R /subscribers/\{subscriberUid\}/orders
Results are ordered by timestamp then "ID" ( REVERSE lexicographic order).
Optional query parameters
updatedAfter | date | Returns Orders where the current timestamp >= updatedAfter |
NFR722
Following web services are updated:
R /subscribers/\{subscriberUid\}/users
Attribute name | XSD type | Resp. | Description | ||
---|---|---|---|---|---|
briefs/brief[]/lastConnection → NEW | dateTime | M | |||
briefs/brief[]/userState → NEW | string (enumeration) | M | State of the User.(PENDING , ACCEPTED , LOCKED ) |
C /subscribers/\{subscriberUid\}/users
Attribute name | XSD type | Create | Resp. | Description | |
---|---|---|---|---|---|
mobilePhone → NEW | string | O | O | ||
officePhone → NEW | string | O | O | ||
homePhone → NEW | string | O | O |
Release 4.1
FIX3981
Following web service is updated:
R /subscribers/\{subscriberUid\}/processes/\{processUid\}
Attribute name | XSD type | Resp. | Description | ||
---|---|---|---|---|---|
inputContext → UPDATED | JSON | O | Input context injected in the process instance. |
FIX4966
Following web service is updated:
R /subscribers/\{subscriberUid\}/processes/\{processUid\}/tasks/\{taskUid\}
Attribute name | XSD type | Resp. | Description | ||
---|---|---|---|---|---|
initialOutputContext → DELETED | JSON | M | Output context when the task has been created. | ||
finalOutputContext → DELETED | JSON | O | Output context when the task has been completed. | ||
assignedTo ("userTask" only) → DELETED | string | O | First name and last name of the manager that complete the task. | ||
claimingDate ("userTask" only) → DELETED | dateTime | O | Claim timestamp. | ||
bpmGroupName ("userTask" only) → DELETED | string | 0 | BPM group name. | ||
formResultData ("userTask" only) → DELETED | string | O | From result injected in the task. |