Service Directory > v31.2 > Inventory > Put_Custom_Barcode_Type
 

Operation: Put_Custom_Barcode_Type

This web service operation is used to insert / update 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: Put_Custom_Barcode_Type_Request

Put Custom Barcode Type Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Custom_Barcode_Type_Reference  Barcode_Type__Audited_Object  [0..1]  Custom Barcode Type Reference   
Custom_Barcode_Type_Data  Custom_Barcode_Type_Data  [1..1]  Custom Barcode Type Data   
Validation Description
The Web Service is set to Add Only, but the Custom Barcode Type already exists.   
top
 

Response Element: Put_Custom_Barcode_Type_Response

Put Custom Barcode Type Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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
 

Barcode_Type__Audited_Object

part of: Put_Custom_Barcode_Type_Response, Put_Custom_Barcode_Type_Request
 
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_Data

part of: Put_Custom_Barcode_Type_Response, Put_Custom_Barcode_Type_Request
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