ibm smartcloud saas business support system api reference

IBM SmartCloud SaaS Business SupportSystem API Reference

��

NoteBefore using this information, read the information in “Notices” on page 105.

This edition applies IBM SmartCloud SaaS Business Support System, a platform for managing and administeringprocesses that support SaaS services.

Contents

Chapter 1. Overview of IBM SmartCloudSaaS Business Support System . . . . 1

Chapter 2. Prerequisites . . . . . . . . 7

Chapter 3. Tools for using BSS APIs . . 9

Chapter 4. Common scenarios . . . . 11

Chapter 5. Object states . . . . . . . 15

Chapter 6. BSS REST services . . . . 19Customer management services . . . . . . . 19

Register customer . . . . . . . . . . . 19Get customer by ID. . . . . . . . . . . 21Update customer profile . . . . . . . . . 24Delete customer . . . . . . . . . . . . 27Suspend customer . . . . . . . . . . . 28Unsuspend customer . . . . . . . . . . 28Get customer list . . . . . . . . . . . 29Get customer list by email address ororganization name . . . . . . . . . . . 30

Subscriber management services . . . . . . . 33Add subscriber . . . . . . . . . . . . 33Delete subscriber . . . . . . . . . . . 35Update subscriber profile . . . . . . . . . 35Get subscriber list . . . . . . . . . . . 37Get subscriber by ID . . . . . . . . . . 40Suspend subscriber . . . . . . . . . . . 41Unsuspend subscriber . . . . . . . . . . 42Entitle subscriber . . . . . . . . . . . 43

Revoke subscriber . . . . . . . . . . . 44Get subscriber list by email address . . . . . 44Get subscriber list by customer ID . . . . . . 47

Subscription management services. . . . . . . 48Create subscription . . . . . . . . . . . 48Suspend subscription . . . . . . . . . . 50Unsuspend subscription . . . . . . . . . 50Cancel subscription. . . . . . . . . . . 51Get subscription list by customer ID . . . . . 52Get subscription by ID . . . . . . . . . 54Update subscription . . . . . . . . . . 56Get subscription list . . . . . . . . . . 58

Authentication services . . . . . . . . . . 60Change password . . . . . . . . . . . 60Reset password . . . . . . . . . . . . 61Set one-time password. . . . . . . . . . 61

Chapter 7. Common attribute values . . 63

Chapter 8. HTTP status codes. . . . . 73

Chapter 9. Error messages and useractions. . . . . . . . . . . . . . . 75

Notices . . . . . . . . . . . . . . 105107Trademarks . . . . . . . . . . . . . . 107Electronic emission notices . . . . . . . . . 107

Federal Communications Commission (FCC)statement. . . . . . . . . . . . . . 107

Index . . . . . . . . . . . . . . . 109

iii

iv IBM SmartCloud SaaS Business Support System API Reference

Chapter 1. Overview of IBM SmartCloud SaaS BusinessSupport System

IBM SmartCloud™ SaaS Business Support System (BSS) is a platform for managingand administering processes that support SaaS services.

BSS provides functionality that is similar to a site that fosters the sale of hardgoods but with a few fundamental differences. For example, BSS provides catalog,ordering, and subscription management capabilities for soft goods such as servicesto host an online meeting or foster online collaboration. Additionally, instead ofwaiting a few days for your service to arrive, BSS instantly provisions yourservices so that they are ready to be used immediately.

The functional architecture of BSS includes a set of subsystems for provisioningand administering services in a secure way. These subsystems are shown in thefollowing diagram. The business logic in these subsystems is implemented invarious components that are fronted by REST interfaces. Various clients can accessthese REST interfaces by communicating via JavaScript Object Notation (JSON)over HTTP protocol. The REST APIs are built to conform to industry standards.

Note: For more information about REST, see RESTful Web services: The basics onIBM developerWorks.

1

https://www.ibm.com/developerworks/webservices/library/ws-restful/

The following diagram shows the flow of an HTTP request from a clientapplication to the BSS core application server, which implements various businessfunctionality such as customer and subscription management tasks. See the stepsbelow the diagram for details about the sequence of events that take place duringthe request flow.

2 IBM SmartCloud SaaS Business Support System API Reference

At a high level, the request flow takes place in the following order:1. An HTTP request is sent from a custom application.2. The request is passed to the IBM® Tivoli® Access Manager WebSEAL proxy

server, which manages user authentication processes.3. The IBM Tivoli Access Manager WebSEAL proxy server authenticates the

request.4. The request flows through the web server to the BSS proxy application.5. The BSS proxy application formats the request and sends it to the BSS core

application server, which manages all the business core logic.6. The BSS core application server interacts with other components to store and

retrieve information or to perform operations such as sending email.7. The BSS core application server sends the JSON response back to the

application.

BSS terminology

Before using BSS APIs, learn common terms and definitions that are associatedwith BSS. The following diagram shows the basic relationships among some of thekey players described below.

Chapter 1. Overview of IBM SmartCloud SaaS Business Support System 3

To learn about the life cycle of these primary objects, such as how they transitionfrom one state to another, see Chapter 5, “Object states,” on page 15.

CustomerAn organization or company that purchases or pays the ongoing bills for agood or service.

Vendor/resellerAn organization that offers the goods or services of another organization toits own customer set. A vendor (or reseller) can have multiple customers.When a vendor registers with the IBM Customer Service Group (CSG), theprimary contact is designated the VSR role (described later in this topic).The person with the VSR role can add other users and customers to theorganization of the vendor.

Service offering/offeringA product that is offered to a customer for purchase.

SubscriberA user who is entitled to use a particular service offering. A customer canhave multiple subscribers, but each subscriber can have only one customer.

When a customer registers with the vendor, the primary contact isdesignated as the administrator (described below). The administrator canadd other subscribers to the customer's organization.

AdministratorA person who manages or carries out operation tasks on behalf of anorganization, for example creating a subscriber or entitling a subscriber.Every customer must have at least one administrator, although multipleadministrators are allowed.

CatalogA collection of service offerings.


SubscriptionThe right for a set of subscribers to use a set of services and the featuresassociated with those services.

Subscriptions are created when a customer buys a specific offering.Typically, a person with the CustomerAdministrator role assigns a seat tosubscribers for a particular subscription. After a subscriber has a seat, thatsubscriber can use the services associated with the subscription.

Seat Associates a subscriber to a given subscription.

ProvisioningThe process of notifying services about the resources needed for thesubscribers who will use those services.

Roles

BSS supports a number of roles for administering customers, managing users, andperforming user operations. These roles are used in conjunction with authorizationpolicies to determine which functionality is allowed in the system.

The most important relationships are those between a customer and a vendor andbetween a customer and a subscriber. The vendor can be associated with numerouscustomers, but those customer are all independent of each other. The customerpurchases subscriptions, and multiple services are associated with thosesubscriptions. A customer has its own set of subscribers who are assigned to one ormore subscriptions that are owned by the customer. Customers assign subscribersby providing them a seat on the subscription.

The following list describes the major roles and their capabilities in the system.One user can have more than one role. In this case, the privileges are determinedby combining roles.

VSR The VSR role can use any of the REST APIs to administer any customer orsubscriber in the vendor's organization, for example creating paidsubscriptions or suspending a customer. This role is assigned to the personwho calls the IBM Customer Service Group (CSG) to register the vendor.

CustomerAdministratorWhen a company is created for a customer and its subscribers, at least oneuser with the CustomerAdministrator role is required. The person with theCustomerAdministrator role can manage various operations in a company,for example operations for managing subscribers and subscriptions.

User This role provides users with access to the various services they have beensubscribed to. This role is the most common role in BSS and is held by themost users.

BSS REST services

BSS provides the following categories of REST services:

Table 1. BSS REST services

Services Description

“Customer management services” on page19

Use these APIs to perform administrativeoperations for the customer organization, forexample registering or suspendingcustomers.

Chapter 1. Overview of IBM SmartCloud SaaS Business Support System 5

Table 1. BSS REST services (continued)

Services Description

“Subscriber management services” on page33

Use these APIs to perform administrativeoperations for subscribers, for exampleadding subscribers, removing subscribers,and entitling subscribers to subscriptions.

“Subscription management services” onpage 48

Use these APIs to perform administrativeoperations on subscriptions, for examplecreating or removing subscriptions forcustomers.

“Authentication services” on page 60 Use these APIs to manage credentials, forexample changing and resetting passwords.

For common scenarios that are built around a combination of APIs, see Chapter 4,“Common scenarios,” on page 11. For a complete list of error messages related toBSS REST services, see Chapter 9, “Error messages and user actions,” on page 75.


Chapter 2. Prerequisites

Before using IBM SmartCloud SaaS Business Support System (BSS) APIs, you mustset up a vendor and get authorization to call APIs.

Registering as a new vendor

To register as a new vendor, contact the IBM Customer Support Group (CSG).After you are registered, request your internal customer ID and a vendor ID, sincethese IDs are required when calling certain APIs. Next, you will receive an emailwith a link to set up your initial password.

Obtaining authorization to call APIs

To make BSS API calls, you need to obtain authorization through either BasicAuthentication or Open Authorization (OAuth) 1.0 or 2.0.

Basic Authentication

You can send the API caller credentials, which include user names and passwords,to make API calls. BSS uses the HTTPS protocol to prohibit third parties fromintercepting the HTTPS calls and getting user credentials. However, thisauthorization method is not as secure because it prohibits the application formultiple users unless action is taken to protect the passwords.

OAuth

You can use the three-legged OAuth calling mechanism to call APIs. BSS supportsversions 1.0a and 2.0 of the OAuth protocol. For more information, see OpenAuthorization in the IBM Social Business Development wiki.

7

http://www-10.lotus.com/ldd/appdevwiki.nsf/xpViewCategories.xsp?lookupName=Open%20Authorization

http://www-10.lotus.com/ldd/appdevwiki.nsf/xpViewCategories.xsp?lookupName=Open%20Authorization

Chapter 3. Tools for using BSS APIs

IBM SmartCloud SaaS Business Support System (BSS) APIs are REST based andcan be invoked in variety of programming languages. IBM provides a simple toolfor exploring and testing APIs and some samples for invoking APIs through cURL,a free utility.

BSS API explorer

The BSS API explorer is a tool for experimenting with APIs with no coding. Toaccess the explorer, go to the Lotus® Greenhouse website.

cURL utility

You can use cURL to try and test BSS APIs. cURL is a free utility for making HTTPcalls via a command-line interface. To download cURL, go to the cURL downloadwebsite. Be sure to download the library with SSL support.

To learn more about cURL, try the Using cURL to automate HTTP jobs tutorial onthe cURL website.

Note: BSS APIs were tested with cURL version 7.9.16.

The following examples demonstrate how to invoke BSS APIs. Contact the IBMCustomer Service Group (CSG) to obtain the server-url value.

Get customer with ID (HTTP GET)curl -u [email protected]:somepassword <server-url>/api/bss/resource/customer/12345678

Get subscriber by email address (HTTP GET with query parameters)curl -u [email protected]:somepassword -X GET "<server-url>/api/bss/resource/subscriber?_namedQuery=getSubscriberByEmailAddress&[email protected]"

Note: Be sure to enclose the URL with double quotation marks.

Register customer (HTTP POST)curl -u [email protected]:somepassword -X POST [email protected] <server-url>/api/bss/resource/customer

Unsuspend customer ((HTTP POST with HTTP header)curl -u [email protected]:somepassword -X POST --header"x-operation: unsuspendCustomer" <server-url>/api/bss/resource/customer/12345678

Update customer (HTTP PUT)curl -u [email protected]:somepassword -X PUT [email protected] <server-url>/api/bss/resource/customer/12345678

Delete customer (HTTP DELETE)curl -u [email protected]:somepassword -X DELETE<server-url>/api/bss/resource/customer/12345678

9

https://greenhouse.lotus.com/bssapiexplorer

http://curl.haxx.se/download.html

http://curl.haxx.se/download.html

http://curl.haxx.se/docs/httpscripting.html

Chapter 4. Common scenarios

Learn about common scenarios for using IBM SmartCloud SaaS Business SupportSystem (BSS) REST services and the tasks that are related to each scenario.

Table 2. Common scenarios and related tasks

BSS REST API category Common scenarios Sequence of related tasks

Customer managementservices

Register a customer andthen create a subscriptionfor that customer.

1. “Register customer” on page 19

2. “Create subscription” on page 48for the customer

Update the profile of aregistered customer.Editable attributesinclude organizationname, address, location,contact information, jobtitle and more.

1. Find Customer ID using “Getcustomer list by email address ororganization name” on page 30API

2. “Get customer by ID” on page21

3. “Update customer profile” onpage 24

4. Verify customer profile isupdated using “Get customer byID” on page 21 API

Suspend a registeredcustomer. Suspendedcustomers are moved outof active status andcannot use any services.


2. “Suspend customer” on page 28

3. Verify customer is suspendedusing “Get customer by ID” onpage 21 API

Unsuspend a suspendedcustomer. This actionreturns customers toactive status so they canuse services again.

1. Find customer ID using “Getcustomer list by email address ororganization name” on page 30API

2. “Unsuspend customer” on page28

3. Verify customer is unsuspendedusing “Get customer by ID” onpage 21 API

Delete a customerorganization and all thesubscribers who are partof that organization.


2. “Delete customer” on page 27

3. Verify customer is deleted using“Get customer by ID” on page21 API

Get a list of all thecustomers in the vendor'sorganization.

1. “Get customer list” on page 29

11

Table 2. Common scenarios and related tasks (continued)


Subscription managementservices

Suspend a subscriptionand its childsubscriptions for aregistered customer. Anysubscribers who have aseat entitled to thesubscription aresuspended. However, anyseat that is assigned tosubscribers of thesubscription remain inthe assigned state.


2. Find subscription ID using “Getsubscription list by customer ID”on page 52 API

3. “Suspend subscription” on page50

4. Verify subscription is suspendedusing “Get subscription by ID”on page 54 API

Unsuspend a subscriptionand its childsubscriptions for aregistered customer. Anysubscribers who have aseat entitled to thesubscription are movedfrom suspended to activestate.



3. “Unsuspend subscription” onpage 50

4. Verify subscription isunsuspended using “Getsubscription by ID” on page 54API

Cancel a subscription fora registered customer.This action revokes accessfor all users who areentitled to thesubscription. Note thatcanceled subscriptionsstill exist in the systemuntil you delete thecustomer.



3. “Cancel subscription” on page51

4. Verify subscription is cancelledusing “Get subscription by ID”on page 54 API

Update a subscription fora registered customer tochange the expirationdate or the number ofavailable seats.


2. “Get subscription by ID” onpage 54

3. “Update subscription” on page56

4. Verify the subscription isupdated using “Get subscriptionby ID” on page 54 API

Get a list of subscriptionsfor all the vendor'scustomers.

1. “Get subscription list” on page58




Subscriber managementservices

Add a subscriber eitherto the vendor'sorganization or to theorganization of one of thevendor's customers.

1. Find customer ID using“Getcustomer list by email address ororganization name” on page 30API

2. “Add subscriber” on page 33

3. Verify subscriber is added using“Get subscriber by ID” on page40 API

Entitle a subscriber to anewly createdsubscription. This actionassigns a seat for thesubscriber in thesubscription.

1. “Register customer” on page 19

2. “Create subscription” on page 48for the customer

3. “Add subscriber” on page 33 forthe customer

4. “Entitle subscriber” on page 43to the new subscription

Entitle a subscriber to anexisting subscription.This action assigns a seatfor the subscriber in thesubscription.


2. Find subscriber ID using“Getsubscriber list by customer ID”on page 47 API

3. “Entitle subscriber” on page 43

Get a list of all thesubscribers in thevendor's organization.

1. “Get subscriber list” on page 37

Update the profile of aregistered subscriber.Update details such asname, location, andcontact information.

1. Find subscriber ID using “Getcustomer list by email address ororganization name” on page 30API

2. “Get subscriber by ID” on page40

3. “Update subscriber profile” onpage 35

4. Verify the subscriber profile isupdated using“Get subscriber byID” on page 40 API

Suspend a subscriber.Suspended subscribersare no longer active andcannot use services towhich they are entitled.


2. “Suspend subscriber” on page 41

3. Verify the subscriber issuspended using “Get subscriberby ID” on page 40 API

Chapter 4. Common scenarios 13



Unsuspend a subscriber.This action returnssubscribers to active stateso they can use theservices to which they areentitled.

1. “Get customer list by emailaddress or organization name”on page 30

2. “Unsuspend subscriber” on page42

3. “Get subscriber by ID” on page40

Delete a subscriber froma subscription. Thisaction removessubscribers from theirassigned seats in thesubscription. Thesubscriber must beowned by theorganization of theauthenticated user.

1. Find subscriber ID using “Getcustomer list by email address ororganization name” on page 30ID

2. “Delete subscriber” on page 35

3. Verify the subscriber is deletedusing “Get subscriber by ID” onpage 40 API

Revoke a subscriber froma given subscription.When revokingsubscribers, the seats thatthey currently occupy inthe subscription becomeavailable. This actiondoes not deletesubscribers from thesystem, however.


2. “Get subscription by ID” onpage 54

3. “Revoke subscriber” on page 44

4. Verify the subscriber is revokedusing “Get subscriber by ID” onpage 40 API

Authentication services Change the password ofa subscriber. The currentpassword must beavailable to perform thisaction.

1. “Change password” on page 60

Reset the password for asubscriber when thecurrent password is notavailable. Subscribers areforced to change theirreset passwords the nexttime they log in.

1. “Reset password” on page 61


Chapter 5. Object states

Learn about the life cycle of primary objects such as Customer, Seat, Subscription,and Subscriber. The following images show you how these objects transition fromone state to another.

Customer

15

Seat


Subscription

Chapter 5. Object states 17

Subscriber


Chapter 6. BSS REST services

IBM SmartCloud SaaS Business Support System (BSS) REST services arecategorized by functional area. See the following sections for details.

Customer management servicesUse customer management services to register a customer, get a customer ID,update a customer profile, remove a customer, suspend a customer, and more.

See the following topics for more information.

Register customerCreate a customer organization with a contact person.

The API caller must have the VSR role to run the API.

Table 3. API details

Method Resource address Input representation

POST /resource/customer A JavaScript Object Notation(JSON) entry that representsa customer.

URL parameters

None.

Input attributes

The input attribute must be a well formatted JSON object with the followinginformation.

For examples of valid field values, see Chapter 7, “Common attribute values,” onpage 63.

Table 4. Input attributes

Attribute Required Description

CustomerNumber No Customer number, if it exists.

OrgName Yes Name of the organization.

Phone No Phone number of theorganization.

AddressLine1 Yes Mailing address of theorganization.

AddressLine2 No Additional space for mailingaddress.

City Yes City of residence.

Country Yes Country or region ofresidence.

State Yes State of residence.

19

Table 4. Input attributes (continued)


PostalCode Yes Zip (postal) code for mail.

FamilyName Yes Last name of the primarycontact person.

GivenName Yes First name of the primarycontact person.

EmailAddress Yes Email address of the primarycontact person.

NamePrefix No Name prefix, if one exists.

NameSuffix No Name suffix, if one exists.

EmployeeNumber No Employee number of theperson.

LanguagePreference No Language preference of theperson.

WorkPhone Yes Workplace phone number.

HomePhone No Residential phone number.

MobilePhone No Mobile phone number.

Fax No Fax number.

JobTitle No Job title of the person.

WebSiteAddress No Website address of theperson, if available.

TimeZone No Time zone information.

Photo No Reference to the locationwhere the photo is stored.

AccountNumber Yes Customer account number, ifone exists.

LocationName Yes Name of customer location.

PaymentMethodType No The payment method type.Set as one of the followingvalues: CREDIT_CARD,PURCHASE_ORDER, INVOICE, orNONE.

CurrencyType No Type of currency.

CustomerIdentifierSet No Information about thecustomer identifier. Thisvalue typically does not needto be specified.

Sample payload{"Customer" :

{"CustomerNumber": "9999999999","Organization" : {

"OrgName" : "Test Enterprise","Phone": "555-555-1234","AddressSet" : [ {

"AddressLine1" : "5 Technology Park Drive","AddressLine2" : "",


"AddressType" : "MAILING","City" : "Westford","Country" : "United States","PostalCode" : "01866","State" : "MA"

} ] ,"Contact" : {

"FamilyName" : "Doe","GivenName" : "John","EmailAddress" : "[email protected]","NamePrefix": "Mr","EmployeeNumber":"6A77777","LanguagePreference":"EN_US","WorkPhone": "800-555-1234","MobilePhone": "800-555-2345","HomePhone": "800-555-3456","Fax":"800-555-4567","JobTitle":"Director","WebSiteAddress":"office.example.com","TimeZone":"America/Central","Photo":"",

}} ,

"CustomerAccountSet": [{

"AccountNumber": "0000123456","LocationName": "Westford Lab","PaymentMethodType": "INVOICE","CurrencyType": "USD"}]

}}

Output

When the API call is successful, the ID of the customer is returned, for example:{

"Long" : 1001}

For a list of common HTTP status codes that are returned for API calls, seeChapter 8, “HTTP status codes,” on page 73.

Get customer by IDGet details about a single customer, such as current status and contact information.

The API caller must have either the CustomerAdministrator or VSR role to run theAPI.


Method Resource address Operation header

GET /resource/customer/<id> None

Chapter 6. BSS REST services 21

URL parameters

Provide the following parameter.

Table 6. Parameters

Parameter Required Description

id Yes The internal ID of thecustomer. To obtain the ID,use one of the GET methodsthat are defined in the “Getcustomer list by emailaddress or organizationname” on page 30 topic.


Output

See the following sample HTTP response:



Update customer profileUpdate the profile of a single customer who is part of the organization of theauthenticated user. Editable attributes include organization name, address, location,contact information, job title and more.

The API caller must have either the CustomerAdministrator or VSR role to run theAPI.



PUT /resource/customer/<id> A JavaScript Object Notation(JSON) entry that representsthe customer whose profileneeds to be updated.

URL parameters


Table 8. Parameters



Input attributes

The input attribute must be a well formatted JSON object. You can update only theattributes that are listed in the following table.


Table 9. Attributes


CustomerNumber No Customer number, if it exists.

OrgName Yes Name of the organization.

Phone No Phone number of theorganization.

AddressLine1 Yes Mailing address of theorganization.

AddressLine2 No Additional space for mailingaddress.

City Yes City of residence.


Table 9. Attributes (continued)


Country Yes Country or region ofresidence.

State Yes State of residence.

PostalCode Yes Zip (postal) code for mail.








WorkPhone Yes Workplace phone number.



Fax No Fax number.





AccountNumber Yes Customer account number, ifone exists.

LocationName Yes Name of customer location.

PaymentMethodType No The payment method type.Set as one of the followingvalues: CREDIT_CARD,PURCHASE_ORDER, INVOICE, orNONE.

CurrencyType No Type of currency.

Sample payload


Avoiding stale payload error

If you use a stale payload, the following error occurs. To avoid the error, first usethe “Get customer by ID” on page 21 to obtain the payload.


{"BSSResponse": {"ResponseMessage": "Internalservererror","ExceptionMessage":"StaleObjectStateExceptionOccured-Rowwasupdatedordeletedbyanothertransaction.",

"ResponseCode": "500"}}

Output

If the profile update is successful, nothing is returned. To retrieve the payload andverify your changes, see the “Get customer by ID” on page 21 topic for detailsabout performing a GET operation.


Delete customerUnregister a customer organization using the internal ID of the customer. Whenyou unregister an organization, all subscribers of that customer are deleted, and allsubscriptions are cancelled. The customer must be owned by the organization ofthe authenticated user.




DELETE /resource/customer/<id> None

URL parameters


Table 11. Parameters



Output

If the update is successful, no data is returned. To retrieve the payload and verifythat the customer is deleted, see the “Get customer by ID” on page 21 topic fordetails about performing a GET operation.



Suspend customerChange the status of a single customer from active to suspended. A customer whois suspended cannot use any services.


To allow customers to reuse services, see the “Unsuspend customer” topic.



POST /resource/customer/<id> x-operation:suspendCustomer

URL parameters





Output

If the update is successful, no data is returned. To retrieve the payload and verifythat the customer is suspended, see the “Get customer by ID” on page 21 topic fordetails about performing a GET operation.


Unsuspend customerChange the status of a single customer from suspended to active. Only activecustomers can use services.




POST /resource/customer/<id> x-operation:unsuspendCustomer


URL parameters





Output

If the update is successful, no data is returned. To retrieve the payload and verifythat the customer is unsuspended, see the “Get customer by ID” on page 21 topicfor details about performing a GET operation.


Get customer listGet a list of all customers who are part of the vendor's organization.




GET /resource/customer None

URL parameters

None.

Input attributes

None.


Output



Get customer list by email address or organization nameGet a list of customers by either their email addresses or organization names.




Method Resource address Description

GET resource/customer?_namedQuery=getCustomersByContactEmail&emailAddress=<email>

Get a customer list by the email address ofthe contact person.

GET resource/customer?_namedQuery=getCustomersBySubscriberEmail&emailAddress=<email>

Get a customer list by the email address ofthe subscriber.

GET resource/customer?_namedQuery=getCustomerByOrgName&orgName=<orgName>

Get a customer list by the organization name.

Operation header

None.

URL parameters

Provide the following parameters:



email Yes The email address of the contact person orsubscriber.

orgName Yes The name of the organization.

Input attributes

None.


Output


Examples

resource/customer?_namedQuery=getCustomersByContactEmail&[email protected]

resource/customer?_namedQuery=getCustomersBySubscriberEmail&[email protected]

resource/customer?_namedQuery=getCustomerByOrgName&orgName=ABC_Lab



Subscriber management servicesUse subscriber management services to add subscribers, delete subscribers, get listsof subscribers, revoke subscribers, and more.


Add subscriberAdd a subscriber either to the vendor's organization or to the organization of oneof the vendor's customers.

The API caller must have one of the following roles to run the API:v CustomerAdministratorv Userv VSR



POST /resource/subscriber A JavaScript Object Notation(JSON) entry that representsa subscriber.

URL parameters

None.

Input attributes

The input attribute must be a well formatted JSON object with followinginformation.




CustomerId Yes The ID of the customer withwhom the subscriber isassociated.

RoleSet Yes The list of roles that need tobe granted to the user. Validvalues include:

v CustomerAdministrator

v User

v VSR











WorkPhone No Workplace phone number.



Fax No Fax number.





Sample payload{

"Subscriber": {"CustomerId": "20000051","Person": {

"RoleSet": ["CustomerAdministrator"

],"FamilyName": "Doe","GivenName": "John","EmailAddress": "[email protected]","NamePrefix": "Mr","NameSuffix": "","EmployeeNumber": "6A7777B","LanguagePreference": "EN_US","WorkPhone": "111-111-1111","MobilePhone": "111-111-1112","HomePhone": "111-111-1113","Fax": "111-111-1114","JobTitle": "Director","WebSiteAddress": "www.example.com","TimeZone": "America/Central","Photo": ""

}}

}

Output

When the API call is successful, the ID of the subscriber is returned, for example:{

"Long": 20000001}



Delete subscriberDelete a subscriber from an organization. This action also frees the assigned seatsto the subscribers. The subscriber must be owned by the organization of theauthenticated user.




DELETE /resource/subscriber/<id> None

URL parameters




id Yes The ID of the subscriber. Toobtain the ID, see the “Getsubscriber list by emailaddress” on page 44 and“Get subscriber list bycustomer ID” on page 47topics.


Update subscriber profileUpdate the profile of a registered subscriber. Update details such as name, location,and contact information.




PUT /resource/subscriber/<id> A JavaScript Object Notation(JSON) entry that representsthe subscriber.


URL parameters




id Yes The ID of the subscriber tobe updated. To obtain the ID,see the “Get subscriber listby email address” on page44 and “Get subscriber listby customer ID” on page 47topics.

Input attributes

The input attribute must be a well formatted JSON object with followinginformation. You can edit only the following list of attributes.




RoleSet Yes The list of roles that need tobe granted to the user. Validvalues include:

v CustomerAdministrator

v User

v VSR








WorkPhone No Workplace phone number.



Fax No Fax number.








Note: To retrieve the most current payload information, see the “Get subscriber byID” on page 40 topic to perform a GET operation. Then modify the payload youreceive and submit it as part of the update.

Sample payload


Get subscriber listGet a list of subscribers who are in the same organization as the API caller.Subscribers from the caller's immediate organization and subscribers from all childorganizations are returned in a single list.





GET /resource/subscriber None

URL parameters

None.

Input attributes

None.


Output

A list of subscribers is returned. See the following sample HTTP response:



Get subscriber by IDGet details about a single subscriber.




GET /resource/subscriber/<id> None

URL parameters





Output

Information about the subscriber is returned. See the following sample HTTPresponse:



Suspend subscriberSuspend a subscriber. Suspended subscribers are no longer active and cannot useservices to which they are entitled.

The API caller must have either the VSR or CustomerAdministrator role to run theAPI.

To allow subscriber to reuse services, see the “Unsuspend subscriber” on page 42topic.



POST /resource/subscriber/<id> x-operation:suspendSubscriber


URL parameters

Provide the following parameter:




Input attributes

None.


Unsuspend subscriberUnsuspend a subscriber. This action returns subscribers to active state so they canuse the services to which they are entitled.




POST /resource/subscriber/<id> x-operation:unSuspendSubscriber

URL parameters





Input attributes

None.



Entitle subscriberEntitle a subscriber to a subscription. This action assigns a seat for the subscriberin the subscription.




POST resource/subscriber/<subscriber_id>/subscription/<subscription_id>

x-operation: entitleSubscriber

URL parameters

Provide the following parameters.



subscriber_id Yes The ID of the subscriber. Toobtain the ID, see the “Getsubscriber list by emailaddress” on page 44 and“Get subscriber list bycustomer ID” on page 47topics.

subscription_id Yes The ID of the subscription.To obtain the ID, see the“Get subscription list” onpage 58 and “Getsubscription list by customerID” on page 52 topics.

Input attributes

None.

Output

A map that contains the seat ID and the subscription ID is returned. For example,if you post the resource/subscriber/30099153/subscription/1 resource address,the map returns a seat ID of 1244:{

"HashMap": {"Value": [

1244],"Key": [

1]

}}



Revoke subscriberRevoke a subscriber from a given subscription. When revoking subscribers, theseats that they currently occupy in the subscription become available. This actiondoes not delete subscribers from the system, however.




POST resource/subscriber/<subscriber_id>/seat/<seat_id>

x-operation: revokeSubscriber

URL parameters

Provide the following parameters.



subscriber_id Yes The ID of the subscriber. Toobtain the ID, see the “Getsubscriber list by emailaddress” and “Get subscriberlist by customer ID” on page47 topics.

seat_id Yes The ID of the seat that isbeing revoked. To obtain theID, see the “Get subscriberlist by email address” and“Get subscriber list bycustomer ID” on page 47topics.

Input attributes

None.


Get subscriber list by email addressGet a list of subscribers with a given email address.





GET resource/subscriber?_namedQuery=getSubscriberByEmailAddress&emailAddress=<email>

None

URL parameters




email Yes The email address of thesubscriber.

Input attributes

None.

Output

A list of subscribers that meet the criteria of the query parameters is returned. Seethe following sample HTTP response:


Get subscriber list by customer IDGet a list of all subscribers for a customer with a given ID.




GET resource/subscriber?_namedQuery=getSubscriberByCustomer&customer=<id>

None

URL parameters





Input attributes

None.

Output

A list of subscribers that meet the criteria of the query parameters is returned. Seethe following sample HTTP response:



Subscription management servicesUse subscription management services to create subscriptions, suspendsubscriptions, get subscriptions by ID, and more.


Create subscriptionCreate one or more subscriptions for a given customer.




POST /resource/subscription A JavaScript Object Notation(JSON) entry that representsa subscription order.

URL parameters

None.


Input attributes

The input attribute must be a well formatted JSON object with the followinginformation.



DurationUnits Yes The unit of duration. Validvalue is YEARS.

DurationLength Yes The duration of thesubscription. Any positivenumeric value is valid.

PartNumber Yes The part number of theservice offering. Check yourservice contract for a list ofvalues.

PartQuantity Yes The quantity of the serviceoffering.

CustomerId Yes The ID of the customer forwhom the subscription isbeing created.

BillingFrequency No The frequency for billing.Valid values include MRC,QRC, and ARC.

ServiceCode No The value for the servicecode. This value typicallydoes not need to bespecified.

OrderNumber No The order number for thepurchase order. The defaultvalue is RESELLER-ORDER.This value typically does notneed to be specified.

OrderItemAttributeSet No An optional set of attributesfor the purchase order. Theseattributes are only neededwhen performing add-onoperations. This valuetypically does not need to bespecified.

Sample payload{

"Order": {"OrderItemSet": [

{"DurationUnits": "YEARS","DurationLength": 2,"PartNumber": "D08SWLL","PartQuantity": 5

},{

"DurationUnits": "YEARS","DurationLength": 1,"PartNumber": "D08S1LL","PartQuantity": 95


}],"CustomerId": 30097263

}}

Output

When the API call is successful, a list of subscription IDs and part numbers arereturned, for example:{"List":[{"SubscriptionId":16697,"PartNumber":"D08SWLL"},{"SubscriptionId":16698,"PartNumber":"D08S1LL"}]}


Suspend subscriptionSuspend a subscription and its child subscriptions for a registered customer.

Any subscribers who have a seat entitled to the subscription are suspended.However, any seat that is assigned to subscribers of the subscription remain in theassigned state.




POST /resource/subscription/<id>

x-operation:suspendSubscription

URL parameters




id Yes The ID of the subscriptionthat needs to be suspended.

Output

To verify that the subscription is suspended, see the “Get subscription by ID” onpage 54 topic for details about performing a GET operation.


Unsuspend subscriptionChange the status of a subscription from suspended to active. Child subscriptionsare also moved to active state.

Any subscribers who have a seat entitled to the subscription are moved fromsuspended to active state. If the subscription is a pooled child subscription, theparent subscription is also moved to active state.





POST /resource/subscription/<id>

x-operation:unsuspendSubscription

URL parameters




id Yes The ID of the subscriptionthat is being unsuspended.

Output

To verify that the subscription is unsuspended, see the “Get subscription by ID” onpage 54 topic for details about performing a GET operation.


Cancel subscriptionCancel a subscription to revoke access for all users who are entitled to thesubscription.

After you cancel the subscription, you can mark the subscription as deleted bydeleting the customer. See the “Delete customer” on page 27 topic for more details.




DELETE /resource/subscription/<id>

None.

URL parameters




id Yes The ID of the subscription tobe canceled.



Get subscription list by customer IDGet a list of subscriptions that belong to a particular customer.




GET resource/subscription?_namedQuery=getSubscriptionByCustomer&customerId=<cust-id>

None

URL parameters




cust-id Yes The ID of the customer whoowns the subscription.


Output

See the following example output:



Get subscription by IDUse the subscription ID to locate a subscription and get details about thatsubscription.




GET /resource/subscription/<id>

None.

URL parameters




id Yes The ID of the subscription.


Output




Update subscriptionUpdate a subscription for a registered customer to change the expiration date orthe number of available seats. The subscription must be owned by the organizationof the authenticated user.




PUT /resource/subscription/<id>

A JavaScript Object Notation(JSON) entry that representsa subscription.

URL parameters


Table 54. URL parameters


id Yes The ID of the subscription tobe updated. To obtain the ID,see the “Get subscription listby customer ID” on page 52topic.

Input attributes

The input attribute must be a well formatted JSON object with followinginformation. You can update only the following two attributes.

Table 55. Attributes

Attribute Description

ExpirationDate The date the subscription expires.

NumberOfSeats The number of service offerings.

Note: To retrieve the most current payload information, see the “Get subscriptionby ID” on page 54 topic to perform a GET operation. Then modify the payloadyou receive and submit it as part of the update.

Sample payload


Output

If the update is successful, nothing is returned. To verify your changes, see the“Get subscription by ID” on page 54 topic to perform a GET operation.



Get subscription listGet a list of subscriptions for all the vendor's customers.




GET /resource/subscription None.

URL parameters

None.


Output




Authentication servicesUse authentication services to change and reset passwords.


Change passwordChange the password of a subscriber. The current password must be available toperform this action.




POST service/authentication/changePassword

A JavaScript Object Notation(JSON) entry that representsa subscriber.

URL parameters

None.

Input attributes

The input attribute must be a well formatted JSON object with followinginformation.



LoginName Yes The email address of theuser.

OldPassword Yes The current password for theuser.

NewPassword Yes The new password for theuser.

ConfirmPassword Yes The confirmed newpassword of the user.

Sample payload{

"UserCredential": {"LoginName": "JohnDoe@example","OldPassword": "Pa88w0rd","NewPassword": "Pa77w0rd","ConfirmPassword": "Pa77w0rd"

}}



Reset passwordReset the password for a subscriber when the current password is not available.Subscribers are forced to change their reset passwords the next time they log in.




POST service/authentication/resetPassword?loginName=<loginName>

None

URL parameters




loginName Yes The email address of theuser, for [email protected].


Set one-time passwordSet a one-time password for users after performing checks against the passwordpolicy. Users can log in with this password only once and must change thepassword the next time they log in.



POST service/authentication/setOneTimePassword None

Input

See the following sample HTTP request:{ "UserCredential" :

{

"LoginName":"[email protected]",

"NewPassword":"asdfggdf1",

}}


For LoginName, specify the login ID or email address of the user. For NewPassword,specify the one-time password for the user.

Output

None.



Chapter 7. Common attribute values

When specifying values for input attributes, use the following examples of validvalues.

Phone, WorkPhone, HomePhone, MobilePhone, and Fax

Any combination of digits, spaces, and hyphens are allowed, for example1234-45678. Dots and brackets are not allowed.

StateCode, State, Country

StateCode State Country

AB Alberta CANADA

AK ALASKA USA

AL ALABAMA USA

AR ARKANSAS USA

AZ ARIZONA USA

BC BRITISH COLUMBIA CANADA

CA CALIFORNIA USA

CO COLORADO USA

CT CONNECTICUT USA

DC DISTRICT OF COLUMBIA USA

DE DELAWARE USA

FL FLORIDA USA

GA GEORGIA USA

HI HAWAII USA

IA® IOWA USA

ID IDAHO USA

IL ILLINOIS USA

IN INDIANA USA

KS KANSAS USA

KY KENTUCKY USA

LA LOUISIANA USA

MA MASSACHUSETTS USA

MB MANITOBA CANADA

MD MARYLAND USA

ME MAINE USA

MI MICHIGAN USA

MN MINNESOTA USA

MO MISSOURI USA

MS MISSISSIPPI USA

MT MONTANA USA

63

StateCode State Country

NB NEW BRUNSWICK CANADA

NC NORTH CAROLINA USA

ND NORTH DAKOTA USA

NE NEBRASKA USA

NF NEWFOUNDLAND CANADA

NH NEW HAMPSHIRE USA

NJ NEW JERSEY USA

NM NEW MEXICO USA

NS NOVA SCOTIA CANADA

NT NORTHWEST TERRITORIES CANADA

NV NEVADA USA

NY NEW YORK USA

OH OHIO USA

OK OKLAHOMA USA

ON ONTARIO USA

OR OREGON USA

PA PENNSYLVANIA USA

PE PRINCE EDWARD ISLAND CANADA

PQ QUEBEC CANADA

RI RHODE ISLAND USA

SC SOUTH CAROLINA USA

SD SOUTH DAKOTA USA

SK SASKATCHEWAN CANADA

TN TENNESSEE USA

TX TEXAS USA

UT UTAH USA

VA VIRGINIA USA

VT VERMONT USA

WA WASHINGTON USA

WI WISCONSIN USA

WV WEST VIRGINIA USA

WY WYOMING USA

YT YUKON TERRITORY CANADA

Country, CountryCode

Country CountryCode

AFGHANISTAN AF

ALAND.ISLANDS AX

ALBANIA AL

ALGERIA DZ


Country CountryCode

AMERICAN.SAMOA AS

ANDORRA AD

ANGOLA AO

ANGUILLA AI

ANTARCTICA AQ

ANTIGUA.AND.BARBUDA AG

ARGENTINA AR

ARMENIA AM

ARUBA AW

AUSTRALIA AU

AUSTRIA AT

AZERBAIJAN AZ

BAHAMAS BS

BAHRAIN BH

BANGLADESH BD

BARBADOS BB

BELARUS BY

BELGIUM BE

BELIZE BZ

BENIN BJ

BERMUDA BM

BHUTAN BT

BOLIVIA BO

BOSNIA.AND.HERZEGOVINA BA

BOTSWANA BW

BOUVET.ISLAND BV

BRAZIL BR

BRITISH.INDIAN.OCEAN.TERRITORY IO

BRUNEI.DARUSSALAM BN

BULGARIA BG

BURKINA.FASO BF

BURUNDI BI

CAMBODIA KH

CAMEROON CM

CANADA CA

CAPE.VERDE CV

CAYMAN.ISLANDS KY

CENTRAL.AFRICAN.REPUBLIC CF

CHAD TD

CHILE CL

CHINA CN

Chapter 7. Common attribute values 65

Country CountryCode

CHRISTMAS.ISLAND CX

COCOS.(KEELING).ISLANDS CC

COLOMBIA CO

COMOROS KM

CONGO CG

CONGO.THE.DEMOCRATIC.

REPUBLIC.OF.THE

CD

COOK.ISLANDS CK

COSTA.RICA CR

COTE.D'IVOIRE CI

CROATIA HR

CYPRUS CY

CZECH.REPUBLIC CZ

DENMARK DK

DIJIBOUTI DJ

DOMINICA DM

DOMINICAN.REPUBLIC DO

ECUADOR EC

EGYPT EG

EL.SALVADOR SV

EQUATORIAL.GUINEA GQ

ERITREA ER

ESTONIA EE

ETHIOPIA ET

FALKLAND.ISLANDS.(MALVINAS) FK

FAROE.ISLANDS FO

FIJI FJ

FINLAND FI

FRANCE FR

FRENCH.GUIANA GF

FRENCH.POLYNESIA PF

FRENCH.SOUTHERN.TERRITORIES TF

GABON GA

GAMBIA GM

GEORGIA GE

GERMANY DE

GHANA GH

GIBRALTAR GI

GREECE GR

GREENLAND GL


Country CountryCode

GRENADA GD

GUADELOUPE GP

GUAM GU

GUATEMALA GT

GUERNSEY GG

GUINEA GN

GUINEA-BISSAU GW

GUYANA GY

HAITI HT

HEARD.ISLAND.AND.

MCDONALD.ISLANDS

HM

HOLY.SEE.(VATICAN.CITY.STATE) VA

HONDURAS HN

HONG.KONG HK

HUNGARY HU

ICELAND IS

INDIA IN

INDONESIA ID

IRAQ IQ

IRELAND IE

ISLE.OF.MAN IM

ISRAEL IL

ITALY IT

JAMAICA JM

JAPAN JP

JERSEY JE

JORDAN JO

KAZAKHSTAN KZ

KENYA KE

KIRIBATI KI

KOREA.REPUBLIC.OF KR

KUWAIT KW

KYRGYZSTAN KG

LAO.PEOPLE'S.DEMOCRATIC.REPUBLIC LA

LATVIA LV

LEBANON LB

LESOTHO LS

LIBERIA LR

LIBYAN.ARAB.JAMAHIRIYA LY

LIECHTENSTEIN LI


Country CountryCode

LITHUANIA LT

LUXEMBOURG LU

MACAO MO

MACEDONIA.THE.FORMER.

YUGOSLAV.REPUBLIC.OF

MK

MADAGASCAR MG

MALAWI MW

MALAYSIA MY

MALDIVES MV

MALI ML

MALTA MT

MARSHALL.ISLANDS MH

MARTINIQUE MQ

MAURITANIA MR

MAURITIUS MU

MAYOTTE YT

MEXICO MX

MICRONESIA.FEDERATED.STATES.OF FM

MOLDOVA.REPUBLIC.OF MD

MONACO MC

MONGOLIA MN

MONTENEGRO ME

MONTSERRAT MS

MOROCCO MA

MOZAMBIQUE MZ

NAMIBIA NA

NAURU NR

NEPAL NP

NETHERLANDS NL

NETHERLANDS.ANTILLES AN

NEW.CALEDONIA NC

NEW.ZEALAND NZ

NICARAGUA NI

NIGER NE

NIGERIA NG

NIUE NU

NORFOLK.ISLAND NF

NORTHERN.MARIANA.ISLANDS MP

NORWAY NO

OMAN OM


Country CountryCode

PAKISTAN PK

PALAU PW

PALESTINIAN.TERRITORY.OCCUPIED PS

PANAMA PA

PAPUA.NEW.GUINEA PG

PARAGUAY PY

PERU PE

PHILIPPINES PH

PITCAIRN PN

POLAND PL

PORTUGAL PT

PUERTO.RICO PR

QATAR QA

ROMANIA RO

RUSSIAN.FEDERATION RU

RWANDA RW

RUNION RE

SAINT.BARTHLEMY BL

SAINT.HELENA SH

SAINT.KITTS.AND.NEVIS KN

SAINT.LUCIA LC

SAINT.MARTIN MF

SAINT.PIERRE.AND.MIQUELON PM

SAINT.VINCENT.AND.THE.GRENADINES VC

SAMOA WS

SAN.MARINO SM

SAO.TOME.AND.PRINCIPE ST

SAUDI.ARABIA SA

SENEGAL SN

SERBIA RS

SEYCHELLES SC

SIERRA.LEONE SL

SINGAPORE SG

SLOVAKIA SK

SLOVENIA SI

SOLOMON.ISLANDS SB

SOMALIA SO

SOUTH.AFRICA ZA

SOUTH.GEORGIA.AND.THE.

SOUTH.SANDWICH.ISLANDS

GS


Country CountryCode

SPAIN ES

SRI.LANKA LK

SURINAME SR

SVALBARD.AND.JAN.MAYEN SJ

SWAZILAND SZ

SWEDEN SE

SWITZERLAND CH

TAIWAN TW

TAJIKISTAN TJ

TANZANIA.UNITED.REPUBLIC.OF TZ

THAILAND TH

TIMOR-LESTE TL

TOGO TG

TOKELAU TK

TONGA TO

TRINIDAD.AND.TOBAGO TT

TUNISIA TN

TURKEY TR

TURKMENISTAN TM

TURKS.AND.CAICOS.ISLANDS TC

TUVALU TV

UGANDA UG

UKRAINE UA

UNITED.ARAB.EMIRATES AE

UNITED.KINGDOM GB

UNITED.STATES US

UNITED.STATES.MINOR.

OUTLYING.ISLANDS

UM

URUGUAY UY

UZBEKISTAN UZ

VANUATU VU

VENEZUELA.BOLIVARIAN.REPUBLIC.OF VE

VIETNAM VN

VIRGIN.ISLANDS.BRITISH VG

VIRGIN.ISLANDS.U.S. VI

WALLIS.AND.FUTUNA WF

WESTERN.SAHARA EH

YEMEN YE

ZAMBIA ZM

ZIMBABWE ZW


LanguagePreference

LanguagePreference Description

en_US English (United States)

pt_BR Portuguese (Brazil)

zh_CN Chinese (simplified)

zh_TW Chinese (traditional)

fr_FR French (France)

de_DE German (Germany)

it_IT Italian (Italy)

ja_JP Japanese (Japan)

ko_KR Korean (Korea)

es_ES Spanish (Castilian)

nl_NL Dutch (Netherlands)

sv_SE Swedish (Sweden)

no_NO Norwegian (Nynorsk)

da_DK Danish (Denmark)

fi_FI Finnish (Finland)

ca_ES Catalan (Spain)

el_GR Greek (Greece)

tr_TR Turkish (Turkey)

pt_PT Portuguese (Portugal)

th_TH Thai (Thailand)

ru_RU Russian (Russia)

pl_PL Polish (Poland)

TimeZone

TimeZone Description

HST HAWAII/ALEUTIAN STANDARD TIME

AST ALASKA STANDARD TIME

YST YUKON STANDARD TIME

PST PACIFIC STANDARD TIME

MST MOUNTAIN STANDARD TIME

CST CENTRAL STANDARD TIME

EST EASTERN STANDARD TIME

AST ATLANTIC STANDARD TIME

NST NEWFOUNDLAND STANDARD TIME

CurrencyType

CurrencyType Description

USD US Dollar


CurrencyType Description

EUR Euro

CAD Canadian Dollar

AUD Australian Dollar

NZD New Zealand Dollar

INR Indian Rupees

GBP Great Britain Pound

JPY Yen

WON South Korean Won


Chapter 8. HTTP status codes

The IBM SmartCloud SaaS Business Support System (BSS) APIs return HTTP statuscodes for every request.

See the following table for details.

Table 62. HTTP status codes and explanations

HTTP responsecodes Description

200 The client successfully requested the contents of a single resource.

201 The operation on the server was completed successfully.

202 This request results in asynchronous processing on the server.

204 The request resulted in the successful creation, update, or deletion ofthe resource.

206 The client requested the contents of more than one resource from theserver.

304 The client made a request to view content that has not been updatedsince the last time the same request was submitted to the server.

400 The client submitted a request that is malformed, for example anillegal argument, a missing argument, or incomprehensibleJavaScript Object Notation (JSON).

401 The client tried to invoke an operation on a resource without propercredentials.

403 The client sent a request to a resource that the server is currently notmaking available due to an authorization error.

404 The client requested an operation on a resource that does not exists.

405 The client is trying to perform an operation on a resource that is notsupported.

409 The client request cannot be submitted because it would put theresource in an inconsistent state, for example trying to delete acustomer account that has active subscriptions.

500 The client submitted a request that caused a server-side exceptionthat does not match any existing response codes.

503 The client submitted a request to a server that is busy with othertasks.

73

Chapter 9. Error messages and user actions

IBM SmartCloud SaaS Business Support System (BSS) error messages are providedto help you identify and solve issues as they occur.

Table 63. BSS error messages

Code Message User action

BZSAP1000E A schema for the payload cannot befound.

Provide a schema for the payload.

BZSAP1001E The input payload cannot be found. Provide an input payload.

BZSAP1002E A \"default\" value for the [{0}]reserved attribute is required in theschema.

Provide a default value value forthe reserved attribute in the schema.

BZSAP1003E A schema error occurred because the[{0}] key has an invalid type.

Provide a valid type for the [{0}]key.

BZSAP1004E A schema error occurred because the\"properties\" value for [{0}] cannot befound in the schema definition.

Provide a \"properties\" value for[{0}] in the schema definition.

BZSAP1005E A schema error occurred because thearray ({0}) element {1} has an invalidtype.

Provide a valid type of array ({0})element {1}.

BZSAP1006E A schema error occurred because the\"items\" value for the [{0}] array typecannot be found.

Provide the \"items\" value for the[{0}] array type.

BZSAP1007E A payload error occurred because therequired {0} field cannot be found inthe input JavaScript Object Notation(JSON).

Provide the required {0} field in theinput payload.

BZSAP1008E The schema in the {0} file is invalid. Provide a valid schema in the {0}file.

BZSAP1009E The location ($loc) that was providedas a property for {0} is invalid.

Provide a valid location propertyfor {0}.

BZSAP1010E An error occurred when specifying\"filters\" in the schema for the [{0}]field.

Provide valid \"filters\" in theschema for the [{0}] field.

BZSAP1011E The [{0}] input value that was providedfor the [{1}] field is invalid.

Provide a valid input value for the[{0}] field.

BZSAP1012E The minimum length of the {0} stringfield must be {1}.

Provide a string that meets therequirements for minimum length.

BZSAP1013E The maximum length of the {0} stringfield must be {1}.

Provide a string that meets therequirements for maximum length.

BZSAP1014E The minimum length of the {0} numberfield must be {1}.

Provide a number that meets therequirements for minimum length.

BZSAP1015E The maximum length of the {0}number field must be {1}.

Provide a number that meets therequirements for maximum length.

BZSAP1016E The minimum length of the {0} arrayfield must be {1}.

Provide an array that meets therequirements for minimum length.

75

Table 63. BSS error messages (continued)


BZSAP1017E The maximum length of the {0} arrayfield must be {1}.

Provide an array that meets therequirements for maximum length.

BZSAP1018E An integer value is required for \"" {0}"\" in the schema.

Provide an integer value for {0} inthe schema.

BZSAP1019E Values for enumeration filters(EnumFilter) must be supplied as anarray in the schema.

Provide an EnumFilter value as anarray in the schema.

BZSAP1020E The API path is not supported. Check that the API path is correct.

BZSAP1021E The API path is not valid. Check that the API path is valid.

BZSAP1022E The {0} query parameter with {1}values is not allowed.

Provide the correct query parameterand values.

BZSAP1024E An internal error occurred whenreading the API descriptor files.

Provide the correct API descriptorfile.

BZSAP1025E The JavaScript Object Notation (JSON)schema is invalid.

Provide the correct JSON schema.

BZSAP1026E The input payload is not validJavaScript Object Notation (JSON).

Provide an input payload with validJSON.

BZSAP1027E The user ID and password combinationis incorrect.

Provide the correct user ID andpassword.

BZSAP1028E Authorization failed when attemptingto make the call.

Check that you have been assignedthe correct privileges and roles toperform this operation.

BZSAP1029E An unexpected error occurred. Retry your request since the serverencountered an unexpectedcondition that prevented it fromfulfilling the request.

BZSAP1030E The input parameters are not valid. Provide the correct inputparameters.

BZSAP1031E The payload is required in the request. Provide the correct payload for thisoperation in the request.

BZSAP1032I The API call succeeded. This message is for informationonly. No user action is required.

BZSAP1033E The [{0}] field requires a string value. Provide a valid string value for the[{0}] field.

BZSAP1034E The value of the page size must bebetween 1 and 100.

Provide a page size value between 1and 100.

BZSAP1035E The value of the page number must bebetween 1 and 100.

Provide a page number valuebetween 1 and 100.

BZSAP1036E The input URL or parameters arewrong.

Provide the correct inputparameters or URL.

BZSCC1000E Either an unknown or third-party erroroccurred.

Check the error message for details,or contact your systemadministrator.

BZSCC1001E The data that you requested cannot befound.

Check that you are querying for avalid value.




BZSCC1002E The action is forbidden and cannot becompleted.

Confirm that you are logged in withthe correct credentials and that yourquery is requesting information thatbelongs to your organization.

BZSCC1003E An internal server error occurred. Contact your system administrator.

BZSCC1004E The request cannot be completedbecause it cannot be mapped to theURL and the input JavaScript ObjectNotation (JSON).

Check the documentation toconfirm that the JSON input is wellformatted and that the requestmaps to a valid URL.

BZSCC1005E The action is unauthorized and cannotbe completed.

Confirm that you are logged in withthe correct credentials and that yourquery is requesting information thatbelongs to your organization.

BZSCC1006E Not Acceptable Confirm that you are logged in withthe correct credentials and that yourquery is requesting information thatbelongs to your organization.

BZSCC1007E The service for the given UniformResource Identifier (URI) is invalid.

Check that the name of the serviceis valid.

BZSCC1008E The user with the following emailaddress was not found: {0}.

Check that the email address iscorrect and that it exists in thedatabase.

BZSCC1009E The content type is missing for theinput data.

Set the Content-Type attribute forthe input data.

BZSCC1010E Pagination parameters are required forthe {0} operation.

Provide pagination parameters, andtry the operation again.

BZSCC1011E A format error occurred becauseparameters are missing from the URL.

Append parameters to the URL.

BZSCC1012E A format error occurred because themethod arguments are insufficient.

Append parameters to the URL.

BZSCC1013E An exception occurred when readingdata from the POST request.

Confirm that the post data is in thecorrect format.

BZSCC1014E An exception occurred whentranslating the JavaScript ObjectNotation (JSON) string into a domainobject.

Check the documentation toconfirm that the post JSON data iswell formatted.

BZSCC1015E The request URL is not in the correctformat.

Check the documentation toconfirm that the request URL is inthe correct format.

BZSCC1016E An error occurred when loading thevalidation properties of the UniformResource Identifier (URI).

Ask your system administrator toconfirm that the application isinstalled correctly.

BZSCC1017E The Uniform Resource Identifier (URI)is invalid.

Check the URI of the request toconfirm that it matches the URIdescribed in the documentation.

BZSCC1018E The Uniform Resource Identifier (URI)or operation header is invalid.

Check the URI and operationheader of the request to confirmthat they match the URI andoperation header described in thedocumentation.

Chapter 9. Error messages and user actions 77



BZSCC1019E The request method is not supported. Check the request method toconfirm that it matches the methoddescribed in the documentation.

BZSCC1020E An exception occurred whenprocessing the Uniform ResourceIdentifier (URI).

Check the request URL and inputstring (if any) to confirm that theymatch the format described in thedocumentation.

BZSCC1021E The URL cannot be accessed becauseeither the operation is not supportedby the service, or the service does notexist.

Check the request URL to confirmthat it matches the format describedin the documentation.

BZSCC1022E The following error occurred becausethe input is not valid: {0}.

Check that the field is validaccording to the documentation.

BZSCC1023E The resource owner cannot be found inthe access check.

Ask the system administrator toconfirm that the resource ownercheck Uniform Resource Identifier(URI) is well formed.

BZSCC1024E Data cannot be found for {0} {1}. Ask the system administrator toconfirm that the authenticated userhas access to the resource and thatthe URL is correct.

BZSCC1025E The following class name is invalid:{0}.

Confirm that the field name iscorrect according to thedocumentation.

BZSCC1026E The JavaScript Object Notation (JSON)code is invalid for the {0} key.

Confirm that the JSON code for thekey is correct according to thedocumentation.

BZSCC1027E The {0} JavaScript Object Notation(JSON) key is invalid.

Check that the key mentioned iscorrect according to thedocumentation.

BZSCC1028E The input JavaScript Object Notation(JSON) is invalid.

Check that the input JSON is correctaccording to the documentation.

BZSCC1029E The value for the JavaScript ObjectNotation (JSON) field is invalid.

Check that the value of the field isvalid for the field type. See thedocumentation for details.

BZSCC1030E The format of the Uniform ResourceIdentifier (URI) is not supported.

Check that the request URI is wellformatted according to thedocumentation.

BZSCC1031E The format of the Uniform ResourceIdentifier (URI) is not supported. Either{0} or {1} is missing.

Check that the request URL has theproper format and that theparameters that are mentioned inthe message exist in the URL.

BZSCC1032E The format of the Uniform ResourceIdentifier (URI) is not supported. The{0} operator is not supported for the {1}Advance Get operation.

Check that the request URL has theproper format and that the correctoperator is being used.

BZSCC1033E The format of the Uniform ResourceIdentifier (URI) is not supported. {0} isnot supported for the Advance Getoperation.

Check that the request URL has theproper format and that the correctoperator is being used.




BZSCC1034E The format of the Uniform ResourceIdentifier (URI) is not supported. {0} isnot a valid value for {1}. Try ASC orDESC.

Check that the request URL has theproper format and that valid valuesare being used for the parameters.

BZSCC1035E The format of the Uniform ResourceIdentifier (URI) is not supported. {0}should come after {1}.

Check that the request URL has theproper format and that theparameters are in the right order.

BZSCC1036E The named query is invalid. Check that the request URL has asupported named query parameter.

BZSCC1037E The object ID and the UniformResource Identifier (URI) must be thesame.

Check that the request URL has asupported named query parameter.

BZSCC1038E An exception occurred when parsingthe XML file.

Check that the request URL has asupported named query parameter.

BZSCC1039E A value is not found for {0}. Check that the request URL has asupported named query parameter.

BZSCC1040E The signature parameter was notpassed in the URL.

Check that the required parametersare passed in the URL.

BZSCC1041E The person ID cannot be empty. Check that the parameters for theperson ID are passed in the URL.

BZSCC1042E The email address cannot be empty. Check that the parameters for theperson ID are passed in the URL.

BZSCC1043E The agreement cannot be acceptedbecause the person ID is invalid.

Check that the person ID in theparameter list matches the personID of the email address.

BZSCC1044E Agreement terms cannot be found forthe agreement.

Check that the correct language andagreement ID are passed in theURL.

BZSCC1045E The current user is not in active orpending state.

Check that the user is in active orpending state.

BZSCC1046E The agreement cannot be found. Check that the agreement ID iscorrect.

BZSCC1047E The agreement terms with therequested language cannot be found.

Check that the correct language andagreement ID are passed in theURL.

BZSCC1066E The terms of use have already beenaccepted.

No user action is required.

BZSCC1090E An exception occurred when creatingthe Salesforce contact.

Contact your system administrator.

BZSCC1091E An exception occurred when creatingthe Salesforce lead.


BZSCC1092E An exception occurred when creatingthe Salesforce opportunity.


BZSCC1560E A subscriber with this ID does notexist.

Check that the subscriber exists.

BZSCC1561E The source customer deprovisioning isin progress.

Check that the customerdeprovisioning process finishessuccessfully.




BZSCC1562E The target customer deprovisioning isin progress.

Check that the target customerdeprovisioning process finishessuccessfully.

BZSCC1563E A subscription with the {0} ID musthave at least one subscription serviceoffering attribute.

Check that the subscription has atleast one subscription serviceoffering attribute.

BZSCC1565E A customer who is associated with the{0} account ID cannot be found.

Check that a customer is associatedwith this account.

BZSCC1567E The party cannot be found. Check that the party is correct.

BZSCC1568E The party for the subscriber is invalid.The party must be a person.

Check that the party is a validperson.

BZSCC1569E A subscriber for the customer was notfound.

Check that the subscriber is correct.

BZSCC1570E A subscriber cannot be updated whenthe removal of that subscriber is inpending state.

Check that the subscriber is in thecorrect state.

BZSCC1571E The party for the existing subscriber isinvalid. The party must be a person.

Check that the party is correct.

BZSCC1572E A customer contact person cannot betransferred.

Check that the person to betransferred is not the contact personof the company.

BZSCC1573E A value for the given name is required. Specify a value for the given name.

BZSCC1574E A value for the family name isrequired.

Specify a value for the family name.

BZSCC1575E A value for the email address isrequired.

Specify a value for the emailaddress.

BZSCC1576E A subscription with this ID does notexist.

Check that the subscription ID iscorrect.

BZSCC1577E The offer ID in the given subscriptioncannot be found.

Check that the offer ID in the givensubscription is correct.

BZSCC1578E The service offering ID that belongs tothe given subscription cannot befound.

Check that the service offering ID inthe given subscription is correct.

BZSCC1579E The person was not found. Check that the person is correct .

BZSCC1580E A seat for this event cannot be found. Check that the seat for this event iscorrect.

BZSCC1581E A message in the inbound event cannotbe found.

Check that the message in theinbound event is correct.

BZSCC1582E The operation ID for this message inthe inbound event cannot be found.

Check that the message in theinbound event is correct.

BZSCC1583E A subscriber for this event cannot befound.

Check that the subscriber for thisevent is correct.

BZSCC1804E The details for the {0} event areinsufficient.

Check that the details exist for theprovisioning event.

BZSCC1811E A workflow cannot be found. Check that the workflow has notbeen deleted.

BZSCC1812E The workflow has already beenabandoned.

Check that the workflow has notbeen cancelled.




BZSCC1813E The workflow for this ID cannot befound.

Confirm that the workflow ID isvalid and that the workflow has notbeen cancelled.

BZSCC1814E The start date is not in the correctformat.

Specify a start date in one of thefollowing formats: (yyyy-mm-dd) or(yyyy-mm-dd hh:mm:ss).

BZSCC1815E The service name is not valid. Specify a valid service name.

BZSCC1816E The workflow for this ID cannot befound.

Confirm that the workflow ID isvalid and that the workflow has notbeen cancelled.

BZSCC1817E The order cannot be found. Check that the order ID is correct.

BZSCC1818E A processing order cannot be found forthe {0} ID.

Check that the order ID is correct.

BZSCC1819E The operation ID for this message inthe inbound event cannot be found.


BZSCC1821E The value of the burstSize parameter isinvalid.

Check that the value of theburstSize parameter is greater than0.

BZSCC1822E The workflow has already completedand cannot be restarted.

Only restart workflows that are notin completed state.

BZSCC1823E A new subscription ID cannot be foundin the extra-data value of theworkflow.

Confirm that a new subscription IDexists in the extra-data value of theworkflow.

BZSCC1824E A seat with the {0} ID cannot be found. Check that the seat ID is valid.

BZSCC1826E The start and end dates must be in thefollowing format: (yyyy-mm-ddhh:mm:ss).

Check that the start and end datesare in the following format:(yyyy-mm-dd hh:mm:ss).

BZSCC1827E The start date must be in one of thefollowing formats: (yyyy-mm-dd) or(yyyy-mm-dd hh:mm:ss).

Check that the start date is in one ofthe following formats:(yyyy-mm-dd) or (yyyy-mm-ddhh:mm:ss).

BZSCC1828E The start and end dates must be in thefollowing format: (yyyy-mm-ddhh:mm:ss).

Check that start and end dates arein the following format:(yyyy-mm-dd hh:mm:ss).

BZSCC1829E The start date cannot be later than theend date.

Check that the start date is earlierthan the end date.

BZSCC1830E The workflow has been abandoned. Check that the workflow has notbeen cancelled.

BZSCC1901E An email address is required. Provide a value for the emailaddress.

BZSCC1902E The email address already exists Provide a unique email address.

BZSCC1914E The subscription ID in the URI must bethe same as the subscription ID in theJavaScript Object Notation (JSON) codefor the seat.

Check that the subscription IDs inthe URI and JSON code areidentical.

BZSCC1915E Quotas can only be changed for pooledsubscriptions.

Check that the subscription ispooled.




BZSCC1920E The force value is invalid. Specify true or false for the forcevalue.

BZSMS1049E The attribute cannot be found. Check that the schema ID attributeis correct.

BZSMS1050E The schema attribute cannot be found. Check that the schema ID attributeis correct.

BZSMS1067E The customer cannot be found. Check that the customer ID iscorrect. If the ID is correct, call yoursystem administrator to check foran internal error.

BZSMS1068E The customer is not active and cannotperform this operation.

Contact your system administratorto activate your account.

BZSMS1069E The customer is either not active orcurrently in pending state.

Contact your system administratorto activate the account or cancel theprovisioning or deprovisioningprocess.

BZSMS1070E The details for the credit card areinvalid.

Check that the details for the creditcard are correct.

BZSMS1071E A credit card cannot be found for thecustomer account.

Add a credit card to the customeraccount, and try again.

BZSMS1072E The credit card that was added to thecustomer account is not in the list ofcredit cards for the {0} customer.

Use an existing card, or update thelist of credit cards for the customer.

BZSMS1073E This payment type does not requirecredit card information.

Remove the credit card informationfor this payment type.

BZSMS1074E The details of the address are missingor invalid.

Provide the correct information forthe address.

BZSMS1075E The address does not belong to thefollowing customer: {0}.

Check that the address ID matchesthe existing address of the customer.

BZSMS1076E The credit card already exists. Try a different credit card.

BZSMS1114E The account ID 0 is not valid for thiscustomer.

Check that the account ID is validfor the customer.

BZSMS1115E The account does not exist or does notbelong to the customer.

Check that the account ID is valid.

BZSMS1116E The address cannot be found. Check that the address ID andcustomer ID are correct.

BZSMS1117E The customer cannot be found. Check that the customer ID used inthe request is correct.

BZSMS1118E The credit card does not exist or doesnot belong to the customer.

Check that the customer ID andcredit card ID used in the requestare correct.

BZSMS1119E The customer attribute does not existor does not belong to the customer.

Check that the customer ID andcustomer attribute ID used in therequest are correct.

BZSMS1125E The channel code is not valid. Ask your system administrator for alist of valid channel code values.




BZSMS1126E The service provider code must containbetween one and 15 characters.

Check that the service providercode is between one and 15characters.

BZSMS1127E The customer party cannot be found. Check that the customer data isaccurate and not corrupt. Alsocheck that the customer party is anorganization or a person.

BZSMS1128E The contact details for the customerwho is being registered were notfound.

Check that the contact details forthe organization that is associatedwith the customer are correct.

BZSMS1129E The customer, contact, or organizationbelongs to the Denied Party List (DPL).


BZSMS1130E The subscriber for the person who isbeing registered cannot be found.

Check that the data is not corrupt.

BZSMS1131E The subscriber who is being registeredis not a guest.

Check whether the subscriber hasalready been registered. Also checkthat the data is not corrupt.

BZSMS1132E A value for the given name is required. Provide a value for the given name.

BZSMS1133E A value for the email address isrequired.

Provide a value for the emailaddress.

BZSMS1134E The email address already exists. Check that the email address iscorrect and that you have notalready registered.

BZSMS1135E A vendor's default customer accountcannot be removed.

Remove a different account.

BZSMS1136E The account information for thecustomer of the current user cannot befound.

Check that the customer account IDis correct.

BZSMS1137E The account that is associated with thesubscription cannot be deleted.

Either modify the customer account,or remove another account.

BZSMS1138E The credit card cannot be removedbecause it is associated with anaccount.

Disassociate the credit card with theaccount, and then try to remove itagain.

BZSMS1139E The credit card cannot be removedbecause it is the only one that isassociated with the customer. Thecustomer must have at least one creditcard.

No action is required.

BZSMS1140E The customer attribute for thiscustomer cannot be found.

Check that the customer attributeschema ID is correct.

BZSMS1141E The customer identifier for thiscustomer cannot be found.

Check that the customer identifierID is correct.

BZSMS1142E The subscription cannot be canceledbecause the value is not valid.

Specify true or false whencancelling the subscription.

BZSMS1143E When revoking subscribers, thesubscription ID cannot be a childsubscription.

Use the subscription ID of a parentsubscription when revoking allsubscribers. All child subscriptionsget revoked automatically when theparent subscription is revoked.




BZSMS1181E The IBM customer cannot beunregistered.

Check that the customer ID iscorrect and that it is not associatedwith an IBM customer.

BZSMS1182E The default customer of a vendorcannot be unregistered.

Check that the customer ID iscorrect.

BZSMS1183E The value of the _force contextparameter is invalid.

Specify true or false as the value ofthe _force context parameter.

BZSMS1184E Some subscribers cannot beunsuspended.

Unsuspend each subscriberindividually.

BZSMS1187E The vendor that is associated with theaccount cannot be found.

Confirm that the account data is notcorrupt.

BZSMS1188E A customer who is in deregisterpending state cannot be updated.


BZSMS1189E The vendor ID of the customeraccounts cannot be changed.

Check that the vendor ID of thecustomer accounts has not changedfrom previous values.

BZSMS1222E The contact person does not belong toany of the customer's subscribers.

Check that the contact ID that islinked to the customer'sorganization is correct.

BZSMS1800E The customer is not in active state. Check that the customer is in activestate.

BZSMS1801E Customer deprovisioning is inprogress.

Check that the customerdeprovisioning finishes successfully.

BZSMS1802E The customer ID is invalid. Check that the customer ID iscorrect.

BZSMS1803E The customer was not found. Check that the customer ID is valid.

BZSMS1806E A subscription with these services wasnot found for the customer.

Check that the services are valid forthe subscription.

BZSMS1808E Multiple default customers were foundfor the {0} vendor.

Check that the vendor has only onedefault customer.

BZSMS1809E Multiple vendors were found for the{0} customer.

Check that the customer has onlyone vendor.

BZSMS1810E A vendor for the {0} customer cannotbe found.

Check that the customer has avendor.

BZSMS1881E The customer does not exist. Confirm that the customerinformation is correct so that thedetails of the access token durationcan be found.

BZSMS1890E The vendor is not active. Check that the vendor is active.

BZSMS1891E The vendor attribute does not exist ordoes not belong to the vendor.

Check that the vendor attributeexists and belongs to the vendor.

BZSMS1892E The vendor cannot be found. Check that the vendor exists.

BZSMS1893E A vendor attribute cannot be found forthis vendor.

Check that a vendor attribute existsfor this vendor.

BZSMS1894E The vendor cannot be deleted becauseit contains child entities.

Remove the child entities beforeattempting to delete the vendor.

BZSMS1895E IBM vendors cannot be unregistered. Check that the vendor is not anIBM vendor.




BZSMS1896E The vendor cannot be registered orupdated because the party of thevendor cannot be found.

Confirm that the party of thevendor is either an organization ora person in the input JavaScriptObject Notation (JSON).

BZSMS1897E Required contact details are missing. Specify contact details.

BZSMS1898E The parent vendor cannot be found. Check that the parent vendor exists.

BZSMS1899E A given name is required. Specify a given name.

BZSMS1900E A party type is required. Provide a value for the party type.

BZSMS1903E The contact person does not belong toany of the vendor's subscribers.

Check that the contact personbelongs to one of the vendor'ssubscribers.

BZSMS1911E The person was not found. Check that the person ID is valid.

BZSMS1912E The customer has not been assigned toa party.

Check that the customer has beenassigned to a party.

BZSMS1913E The person ID is invalid. Check that the person ID is valid.

BZSMS1942E The value for the CustomerIdentifier-OFFERING_CUSTOMER_ID cannot bechanged during an update.

Check that the value forCustomerIdentifier-OFFERING_CUSTOMER_IDmatches previously used values.

BZSMS1944E The {0} country name is not supported. Check that the country name in theaddress is valid.

BZSMS1945E The address is not valid. Check that a value exists for eitherthe country code or country namefields in the address.

BZSMS1955E The {0} country code is not supported. Check that the country code in theaddress is valid.

BZSMS1956E The address is not valid. Check that a value exists for eitherthe state code or state name fieldsin the address.

BZSMS1957E The {0} state name is not supported. Check that the state name in theaddress is valid.

BZSMS1958E The {0} state code is not supported. Check that the state code in theaddress is valid.

BZSMS1968E The country code was not updated. Update the country code wheneveryou update the country name.

BZSMS1969E The address cannot be updatedbecause the {0} country name and {1}country code are not consistent.

Check that the country code andcountry name are consistent.

BZSMS1970E The state code was not updated. Update the state code wheneveryou update the state name.

BZSMS1971E The address cannot be updatedbecause the {0} state name and {1} statecode are not consistent.

Check that the state code and statename are consistent.

BZSMS1973E The {0} service provider code alreadyexists.

Check that the service providercode is unique.




BZSMS1974E The following service provider code isinvalid: {0}.

Check that the service providercode contains at least one letterwith any combination of letters,numbers, hyphens (-), andunderscores (_).

BZSMS1975E The following URN is already beingused: {0}.

Check that the name and vendorURN are unique.

BZSMS1976E The following name is invalid: {0}. Check that the name contains atleast one letter with anycombination of letters, numbers,hyphens (-), and underscores (_).

BZSMS1977E No Duplicate objects of sameCustomerIdType allowed. Customeralready has CustomerIdType: {0}

Please remove the duplicate objectand retry the operation.

BZSMS1978E CustomerIdType and Valuecombination should be unique acrosscustomers. Some other customeralready has CustomerIdType: {0} andValue: {1}

Please use different value forcustomerIdentifier and retry theoperation.

BZSMS1980E Invalid address, state code value {0} isinvalid for the country {1}.

Ensure that state code and countrycode are consistent.

BZSOP1450E The order information ID cannot benull or blank.

Specify a value for the orderinformation ID (OrderInfoId)

BZSOP1451E The order information was notreturned by Distributed Software(DSW) for the {0} ID.

Confirm that the ID is correct.

BZSOP1494E The subscription ID was not found. Check that the subscription ID iscorrect.

BZSOP1495E The offering price does not belong tothis offer.

Check that the offering price iscorrect for the offer.

BZSOP1496E The item cannot be added without theoffering type base.

Add the offering type base beforeadding the item.

BZSOP1497E The prerequisite subscription for givenorder item does not exist. Kindly addthe PreRequisite Offering to the Cartbefore adding the current one.

Add the prerequisite offering to thecart before adding the current one.

BZSOP1498E The customer already has a pooledsubscription that is being cancelled.

Finish cancelling the previouspooled subscription before adding anew pooled subscription.

BZSOP1499E The duration length exceeds the limitof 60 months.

Check that the duration length doesnot exceed the limit of 60 months.

BZSOP1500E The duration length exceeds the limitof five years.

Check that the duration length doesnot exceed the limit of five years.

BZSOP1501E The duration length exceeds the limitof 1825 days.

Check that the duration length doesnot exceed the limit of 1825 days.

BZSOP1502E The subscription is being cancelled. Check that the subscription iscancelled successfully.

BZSOP1503E The add-on order item is invalid.Fields have not changed.

Check that the add-on order item iscorrect.




BZSOP1504E The upgrade order item is invalid. At aminimum, the offer ID must bedifferent to qualify as an upgradeorder.

Check that the order item for theupgrade is correct and that you areusing a different offer ID.

BZSOP1505E The subscription was not found. Check that the subscription iscorrect.

BZSOP1506E The part quantity must be a validnumber.

Check that the part quantity is avalid number.

BZSOP1507E The duration length must be a validnumber.

Check that the duration length is avalid number.

BZSOP1508E The effective date cannot be a futuredate.

Check that the effective date is not afuture date.

BZSOP1509E Customer deprovisioning is inprogress.

Check that the customerdeprovisioning finishes successfullybefore doing this task.

BZSOP1510E The customer is not active. Check that the customer is active.

BZSOP1511E An existing customer account is notassociated with the order.

Associate an existing customeraccount with the order.

BZSOP1512E The customer account ID is invalid.The customer account does not belongto the following customer: {0}.

Check that the customer account IDis correct.

BZSOP1513E An account was not found for thecustomer.

Add an account for the customer.

BZSOP1514E A value for the order number was notset.

Specify a value for the ordernumber.

BZSOP1515E A cart does not exist or has expired. Check that a valid cart exists.

BZSOP1516E An error occurred when deleting thecart.

Check that the cart details arecorrect.

BZSOP1517E An exception occurred when deletingthe order.

Check that the order is correct.

BZSOP1518E The order cannot be deleted. Check that the order is correct.

BZSOP1519E The cart is already empty. Check that the cart is not alreadyempty.

BZSOP1520E The cart does not exist. Check that a valid cart exists.

BZSOP1521E The cart or cart item does not exist. Check that a valid cart or cart itemexists.

BZSOP1522E The {0} order was not found for ID ={1}.

Check that the order is correct.

BZSOP1523E A cart with no items cannot besubmitted.

Check that the items are addedbefore submitting the cart.

BZSOP1524E The amount details for one or morecart items cannot be found.

Check that the amount details forthe cart items are available.

BZSOP1525E The customer holds a suspendedpooled subscription.

Check that the pooled subscriptionis active.

BZSOP1526E An internal data error occurredbecause the service offering is not avalid feature.





BZSOP1527E The number of seats for the upgradesubscription must be greater than thecurrent number.

Check that the number of seats forthe upgrade subscription is greaterthan the current number of seats.

BZSOP1528E The guest subscriber was not found. Check that the guest subscriber isvalid.

BZSOP1529E An internal data error occurredbecause the service offering is not avalid feature.


BZSOP1530E The customer holds a pooledsubscription that is not active.

Check that the pooled subscriptionis active.

BZSOP1531E The number of orders cannot be fewerthan the number that is currently beingused or entitled.

Check that the number of orders isnot fewer than the number that iscurrently being used or entitled.

BZSOP1532E The part quantity cannot be usedbecause it would reduce the currenttotal seat count. sub_num_seats= {0} ,sub_num_avl_seats= {1} ,order_item_part_qty= {2} ,subscriptionId = {3}.

Confirm that the part quantity doesnot reduce the current total seatcount.

BZSOP1533E The expiration date is older than thecurrent day and time.

Check that the expiration date is notolder than the current date andtime.

BZSOP1534E The duration length sets the expirationdate to a past date. OrderId {0} , Id ={1}, subscriptionId = {2}.

Check that the duration length doesnot set the expiration date to a pastdate.

BZSOP1535E The order with {0} status cannot bereleased.

Check the order status beforereleasing the order.

BZSOP1536E The cart item does not exist in the cart. Check that the cart item exists inthe cart.

BZSOP1537E The JavaScript Object Notation (JSON)for the cart is invalid.

Perform a getCart operation beforethe update operation. Also confirmthat the JSON for the cart is valid.

BZSOP1538E The cart cannot be assigned to anothercustomer.

Check that the cart is assigned tothe correct customer.

BZSOP1539E The item ID for the cart is not valid. Check that the item ID for the cartis valid.

BZSOP1540E The item cannot be updated withoutthe offering type base.

Check that the Item has an offeringtype base.

BZSOP1541E The order type is invalid. Check that the order type is valid.

BZSOP1542E The order cannot be assigned toanother customer.

Check that the order is assigned tothe correct customer.

BZSOP1543E The order must be in pending state. Check that the order is in pendingstate.

BZSOP1544E The customer account does not exist. Check that the customer accountexists.

BZSOP1545E A credit card for the customer was notfound.

Check that a credit card for thecustomer exists.




BZSOP1546E The denied party list (DPL) checkfailed because the mailing addresscannot be found.

Check that the mailing address iscorrect.

BZSOP1547E The denied party list (DPL) checkfailed because the party cannot befound.

Check that the party is correct.

BZSOP1548E The credentials are invalid. Check that the credentials arecorrect.

BZSOP1550E The denied party list (DPL) checkfailed.


BZSOP1551E The password is not valid. Check that the password is correct.

BZSOP1552E The contact person was not found. Check that the contact personbelongs to the same company.

BZSOP1553E A login name is required. Specify a login name.

BZSOP1554E Roles are not assigned to the user. Confirm that roles are assigned tothe user.

BZSOP1555E The login name or password is invalid. Check that the login name andpassword are valid.

BZSOP1556E The role is already assigned to the user. Check that the user role is new.

BZSOP1557E The price was not found. Check that the price is correct.

BZSOP1558E The product was not found. Check that the product is correct .

BZSOP1559E The product does not exist. Check that the product is correct .

BZSOP1817E The order cannot be found. Check that the order ID is correct.

BZSOP1818E A processing order cannot be found forthe {0} ID.


BZSOP1820E The order has already completed. Check that the order has notalready completed.

BZSOP1943E The bss_order_type attribute for theorder item is required.

Check that the bss_order_typeattribute is passed with one of thefollowing values: NEW, RENEW,ADDON, TRADEUP.

BZSOP1946E The subscription with part number[{0}] cannot be traded to the offer ID[{1}] with part number [{2}].

Check that the offerings and partsare compatible.

BZSOP1947E The quantity of the child subscriptionscannot be reduced from {0} to {1}.

Do not attempt to reduce thequantity of the child subscriptionsduring a trade order.

BZSOP1948E A parent pooled subscription cannot betraded directly.

Trade one of the child pooledsubscriptions instead.

BZSOP1949E The child subscription with the {0} IDcannot be traded because it is not apooled subscription.

Trade only child subscriptions thatare pooled.

BZSOP1950E The pooled child subscription withpart number [{0}] cannot be traded tothe offer ID [{1}] with part number[{2}].

Check that the offerings and partsare compatible.




BZSOP1951E The BSS pool name of the ({0}) sourcepart does not match pool name of the({1}) target part.

Trade only pooled subscriptionsthat have the same BSS pool name.

BZSOP1952E The child of the {0} pooled parentsubscription cannot be traded becausea previous child trade up has not yetcompleted.

Wait until the previous child tradecompletes, and then try again.

BZSOP1960E A pooled order cannot be combinedwith other orders in the samesubscription.

Check that the pooled order is theonly order in the cart and is notcombined with other orders.

BZSOP1961E A subscription cannot be changedwhile Ramp is in progress.

Wait until Ramp completes, and trychanging the subscription again.

BZSOP1962E Ramp child subscriptions cannot bedeleted.

Only delete parent subscriptions.

BZSOP1963E Ramp child subscriptions cannot besuspended.

Only suspend parent subscriptions.

BZSOP1964E The subscription is not a Rampsubscription.


BZSOP1965E The operation cannot be completedbecause the customer is not active.

Contact your support team toactivate the customer.

BZSOP1966E The Ramp subscription is not due yet. No action is required.

BZSOP1967E The parent subscription is not active. No action is required.

BZSOP1972E The Ramp is not in future state. Check that the subscription is afuture Ramp.

BZSOP1979E Ramp Subscription cannot beupgraded, renewed

Ramp Subscription cannot beupgraded, renewed. Select anon-ramp subscription.

BZSOP1981E A suspended subscription cannot berenewed, added on, or traded up.

Unsuspend the subscription beforeattempting to renew, add on, ortrade up the subscription.

BZSOP1982E Expired subscriptions cannot be addedon.

Check that the subscription has notexpired.

BZSOP1983E The order cannot be traded up, addedon, or renewed because the order termis invalid.

Check that the term for the ordertype can be changed (increased ordecreased).

BZSOP1984E A paid PPA subscription that has notexpired yet cannot be traded up.

Wait until the PPA subscriptionexpires before trading up thesubscription.

BZSOP1985E Orders for beta and trial subscriptionscannot be renewed or added on.

Check that the subscription is not abeta or trial subscription.

BZSOP1986E Only DSW subscriptions can be addedon.

Check that the subscription is aDSW subscription.

BZSOP1987E Subscription part numbers cannot bechanged when adding on an order.

Confirm that the part number of thesubscription does not change whenadding on the order.

BZSOP1994E You cannot change the Part Numberwhen Renewing a Pooled Subscription

You cannot change the Part Numberwhen Renewing a PooledSubscription




BZSOP1995E Pooled subscriptions cannot be addedon.

Check that the subscription is not apooled subscription.

BZSOS1051E The catalog cannot be found. Confirm that the request parametercontains the correct catalog ID.

BZSOS1052E The catalog entry does not exist ordoes not belong to this catalog.

Confirm that the request parametercontains the correct catalog ID.

BZSOS1053E Catalog entries cannot be found. Confirm that the request parametercontains the correct catalog ID.

BZSOS1054E The catalog entry cannot be found. Itmight have been deleted, or it mightnot belong to this catalog.

Confirm that the request parametercontains the correct catalog ID andcatalog entry ID.

BZSOS1478E The ID of the organization is not valid. Check that the ID of theorganization is valid.

BZSOS1479E The catalog was not found. Check that the catalog is correct.

BZSOS1480E The offering was not found. Check that the offering is correct.

BZSOS1481E The offering family was not found. Check that the offering family iscorrect.

BZSOS1482E The offer does not exist. Check that the offer is correct.

BZSOS1483E The offering does not exist. Check that the offering is correct.

BZSOS1484E The offering family cannot be deletedbecause it has one or more associatedofferings.

Delete the associated offerings first,and then try to delete the familyoffering again.

BZSOS1485E The offering family does not exist. Check that the offering family iscorrect.

BZSOS1486E The offer was not found. Check that the offer is correct.

BZSOS1487E The combination of the catalog andoffer was not found.

Check that the combination of thecatalog and offer is correct.

BZSOS1488E The offering family was not found. Check that the offering family iscorrect.

BZSOS1489E The offering families were not found. Check that the offering families arecorrect.

BZSOS1490E The offering attribute either does notexist or does not belong to the offering.

Check that the offering attribute iscorrect.

BZSOS1491E The {0} offering was not found. Check that the offering is correct.

BZSOS1492E The offering attribute does not exist. Check that the offering attribute iscorrect.

BZSOS1493E The offering attribute does not exist forthis offering.

Check that the offering attribute iscorrect.

BZSSM1055E A start date is required. Specify a value for the start date.

BZSSM1056E A customer ID is required. Specify a value for the customer ID.

BZSSM1057E An email address is required. Specify a value for the emailaddress.

BZSSM1058E The required format of theconsumption date is yyyy-MM-ddHH:mm:ss.

Check that the format of theconsumption date is correct.




BZSSM1059E The start date must be in one of thefollowing formats: yyyy-mm-dd oryyyy-mm-dd hh:mm:ss.

Check that the format of the startdate is correct.

BZSSM1060E The end date must be in one of thefollowing formats: yyyy-mm-dd oryyyy-mm-dd hh:mm:ss.

Check that the format of the startdate is correct.

BZSSM1061E The start date must be earlier than theend date.

Check that the start date is earlierthan the end date.

BZSSM1062E The vendor ID is required. Specify a value for the vendor ID.

BZSSM1063E An entry for the activity log cannot befound.

Check that the activity log has thecorrect ID.

BZSSM1959E An internal server error occurred whengenerating the report.

Contact your support team.

BZSSS1048E The user is not authorized to performthis operation.

Check that you are logged in withthe correct credentials.

BZSSS1215E The name of the service componentcannot be found.

Check that the name of the servicecomponent exists.

BZSSS1216E fail decrypt client secret Check that the client secret is valid.

BZSSS1217E The access token cannot be found. Check that the access token exists.

BZSSS1452E The user is not authorized to performthis operation.

Check that the user has sufficientroles to perform this operation.

BZSSS1453E The subscriber's account is locked. Unlock the subscriber's account.

BZSSS1454E The user's account is suspended. Unsuspend the user's account.

BZSSS1455E The current password is invalid. Confirm that the current passwordis correct.

BZSSS1456E The new password and the confirmedpassword do not match.

Confirm that the new password andthe confirmed password match.

BZSSS1457E The password was rejected because itviolates policy rules.

Check that the password followspolicy rules.

BZSSS1458E The token was not found. Confirm that the token ID is valid.

BZSSS1459E IP check failed. Check that the IP address is valid.

BZSSS1460E A user with this ID was not found. Check that the ID of the user isvalid.

BZSSS1461E The {0} IP address or the ({1}-{2}) rangeof the IP address is invalid.

Check that the IP address is withinrange.

BZSSS1462E The ({0}-{1}) range of the IP address isinvalid.

Check that the IP address is withinrange.

BZSSS1463E The organization was not found. Check that the organization iscorrect.

BZSSS1464E An IP address restriction is not set forthe organization.

Confirm that a restriction for the IPaddress is set for the organization.

BZSSS1465E The {0} token from the {1} source IPaddress is not valid.

Check that the token from thesource IP address is valid.

BZSSS1466E The user's account is locked. Unlock the user's account.

BZSSS1467E The customer's account is locked. Unlock the customer's account.

BZSSS1468E The customer's account is suspended. Unsuspend the customer's account.




BZSSS1469E The user was not found. Check that your query contains avalid value.

BZSSS1470E The customer was not found. Check that your query contains avalid value.

BZSSS1471E The value for the password expirylength must be valid.

Check that the password expirylength is valid.

BZSSS1472E The ( {0} ) password policy is missingfrom LDAP.

Check that the right passwordpolicy exists in LDAP.

BZSSS1473E The range of the IP address is missing. Specify the range of the IP address.

BZSSS1474E A token value is required. Specify a token value.

BZSSS1475E The {0} token for the {1} email addressfrom the {2} source IP address is notvalid.

Check that the token for the emailaddress is valid.

BZSSS1476E Token {0} has expired on {1} fromsource IP {2}.

Provide a token that has notexpired.

BZSSS1477E The {0} token from the {1} source IPaddress is not valid because the {2}subscriber's account is suspended.

Provide a token that is not insuspended state.

BZSSS1831E oauth_{0}_consumersecret Check that the consumer secretexists.

BZSSS1832E oauth_{0}_tokensecret Check that the token secret exists.

BZSSS1833E oauth_{0}_requesttoken Check that the request token exists.

BZSSS1834E oauth_token_expired Check that the authorization tokenhas not expired.

BZSSS1835E oauth_token_not_verified Check that the authorization tokenhas been verified.

BZSSS1836E oauth_token_verifier_mismatch Check that the tokens are correct.

BZSSS1837E oauth_token_secret_encrypt_failure Check that the token encryptiondoes not fail.

BZSSS1838E oauth_unsupported_grant_type Check that the grant type is correct.

BZSSS1839E oauth_{0}_consumerkey Check that the consumer key isvalid.

BZSSS1840E oauth_invalid_signature Check that the signature is valid.

BZSSS1841E The service endpoint name is missingor empty.

Check that the service endpointname exists.

BZSSS1842E The customer ID of the user who iscurrently logged in cannot be found.

Check that the customer ID of theuser who is currently logged inexists.

BZSSS1843E A new Open Authorization (OAuth)credential for the service component {0}cannot be created.

Check that the inputs that arerequired to create the servicecomponent are valid.

BZSSS1844E A new Open Authorization (OAuth)credential for the service component {0}cannot be created.

Check that the inputs that arerequired to create the servicecomponent are valid.

BZSSS1845E oauth_invalid_caller Check that the caller is valid.

BZSSS1846E oauth_user_not_found Check that the caller is valid.




BZSSS1847E oauth_consumer_missing_subscription Check that the caller is valid.

BZSSS1848E oauth_invalid_token Check that the caller is valid.

BZSSS1850E ConsumerKey not found Check that the consumer key exists.

BZSSS1851E The user must be logged in to performthis operation.

Check that the user is logged in.

BZSSS1852E The service component cannot befound.

Check that the service componentexists.

BZSSS1853E The service component attribute cannotbe found.

Check that the service componentattribute exists.

BZSSS1854E oauth_service_component_missing Check that the service componentexists.

BZSSS1855E Internal app with specified ID does notexist

Check that the internal applicationwith this ID exists.

BZSSS1856E RequestToken is missing Check that the request token exists.

BZSSS1857E CustomerKey is missing Provide the customer key.

BZSSS1858E CustomerSecret is missing Check that the customer secretexists.

BZSSS1859E SignatureMethod is missing Check that the signature methodexists.

BZSSS1860E Only PLAINTEXT SignatureMethod issupported.

Confirm that the signature methodis in plain text format.

BZSSS1861E Callback URL is missing Check that the callback URL exists.

BZSSS1863E The access token cannot be found. Check that the access token exists.

BZSSS1864E The token cannot be found. Check that the token exists.

BZSSS1865E The refresh token cannot be found. Check that the refresh token exists.

BZSSS1866E oauth_refresh_token_expired Check the expiration setting for therefresh token.

BZSSS1867E oauth_invalid_accesstoken Check that the access token is valid.

BZSSS1868E oauth_access_token_expired Check the expiration setting for theaccess token.

BZSSS1869E oauth_missing_authorizationcode Check that the authorization codeexists.

BZSSS1870E oauth_invalid_authorizationcode Check that the authorization code isvalid.

BZSSS1871E refresh token encrypt failure Check that the refresh token isvalid.

BZSSS1872E oauth_invalid_clientid Check that the client ID is valid.

BZSSS1873E Callback URI sent with the request isnot the same as the one registered forthis Company App

Check that the callback URI is thesame as the one that was usedwhen registering the application.

BZSSS1874E oauth_invalid_responsetype Check that the response type isvalid.

BZSSS1875E oauth_invalid_clientsecret Check that the client secret is valid.

BZSSS1876E unsupported encoding Check that the encoding ID iscorrect.




BZSSS1877E oauth_missing_clientsecret Check that the client secret isavailable.

BZSSS1878E oauth_missing_callbackurl Check that the callback URL exists.

BZSSS1879E fail decrypt refresh token Check that the refresh token isvalid.

BZSSS1880E oauth_authorization_code_expired Check the expiration date of theauthorization code.

BZSSS1882E The bean name or ID is null. Provide the correct inputinformation so that the object can befound.

BZSSS1883E The {0} with the {1} ID does not exist. Provide the correct inputinformation so that the object can befound.

BZSSS1884E The service component cannot befound.

Specify a valid service componentID.

BZSSS1885E A value for the customer ID isrequired.

Specify a value for the customer ID.

BZSSS1886E The owner ID cannot be found. Provide the correct inputinformation so that the object can befound.

BZSSS1887E A service component with thefollowing display name already exists:{0}.

Specify a unique display name forthe service component.

BZSSS1888E A service component with thefollowing name already exists: {0}.

Specify a unique name for theservice component.

BZSSS1889E A service endpoint with the followingname already exists: {0}.

Check that the access token exists.

BZSSS1941E An error occurred with the followingpassword policy rule: [HPDIA0320W].

Change the password after {0}.

BZSUS1064E A subscription with this ID does notexist.


BZSUS1065E This duration length makes theexpiration date of the subscriptionoccur in the past. Order ID = {0} , ID ={1} , subscription ID = {2}.

Check that the duration length is apositive value.

BZSUS1077E The subscription cannot be found. Check that the subscription ID iscorrect.

BZSUS1078E The IBM house subscription is requiredand cannot be deleted.


BZSUS1079E The cancellation date must be in thefollowing format: yyyy-MM-dd.

Provide a cancellation date in thecorrect format.

BZSUS1080E The cancellation date cannot occurafter the expiration date.

Check that the cancellation dateoccurs before the expiration date.

BZSUS1081E The subscription is invalid. Check that the customer accountcan be found for the customeraccount ID in the subscription. Alsoconfirm that the subscription data isnot corrupted.




BZSUS1082E The subscription is invalid. Check that the customer can befound for the customer ID in thesubscription. Also confirm that thesubscription data is not corrupted.

BZSUS1083E The force value is invalid. Specify true or false for the forcevalue.

BZSUS1084E The subscription cannot be canceleduntil dependent subscriptions arecanceled first.

Cancel dependent subscriptions,and try to cancel the subscriptionagain.

BZSUS1085E The offer ID in the subscription cannotbe found.

Check that the offer ID in thesubscription exists in the system.Also confirm that offer ID is correct.

BZSUS1086E The service offering ID that wasobtained from the subscription cannotbe found.

Check that the service offering ID inthe subscription exists in thesystem. Confirm that the serviceoffering ID is correct.

BZSUS1087E An exception occurred whenconverting the Salesforce lead to anopportunity.


BZSUS1088E A subscription cannot be created forthe order with the following ID: {0}.


BZSUS1089E An exception occurred when creatingthe Salesforce account.


BZSUS1093E The part quantity must be a validnumber.

Check that the part quantify for theorder item is a valid number.

BZSUS1094E The effective date cannot be a futuredate.

Check that the effective date is not afuture date.

BZSUS1096E A subscription for the order with thefollowing ID cannot be created: {0}.


BZSUS1097E The subscription is invalid. Check that the customer account IDthat is associated with thesubscription is valid.

BZSUS1099E The subscription offer ID and the partnumber do not match.

Check that the part number is tiedto the service offering correctly.

BZSUS1100E The duration length exceeds the limitof 60 months.

Check that the duration length forthe subscription is less than orequal to 60 months.

BZSUS1101E The duration length exceeds the limitof five years.

Check that the duration length forthe subscription is less than orequal to five years.

BZSUS1102E The duration length exceeds the limitof 1825 days (five years).

Check that the duration length forthe subscription is less than orequal to 1825 days (five years).

BZSUS1103E The subscription cannot be created. Contact your system administrator.

BZSUS1104E The {0} number of users is greater thanthe available seats in the {1}subscription.

Check that you do not entitle moreusers than the number of seatsavailable in the subscription.

BZSUS1105E The {0} subscription does not belong tothe {1} customer.





BZSUS1106E The subscription cannot be entitledbecause it is a child subscription.

Check that the subscription is abase subscription, not a childsubscription.

BZSUS1107E The subscription with this ID cannot befound.


BZSUS1108E The subscription is not active. Check that the subscription isactive.

BZSUS1109E This operation is supported only forDistributed Software (DSW)subscriptions.

Contact your system administratorto confirm that the subscription is aDSW subscription.

BZSUS1110E This operation cannot be performedbecause the subscription is not yetscheduled to expire.

Confirm that the subscription hasexpired.

BZSUS1111E The customer who belongs to thesubscription is not active.

Contact your system administratorto activate the customer.

BZSUS1112E The {0} expiration action for the {1}subscription is either incorrect orunsupported.

Ask your system administrator toprovide a list of valid values for theexpiration action.

BZSUS1113E Duration units can only be in monthsor years.

Check that the duration units are ineither months or years.

BZSUS1120E The subscription ID cannot found. Check that the subscription ID iscorrect.

BZSUS1121E The customer with this ID cannot befound.

Check that the customer ID iscorrect.

BZSUS1122E The customer with this ID does nothave any customer accounts.

Check that the customer ID iscorrect. Also check that the data isnot corrupted.

BZSUS1123E The customer ID is required. Provide a value for the customerID.

BZSUS1124E The subscription ID is required. Provide a value for the subscriptionID.

BZSUS1144E The subscription cannot be suspendedbecause it does not exist.


BZSUS1145E The subscription cannot be suspendedor unsuspended because it is currentlybeing canceled.


BZSUS1146E Child subscriptions cannot besuspended.

Suspend the parent subscription ofthe child subscription.

BZSUS1147E The account or the customer who isassociated with the subscription doesnot exist.

Contact your system administratorto check whether the subscriptiondata is corrupted.

BZSUS1148E The parent subscription that isassociated with this child subscriptiondoes not exist.

Contact your system administratorto check whether the subscriptiondata is corrupted.

BZSUS1149E The subscription that is associated withthe seat does not exist.

Contact your system administratorto check whether the subscriptionor seat data is corrupted.

BZSUS1150E Both source subscription IDs arerequired for the bundle.

Specify two source subscription IDs.




BZSUS1151E The target subscription ID is not valid. Check that the target subscriptionID is a valid integer.

BZSUS1152E The target subscription ID is not setcorrectly in the BSS URI.

Check that the target subscriptionID is a valid integer and that thetarget subscription parameter isavailable.

BZSUS1153E The source and target subscription IDsmust be different values.

Check that the target subscriptionID is a valid integer and that thetarget subscription parameter isavailable.

BZSUS1154E The value of the _maxusercountparameter is not valid.

Check that the value of the_maxusercount parameter is a validinteger and that the parameter isavailable in the URL.

BZSUS1155E A value for {0} is required. Check that the value of the_maxusercount parameter is a validinteger and that the parameter isavailable in the URL.

BZSUS1156E The email template name is not valid. Check that the emailTemplateparameter is available and that itsvalue is set tosubscriptions_transfer.

BZSUS1157E The individual subscription ID is notvalid.

Check that theindividualSubscriptionId parameteris a valid integer and that it isavailable in the URL.

BZSUS1158E The individual subscription ID must beone of the source subscription IDs.

Check that the individualsubscription ID is one of the sourcesubscription IDs.

BZSUS1159E The subscription with the {0} ID cannotbe found.


BZSUS1160E The subscription cannot be transferredbecause it is not active.

Activate the subscription beforeattempting to transfer it.

BZSUS1161E The source and target subscriptions donot belong to the same customeraccount.

Check that the source and targetsubscription IDs are correct.

BZSUS1162E The transfer failed because the sourceand target subscriptions do not belongto the same offering family.

Contact the BSS support team to getsubscription details by offeringfamily.

BZSUS1163E The number of seats for the targetsubscription must be greater or equalto the number of subscribers who haveseats for the source subscriptions.

Contact the BSS support team toconfirm that the source and targetsubscriptions belong to the sameoffering family.

BZSUS1164E A BSS deployment error occurredbecause the transfer.bundled.user.pathparameter is set to an invalid value.

Contact your system administratorto check the details of the project.

BZSUS1165E The seat cannot be transferred becausethe source subscription is currentlybeing canceled.





BZSUS1166E The seat cannot be transferred becausethe target subscription is currentlybeing canceled.


BZSUS1167E The seat cannot be transferred becauseit is currently being revoked.


BZSUS1168E The seat cannot be transferred becauseit is currently being entitled.


BZSUS1169E The target subscription ID is not in therequest.

Check that the targetSubscriptionIdparameter is in the request URL.

BZSUS1170E The target subscription ID must be avalid integer.

Check that the target subscriptionID is a valid integer.

BZSUS1171E The source and target subscriptionsmust belong to the same customerwhen transferring seats.

Check that the subscription IDs arecorrect.

BZSUS1172E The seat cannot be transferred becausethe source customer is currently beingdeprovisioned.


BZSUS1173E The seat cannot be transferred becausethe destination customer is currentlybeing deprovisioned.


BZSUS1174E The seat must be associated with asubscriber.

Check that the seat ID is correct sothat the seat data does not becomecorrupt.

BZSUS1175E The source and target subscriptions IDsmust be different.

Confirm that the source and targetsubscription IDs are different.

BZSUS1176E The seat cannot be transferred becausethe target subscription is not in activestate.

Activate the target subscriptionbefore attempting to transfer theseat.

BZSUS1177E The subscriber already has an assignedseat in the target subscription.


BZSUS1178E The seat cannot be transferred becausethe subscriber does not have anassigned seat with the prerequisitesubscription for the target subscription.

Use the prerequisite subscription asthe target subscription whentransferring the seat, or assign theprerequisite subscription to the userbefore transferring the seat with thegiven parameters.

BZSUS1179E The seat cannot be transferred becausethe subscriber is currently beingdeprovisioned.

Check that the subscriber ID iscorrect.

BZSUS1180E The seat cannot be transferred becausethe target subscription does not haveany available seats.

Either purchase more seats in thetarget subscription, or removeanother subscriber's seat in thetarget subscription beforetransferring the seat.

BZSUS1185E Child subscriptions cannot beunsuspended.

Unsuspend the parent subscriptionto unsuspend the child subscriptionautomatically.

BZSUS1186E The subscription cannot beunsuspended because the customer isnot active.

Activate the customer beforeattempting to unsuspend thesubscription.





BZSUS1190E The subscription cannot be updatedbecause it is currently being canceled.


BZSUS1191E The state of the subscription cannot beupdated.

Confirm that the value of thesubscription state is the same as theexisting value.

BZSUS1192E The subscription cannot be updatedbecause it has already expired.


BZSUS1193E The subscription offer cannot beupdated.

Check that the offer ID is the sameas the existing value in thesubscription.

BZSUS1194E The isLimited field for the subscriptioncannot be updated.

Check that the value of theisLimited field has not beenchanged.

BZSUS1195E The part number for a subscriptioncannot be updated.

Check that the part number is thesame as the existing value in thesubscription.

BZSUS1196E The maximum number of seats cannotbe fewer than the number of seats inthe subscription.

Check that the value for themaximum number of seats is thesame value as the number of seatsin the subscription.

BZSUS1197E The LifeCycleType parameter is not avalid value.

Ask your system administrator for alist of valid values for theLifeCycleType parameter.

BZSUS1198E The number of seats cannot be fewerthan the number of seats that arecurrently occupied for the subscription.

Provide a value that is greater thanor equal to the number of seats thatare currently occupied for thesubscription.

BZSUS1199E The value for the expiration action isnot valid.

If the value provided is invalid, usethe original existing value.

BZSUS1200E The customer ID is required. Check that the customerIdparameter is in the URL and set toan integer value.

BZSUS1201E The {0} offering cannot be foundbecause it is not associated with thepart number.

Check that the value of thepartNumber parameter in the URLis correct.

BZSUS1202E Pricing details for the {0} offeringcannot be found.

Confirm that the pricing andoffering data is not corrupt.

BZSUS1203E Offers for the {0} offering thatcorresponds to the part number cannotbe found.

Confirm that the offer data is notcorrupt.

BZSUS1204E The service code for the subscriptioncannot be found.

Check that the service code is thesame as the existing value in thesubscription.

BZSUS1205E More then one customer account isassociated with the customer.

Delete all customer accounts exceptone account, and retry theoperation.




BZSUS1206E No customer account is associated withthe customer.

Add a customer account for thecustomer and then retry to updatethe account.

BZSUS1207E The vendor ID cannot be calculated. Check that the vendor ID in therequest is correct.

BZSUS1208E The user cannot be found in IBM TivoliAccess Manager.


BZSUS1209E The role for the user cannot be found. Check that the role is correct orcontact your system administrator.

BZSUS1210E The email address for the user who isbeing updated already exists.

Use a different email address.

BZSUS1211E The login name or password is notcorrect.

Check that the login name andpassword are correct.

BZSUS1212E The user password has expired. Reset the password, and then try tolog in again.

BZSUS1213E The URI format is not supported. The{0} value must be an integer.

Provide an integer value.

BZSUS1214E The Uniform Resource Locator (URI)format is not supported.

Check the documentation for thecorrect URI format.

BZSUS1217E The cancellation date cannot occurbefore the current date.

Check that the cancellation dateoccurs after the current date.


BZSUS1219E An offer for the {0} subscription cannotbe found in HighDeal.

Contact your system administratorto investigate why BSS data is notin synch with HighDeal.

BZSUS1220E An exception occurred because an offerfor the {0} subscription cannot befound in HighDeal.


BZSUS1221E A HighDeal subscription for the {0}BSS subscription cannot be found.


BZSUS1564E The subscriber deprovisioning is inprogress.

Check that the subscriberdeprovisioning process finishessuccessfully. The entitle cannot becalled when the removal of asubscriber is in pending state.

BZSUS1805E The subscriber was not found. Check that the subscriber ID isvalid.

BZSUS1807E No seats were found for the subscriber. Check that the subscriber has seats.

BZSUS1825E The subscription with the {0} ID musthave at least one subscription serviceoffering attribute.

Check that the subscription has atleast one subscription serviceoffering attribute.

BZSUS1849E The subscriber does not exist. Check that the subscriber exists.

BZSUS1862E The token cannot be authorizedbecause the subscriber cannot befound.

Check that the subscriber ID iscorrect.

BZSUS1904E The seat cannot be found. Check that the seat exists.




BZSUS1905E The seat does not belong to thesubscription.

Check that the seat and subscriptionID are correct.

BZSUS1906E The seat is currently being revoked. Check that the seat is not in revokepending state.

BZSUS1907E The seat is currently being transferred. Check that the seat is not in transferpending state.

BZSUS1908E The subscriber is already active. Check that the subscriber is not inactive state.

BZSUS1909E The subscriber is currently suspended. Check that the subscriber is not inheld or suspended state.

BZSUS1910E The subscriber is not active. Check that the subscriber is not inheld or suspended state.

BZSUS1916E The subscriber ID for a seat cannot beupdated.

Contact your system administratorto confirm that the subscriber ID forthe seat matches the ID of thesubscriber record.

BZSUS1917E The minimum value for the entitlementquantity allocated must be zero orgreater.

Check that the entitlement quantityallocated has a value of zero orgreater.

BZSUS1918E The required amount of storage is notavailable for the subscription.

Check that the subscription has therequired storage space.

BZSUS1919E The subscriber attribute for thesubscriber does not exist.

Check that the subscriber ID andattribute are correct.

BZSUS1921E The subscriber is already suspended. Check the state of the subscriber.

BZSUS1922E The subscriber cannot be suspendedbecause the subscription is not active.

Check that the subscription is activebefore attempting to suspend thesubscriber.

BZSUS1923E The subscriber cannot be transferredbecause the subscriber has seats thatare pending.

Confirm that the subscriber doesnot have any seats in transferpending state.

BZSUS1924E The prerequisite subscription must beentitled before this subscription can beentitled.

Check that the prerequisitesubscription is entitled beforeattempting to entitle dependentsubscriptions.

BZSUS1925E No seats are available for thissubscriber.

Check that the subscriber has anavailable seat.

BZSUS1926E The subscriber already has a seat forthe subscription.

Check that the subscriber alreadyhas the same subscription.

BZSUS1927E The subscription and the subscriber donot belong to the same customer.

Check that the subscriber andsubscription belong to the samecustomer.

BZSUS1928E The subscription does not have anyunassigned seats.

Check that the subscription hasenough seats to allocate.

BZSUS1929E A seat with this ID cannot be found. Check that the subscriber has a seatwith this ID.

BZSUS1930E The seat does not belong to thesubscription ID.

Check that the seat belongs to thesubscription ID.




BZSUS1931E The subscriber attribute does not existor does not belong to the subscriber.

The subscriber attribute does notexist or does not belong to thesubscriber.

BZSUS1932E The update seat command cannot beused to allocate storage.

Check that storage cannot beallocated as part of the update seatcommand.

BZSUS1933E An error ocurred when updating theseat state.

Contact the BSS support team toinvestigate the error.

BZSUS1934E The seat is not allocated to thissubscriber.

Check that the seat is allocated tothis subscriber.

BZSUS1935E The subscription for this subscribercannot be found.

Check that the subscriber belongs tothis subscription.

BZSUS1936E The subscriber with the {0} ID cannotbe assigned because the ID is not valid.

Check that the subscriber ID isvalid.

BZSUS1937E The subscriber with the {0} ID cannotbe assigned because the subscriber isbeing deleted.

Check that the subscriber is notdeleted.

BZSUS1938E The {0} value used for the assignmentis not a valid number.

Check that the number is valid.

BZSUS1939E The seat state cannot be updatedbecause a previous subscriber transferis currently in progress.

Check that the current transfercompletes before attempting toupdate the seat state.

BZSUS1940E The subscriber must be transferredbetween different customers.

Check that the subscriber istransferred between differentcustomers.

BZSUS1953E Seats cannot be transferred to or fromchild subscriptions.

Use the parent subscription IDwhen transferring seats.

BZSUS1954E Both the source and targetsubscriptions must be pooled parentsubscriptions.

Check that the source and targetsubscriptions are pooled parentsubscriptions.


Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

105

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact IBM.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sample


programs are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© your company name) (year). Portions of this code are derived from IBM Corp.Sample Programs.

© Copyright IBM Corp. _enter the year or years_. All rights reserved.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at “Copyright andtrademark information” at www.ibm.com/legal/copytrade.shtml.

Electronic emission notices

Federal Communications Commission (FCC) statement

Notices 107

http://www.ibm.com/legal/copytrade.shtml

http://www.ibm.com/legal/copytrade.shtml

Index

Aadd subscriber 33API explorer 9architectural overview 1attribute values 63attributes 63authentication 7authentication services 60, 61authorization 7

BBSS REST services 19

Ccancel subscription 51change password 60common attribute values 63common scenarios 11create subscription 48cURL 9customer management services 19, 21,

24, 27, 28, 29, 30

Ddelete customer 27delete subscriber 35

Eentitle subscriber 43error messages 75errors 75

Gget customer by ID 21get customer list 29get customer list by email address or

organization name 30get subscriber by ID 40get subscriber list 37get subscriber list by customer ID 47get subscriber list by email address 44get subscription by ID 54get subscription list 58get subscription list by customer ID 52

HHTTP status codes 73

Mmajor categories of REST services 19

OOAuth 7object states 15Open Authorization 7overview 1

Ppassword 60, 61prerequisites 7

Rregister as new vendor 7register customer 19request client ID 7request vendor ID 7reset password 61revoke subscriber 44

Sscenarios 11set one time password 61subscriber management services 33, 35,

37, 40, 41, 42, 43, 44, 47subscription management services 48,

50, 51, 52, 54, 56, 58suspend customer 28suspend subscriber 41suspend subscription 50

Tterminology 1tools for calling APIs 9

Uunsuspend customer 28unsuspend subscriber 42unsuspend subscription 50update customer profile 24update subscriber profile 35update subscription 56

109

��

Printed in USA

ibm smartcloud saas business support system api reference

Documents