Service Directory > v31.2 > Inventory > Get_Custom_Barcode_Types
 

Operation: Get_Custom_Barcode_Types

This web service operation is used to retrieve Custom Barcode Types.


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

Get Custom Barcode Types Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Custom_Barcode_Type_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Custom_Barcode_Type_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Custom_Barcode_Types_Response

Get Custom Barcode Types Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Custom_Barcode_Type_Request_References  [0..1]  Request References   
Request_Criteria  Custom_Barcode_Type_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Custom_Barcode_Type_Response_Data  [0..1]  Response Data   
top
 

Custom_Barcode_Type_Request_References

part of: Get_Custom_Barcode_Types_Response, Get_Custom_Barcode_Types_Request
Request References
 
Parameter name Type/Value Cardinality Description Validations
Custom_Barcode_Type_Reference  Barcode_Type__Audited_Object  [1..*]  Custom Barcode Type Reference   
top
 

Barcode_Type__Audited_Object

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

Barcode_Type__Audited_ObjectID

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

Custom_Barcode_Type_Request_Criteria

part of: Get_Custom_Barcode_Types_Response, Get_Custom_Barcode_Types_Request
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Custom_Barcode_Types_Response, Get_Custom_Barcode_Types_Request
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
 

Response_Results

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

Custom_Barcode_Type_Response_Data

part of: Get_Custom_Barcode_Types_Response
Custom Barcode Type Response Data
 
Parameter name Type/Value Cardinality Description Validations
Custom_Barcode_Type  Custom_Barcode_Type  [0..*]  Custom Barcode Type   
top
 

Custom_Barcode_Type

part of: Custom_Barcode_Type_Response_Data
Custom Barcode Type
 
Parameter name Type/Value Cardinality Description Validations
Custom_Barcode_Type_Reference  Barcode_Type__Audited_Object  [0..1]  Custom Barcode Type Reference   
Custom_Barcode_Type_Data  Custom_Barcode_Type_Data  [0..*]  Custom Barcode Type Data   
top
 

Custom_Barcode_Type_Data

part of: Custom_Barcode_Type
Custom Barcode Type Data
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  Name 
Validation Description
Enter a Name that does not already exist.   
 
Barcode_Symbology_ID_Reference  Barcode_Symbology_IDObject  [1..*]  Barcode Symbology ID Reference   
Delimiter_Character  string (2)   [1..1]  Delimiter Character 
Validation Description
Invalid character. These are valid Delimiter characters: !"#%&'()*,-./:;<=>?^_{|}~   
Delimiter has to be 1 character in length.   
 
Custom_Barcode_Identifier  string (2)   [1..1]  Custom Barcode Identifier 
Validation Description
[custom code] already exists. Enter a unique Custom Barcode Identifier.   
Custom Barcode Identifier has to be 2 characters in length.   
Invalid character. These are valid Custom Barcode Identifier characters: !"#%&'()*,-./:;<=>?^_{|}~   
 
Attribute_Ordered  boolean  [0..1]  Attribute Ordered   
Custom_Barcode_Type_ID  string  [0..1]  Custom Barcode Type ID   
Custom_Barcode_Type_Data_Element  Custom_Barcode_Type_Data_Element  [0..*]  Custom Barcode Type Data Element 
Validation Description
Except for “Not in Use,” duplicate Barcode Data Item Types are not allowed.   
 
top
 

Barcode_Symbology_IDObject

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

Barcode_Symbology_IDObjectID

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

part of: Custom_Barcode_Type_Data
Custom Barcode Type Data Element
 
Parameter name Type/Value Cardinality Description Validations
Custom_Barcode_Type_Data_Element_Reference  Barcode_Type_Data_Element__Audited_Object  [0..1]  Custom Barcode Type Data Element Reference   
Application_Identifier  string  [0..1]  Code 
Validation Description
If you select Attribute Ordered barcode type, Application Identifier must be empty.   
Application Identifiers defined for a barcode type must be different.   
Application Identifier ([codename]) and Application Identifiers defined for "GS1" barcode type must be different.   
Application Identifier ([codename]) cannot include these characters: !"#%&'()*,-./:;<=>?^_{|}~   
Application Identifiers defined for a barcode type must be different.   
Application Identifiers defined for a barcode type must be different.   
 
Description  string  [1..1]  Description   
Length  decimal (12, 0) >0   [0..1]  Length   
Barcode_Data_Item_Type_Reference  Barcode_Data_Item_TypeObject  [1..1]  Barcode Data Item Type Reference   
Validation Description
Except for “Not in Use,” duplicate Barcode Data Item Types are not allowed.   
top
 

Barcode_Type_Data_Element__Audited_Object

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

Barcode_Type_Data_Element__Audited_ObjectID

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

Barcode_Data_Item_TypeObject

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

Barcode_Data_Item_TypeObjectID

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

Barcode_Type__Audited_ReferenceEnumeration

part of: Barcode_Type__Audited_ObjectID
Base Type
string
top
 

Barcode_Symbology_IDReferenceEnumeration

part of: Barcode_Symbology_IDObjectID
Base Type
string
top
 

Barcode_Type_Data_Element__Audited_ReferenceEnumeration

part of: Barcode_Type_Data_Element__Audited_ObjectID
Base Type
string
top
 

Barcode_Data_Item_TypeReferenceEnumeration

part of: Barcode_Data_Item_TypeObjectID
Base Type
string
top