Service Directory > v31.2 > Resource_Management > Get_Supplier_Classifications
 

Operation: Get_Supplier_Classifications

This service operation will get supplier classifications for the specified criteria. Supplier classifications are used for reporting. Supplier classification data includes classification name, external site boolean, country, and attributes. The request criteria can be for a specific classifications based on references, or all supplier classifications can be retrieved if no criteria is specified.


@ - 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: Get_Supplier_Classifications_Request

Contains request reference, filter and response group for getting supplier classification data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Supplier_Classification_Request_References  [0..1]  Get Supplier Classifications Request References   
Response_Filter  Response_Filter  [0..1]  Get Supplier Classifications Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Supplier_Classification_Response_Group  [0..1]  Get Supplier Classifications Response Group   
top
 

Response Element: Get_Supplier_Classifications_Response

Element containing Supplier Classification response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Supplier_Classification_Request_References  [0..1]  Get Supplier Classifications Request References   
Response_Filter  Response_Filter  [0..1]  Get Supplier Classifications Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Supplier_Classification_Response_Group  [0..1]  Get Supplier Classifications Response Group   
Response_Results  Response_Results  [0..1]  Get Supplier Classifications Response Results   
Response_Data  Supplier_Classification_Response_Data  [0..1]  Get Supplier Classifications Response Data   
top
 

Supplier_Classification_Request_References

part of: Get_Supplier_Classifications_Request, Get_Supplier_Classifications_Response
Element containing reference instances for a Supplier Classification
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Classification_Reference  Custom_Supplier_ClassificationObject  [1..*]  Reference to an existing Supplier Classification   
top
 

Custom_Supplier_ClassificationObject

part of: Supplier_Classification_Request_References
 
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
 

Response_Filter

part of: Get_Supplier_Classifications_Request, Get_Supplier_Classifications_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Supplier_Classification_Response_Group

part of: Get_Supplier_Classifications_Request, Get_Supplier_Classifications_Response
Element containing Supplier Classification response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Supplier_Classifications_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Supplier_Classification_Response_Data

part of: Get_Supplier_Classifications_Response
Wrapper Element that includes Supplier Classification Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Classification  Supplier_Classification  [0..*]  Supplier Classification   
top
 

Supplier_Classification

part of: Supplier_Classification_Response_Data
Wrapper Element that includes Supplier Classification Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Classification_Reference  Supplier_ClassificationObject  [0..1]  Reference to an existing Supplier Classification   
Supplier_Classification_Data  Supplier_Classification_Data  [0..*]  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.   
 
top
 

Supplier_ClassificationObject

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

Supplier_ClassificationObjectID

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

Supplier_ClassificationReferenceEnumeration

part of: 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