Service Directory > v32.1 > Revenue_Management > Put_Customer_Group
 

Operation: Put_Customer_Group

This service operation will add or update Customer Groups. Customer Groups are used for reporting and selection. Customer groups can include individual Customers. Customer Group data includes Customer Group ID and Name.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Customer_Group_Request

Element containing Customer Group reference for update and all Customer Group data items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Customer_Group_Reference  Customer_GroupObject  [0..1]  Reference to an existing Customer Group for update only purposes   
Customer_Group_Data  Customer_Group_Data  [1..1]  Customer Group Data   
Validation Description
The Web Service is set to Add Only; but the Customer Group already exists.   
top
 

Response Element: Put_Customer_Group_Response

Element containing Put Customer Group Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Group_Reference  Customer_GroupObject  [0..1]  Reference to an existing Customer Group   
top
 

Customer_GroupObject

part of: Put_Customer_Group_Request, Put_Customer_Group_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Customer_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Customer_GroupObjectID

part of: Customer_GroupObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Customer_Group_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Customer_Group_Data

part of: Put_Customer_Group_Request
Element containing all Customer Group data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Group_ID  string  [0..1]  Customer Group ID. This is the Customer Group unique identifier   
Customer_Group_Name  string  [1..1]  Free form text for a meaningful Customer Group Name 
Validation Description
The Customer Group Name is already in use.  The Customer Group Name is already in use. 
 
top
 

Customer_GroupReferenceEnumeration

part of: Customer_GroupObjectID
Base Type
string
top