Service Directory > v31.2 > Resource_Management > Put_Supplier_Classification
 

Operation: Put_Supplier_Classification

This service will allow to setup classifications that can be associated with a supplier. Supplier classifications will be used for reporting. Supplier classification data will include classification name, external site boolean, country, and attributes.


@ - 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_Supplier_Classification_Request

Element containing supplier classification reference for update and all supplier classification data items.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Add_Only  boolean  [0..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Supplier_Classification_Reference  Custom_Supplier_ClassificationObject  [0..1]  Reference to an existing supplier classification for update only purposes   
Supplier_Classification_Data  Supplier_Classification_Data  [1..1]  Supplier Classification Data 
Validation Description
You can't change supplier classifications that are in use. To add attributes to an existing classification create a new field.   
You can't select External Supplier Site Field check boxes if you don't select the External Supplier Site Classification check box.   
You can't modify inactive supplier classifications.   
You can't update the External Supplier Site Classification column if the classification is inactive or in use on an application in progress for an external supplier site.   
 
Validation Description
The web service is set to add only but the supplier classification already exists.   
top
 

Response Element: Put_Supplier_Classification_Response

Element containing Put Supplier Classification Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Classification_Reference  Custom_Supplier_ClassificationObject  [0..1]  Reference to an existing Supplier Classification   
top
 

Custom_Supplier_ClassificationObject

part of: Put_Supplier_Classification_Request, Put_Supplier_Classification_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  Custom_Supplier_ClassificationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Supplier_ClassificationObjectID

part of: Custom_Supplier_ClassificationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Supplier_Classification_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
 

Supplier_Classification_Data

part of: Put_Supplier_Classification_Request
Element containing all supplier classification data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Classification_ID  string  [0..1]  This is the supplier classification unique identifier 
Validation Description
Enter a unique ID for the Supplier Classification. [ID] is already in use.   
 
Supplier_Classification_Name  string  [1..1]  The name for the supplier classification   
External_Site  boolean  [0..1]  Boolean to indicate if the supplier classification is to be used in the supplier external site   
Country_Reference  CountryObject  [1..1]  Reference to the country that the supplier classification is associated with   
Inactive  boolean  [0..1]  Boolean to indicate if the supplier classification is inactive.   
Supplier_Classification_Field_Replacement_Data  Supplier_Classification_Field_Replacement_Data  [0..*]  Supplier Classification Field Replacement Data 
Validation Description
Select up to 5 fields for each supplier classification on external supplier sites.   
Validation Description
Referenced supplier classification field cannot be in use on a different supplier classification.   
At least one choice must be provided for Multiple Choice types   
Supplier classification field choices can only be added to supplier classification fields that are multiple choice.   
 
Validation Description
You can't change supplier classifications that are in use. To add attributes to an existing classification create a new field.   
You can't select External Supplier Site Field check boxes if you don't select the External Supplier Site Classification check box.   
You can't modify inactive supplier classifications.   
You can't update the External Supplier Site Classification column if the classification is inactive or in use on an application in progress for an external supplier site.   
top
 

CountryObject

part of: Supplier_Classification_Data
 
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  CountryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Supplier_Classification_Field_Replacement_Data

part of: Supplier_Classification_Data
Element containing all supplier classification field data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Classification_Field_Reference  Custom_Supplier_Classification_FieldObject  [0..1]  Reference to an existing supplier classification field for update only purposes   
Supplier_Classification_Field_ID  string  [0..1]  The unique identifier for the Supplier Classification Field. 
Validation Description
Enter a unique ID for the Supplier Classification Field. [ID] is already in use.   
 
Field_Title  string  [1..1]  The name of the supplier classification field   
Field_Required  boolean  [0..1]  Boolean to indicate if the supplier classification field is required   
Supplier_Classification_Type_Reference  Supplier_Classification_TypeObject  [1..1]  Reference to the field type   
Field_External_Site  boolean  [0..1]  Boolean to indicate if the supplier classification field is to be used in the supplier external site.   
Supplier_Classification_Field_Choice_Replacement_Data  Supplier_Classification_Field_Choice_Replacement_Data  [0..*]  Supplier Classification Field Choice Replacement Data 
Validation Description
Referenced supplier classification field choice cannot be in use on a different supplier classification field.   
 
Validation Description
Referenced supplier classification field cannot be in use on a different supplier classification.   
At least one choice must be provided for Multiple Choice types   
Supplier classification field choices can only be added to supplier classification fields that are multiple choice.   
top
 

Custom_Supplier_Classification_FieldObject

part of: Supplier_Classification_Field_Replacement_Data
 
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  Custom_Supplier_Classification_FieldObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Supplier_Classification_FieldObjectID

part of: Custom_Supplier_Classification_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Supplier_Classification_Field_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
 

Supplier_Classification_TypeObject

part of: Supplier_Classification_Field_Replacement_Data
 
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  Supplier_Classification_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_Classification_TypeObjectID

part of: Supplier_Classification_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Classification_Type_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
 

Supplier_Classification_Field_Choice_Replacement_Data

part of: Supplier_Classification_Field_Replacement_Data
Element containing all supplier classification field choice data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Classification_Field_Choice_Reference  Custom_Supplier_Classification_Field_ChoiceObject  [0..1]  Reference to an existing supplier classification field choice for update only purposes.   
Supplier_Classification_Field_Choice_ID  string  [0..1]  The unique identifier for the Supplier Classification Field Choice. 
Validation Description
Enter a unique ID for the Supplier Classification Field Choice. [ID] is already in use.   
 
Line_Order  string  [0..1]  Optional line order. If specified, lines will be sorted by this value when displayed.   
Field_Choice_Label  string  [1..1]  The label of the supplier classification field choice   
Validation Description
Referenced supplier classification field choice cannot be in use on a different supplier classification field.   
top
 

Custom_Supplier_Classification_Field_ChoiceObject

part of: Supplier_Classification_Field_Choice_Replacement_Data
 
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  Custom_Supplier_Classification_Field_ChoiceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Supplier_Classification_Field_ChoiceObjectID

part of: Custom_Supplier_Classification_Field_ChoiceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Supplier_Classification_Field_Choice_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
 

Custom_Supplier_ClassificationReferenceEnumeration

part of: Custom_Supplier_ClassificationObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Custom_Supplier_Classification_FieldReferenceEnumeration

part of: Custom_Supplier_Classification_FieldObjectID
Base Type
string
top
 

Supplier_Classification_TypeReferenceEnumeration

part of: Supplier_Classification_TypeObjectID
Base Type
string
top
 

Custom_Supplier_Classification_Field_ChoiceReferenceEnumeration

part of: Custom_Supplier_Classification_Field_ChoiceObjectID
Base Type
string
top