Register customer
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars


The API caller must have the VSR role to run the API.
Table 1. API details

 

 

Method
Resource address
Input representation
POST
/resource/customer
A JavaScript™ Object Notation (JSON) entry that represents a customer.


Input attributes


The input payload must be a well formatted JSON object with the attributes that are listed in the Input attributes table.

For attributes that are not required, you have the option of either sending an empty string as the value for that attribute, or not including that attribute in the payload. If you do not include the attribute, it will not be present in payloads that you retrieve in future operations.

For examples of valid field values, see Common attribute values.

Table 2. Input attributes

Attribute
Required
Description
Attribute Type
Maximum Length
CustomerNumber
No
Customer number, if it exists.
String
50
OrgName
Yes
Name of the organization.
String
255
Phone
No
Phone number of the organization.
String
30
AddressLine1
Yes
Mailing address of the organization.
String
255
AddressLine2
No
Additional space for mailing address.
String
100
AddressType
Yes
The address type. Must be one of the following values:
  • BILLING
  • MAILING
  • MULTIPURPOSE
String
15
City
Yes
City of residence.
String
50
Country
Yes
Country or region of residence.
String
50
State
Yes
State of residence.
String
50
PostalCode
Yes
Zip (postal) code for mail.
String
20
FamilyName
Yes
Last name of the primary contact person.
String
255
GivenName
Yes
First name of the primary contact person.
String
255
EmailAddress
Yes
Email address of the primary contact person.
String
255
NamePrefix
No
Name prefix, if one exists.
String
10
NameSuffix
No
Name suffix, if one exists.
String
10
EmployeeNumber
No
Employee number of the person.
String
10
LanguagePreference
No
Language preference of the person. Default value is en_US.
String
15
WorkPhone
Yes
Workplace phone number.
String
30
HomePhone
No
Residential phone number.
String
30
MobilePhone
No
Mobile phone number.
String
30
Fax
No
Fax number.
String
30
JobTitle
No
Job title of the person.
String
50
WebSiteAddress
No
Website address of the person, if available.
String
255
TimeZone
No
Time zone information.
String
255
Photo
No
Reference to the location where the photo is stored.
String
255
AccountNumber
Yes
Customer account number, if one exists.
String
255
LocationName
Yes
Name of customer location.
String
255
PaymentMethodType
Yes
The payment method type. Must be one of the following values:
  • CREDIT_CARD
  • PURCHASE_ORDER
  • INVOICE
  • NONE
.
String
25
CurrencyType
No
Type of currency.
String
25
CustomerIdType
Yes (if CustomerIdentifierSet is specified)
Name of Customer Identifier. Must be one of the following values:
  • CAAS_CUSTOMER_ID
  • COREMETRIC_CUSTOMER_ID
  • GLOBALCROSSING_ID
  • GLOBALIVE_ID
  • IBM_CUSTOMER_NUMBER
  • IBM_CUSTOMER_NUMBER_PREV
  • IBM_SITE_NUMBER
  • SALESFORCE_ACCOUNT_ID
  • SALESFORCE_CONTACT_ID
  • SALESFORCE_ID
  • SALESFORCE_LEAD_ID
  • SALESFORCE_OPPORTUNITY_ID
  • SIEBEL_ID
  • STERLING_CUSTOMER_ID
  • TMS_CUSTOMER_ID
  • UNICA_CUSTOMER_ID
  • UNYTE_CUSTOMER_ID
String
25
Value
Yes (if CustomerIdentifierSet is specified)
Value of the specified Customer Identifier
String
50
SecurityRealm
NO
This attribute should have one of the below values
  • FDERATED
  • NON_FEDERATED
  • MODIFIED_FEDERATED
  • PARTIAL_FEDERATED
String
25

 


Sample payload

{

"Customer" : {

"Organization" : {

"OrgName" : "Test Enterprise",

"Phone" : "999-999-9999",

"AddressSet" : [{

"AddressLine1" : "5 Technology Park Drive",

"AddressLine2" : "",

"AddressType" : "MAILING",

"City" : "Westford",

"Country" : "United States",

"PostalCode" : "01866",

"State" : "Massachusetts"

}

],

"Contact" : {

"FamilyName" : "Doe",

"GivenName" : "John",

"EmailAddress" : "johndoe@example.com",

"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"

}

],

"CustomerIdentifierSet" : [{

"Value" : "9999999999",

"CustomerIdType" : "IBM_CUSTOMER_NUMBER"

}

]

}

}


Output Attributes


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, see HTTP status codes.

Parent topic: Customer management services

 

 

Input
Method URI Description
POST /api/bss/resource/customer Create a customer organization with a contact person.
Content Type: application/json
Sample Request:
{

  "Customer" : {

    "Organization" : {

      "OrgName" : "Test Enterprise",

      "Phone" : "999-999-9999",

      "AddressSet" :  [{

          "AddressLine1" : "5 Technology Park Drive",

          "AddressLine2" : "",

          "AddressType" : "MAILING",

          "City" : "Westford",

          "Country" : "United States",

          "PostalCode" : "01866",

          "State" : "Massachusetts"

        }

      ],

      "Contact" : {

        "FamilyName" : "Doe",

        "GivenName" : "John",

        "EmailAddress" : "johndoe@example.com",

        "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"

      }

    ],

    "CustomerIdentifierSet" :  [{

        "Value" : "9999999999",

        "CustomerIdType" : "IBM_CUSTOMER_NUMBER"

      }

    ]

  }

}

Use the table below that represents the expected fields:
Name Type Optional Description
CustomerNumber
string Yes Customer number, if it exists.
OrgName
string No Name of the organization.
Phone
string Yes Phone number of the organization.
AdressLine1
string No Mailing address of the organization.
AdressLine2
string Yes Additional space for mailing address.
AdressType
string No The address type. Must be one of the following values:
BILLING
MAILING
MULTIPURPOSE
City
string No City of residence.
Country
string No Country or region of residence.
State
string No State of residence.
PostalCode
string No Zip (postal) code for mail.
FamilyName
string No Last name of the primary contact person.
GivenName
string No First name of the primary contact person.
EmailAddress
string No Email address of the primary contact person.
NamePrefix
string Yes Name prefix, if one exists.
NameSuffix
string Yes Name suffix, if one exists.
EmployeeNumber
string Yes Employee number of the person.
LanguagePreference
string Yes Language preference of the person. Default value is en_US.
WorkPhone
string Yes Workplace phone number.
HomePhone
string Yes Residential phone number.
MobilePhone
string Yes Mobile phone number.
Fax
string Yes Fax number.
JobTitle
string Yes Job title of the person.
WebsiteAddress
string Yes Website address of the person, if available.
TimeZone
string Yes Time zone information.
Photo
string Yes Reference to the location where the photo is stored.
AccountNumber
string No Customer account number, if one exists.
LocationName
string Yes Name of customer location.
PaymentMethodType
string No The payment method type. Must be one of the following values:
CREDIT_CARD
PURCHASE_ORDER
INVOICE
NONE
CurrencyType
string Yes Type of currency.
CustomerIdType
string No Name of Customer Identifier. Must be one of the following values:
CAAS_CUSTOMER_ID
COREMETRIC_CUSTOMER_ID
GLOBALCROSSING_ID
GLOBALIVE_ID
IBM_CUSTOMER_NUMBER
IBM_CUSTOMER_NUMBER_PREV
IBM_SITE_NUMBER
SALESFORCE_ACCOUNT_ID
SALESFORCE_CONTACT_ID
SALESFORCE_ID
SALESFORCE_LEAD_ID
SALESFORCE_OPPORTUNITY_ID
SIEBEL_ID
STERLING_CUSTOMER_ID
TMS_CUSTOMER_ID
UNICA_CUSTOMER_ID
UNYTE_CUSTOMER_ID
Value
string No Value of the specified Customer Identifier
Output
Content Type: application/json
Examples
When the API call is successful, the ID of the customer is returned, for example:
{

  "Customer" : {

    "Organization" : {

      "OrgName" : "Test Enterprise",

      "Phone" : "999-999-9999",

      "AddressSet" :  [{

          "AddressLine1" : "5 Technology Park Drive",

          "AddressLine2" : "",

          "AddressType" : "MAILING",

          "City" : "Westford",

          "Country" : "United States",

          "PostalCode" : "01866",

          "State" : "Massachusetts"

        }

      ],

      "Contact" : {

        "FamilyName" : "Doe",

        "GivenName" : "John",

        "EmailAddress" : "johndoe@example.com",

        "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"

      }

    ],

    "CustomerIdentifierSet" :  [{

        "Value" : "9999999999",

        "CustomerIdType" : "IBM_CUSTOMER_NUMBER"

      }

    ]

  }

}


Response returned by the server
{ 

  "Long" : 1001 

}