Service Directory > v31.2 > Payroll_Interface > Put_Batch
 

Operation: Put_Batch DEPRECATED

This operation allows for the loading/updating of a Batch.


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

Request element used to load/update an instance of a Batch
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Batch_Reference  Application_BatchObject  [0..1]  Batch Reference   
Batch_Data  Application_Batch_Data  [1..1]  Contains each Batch based on the Request Criteria. The data returned is the current information as of the dates in the response filter.   
top
 

Response Element: Put_Batch_Response

Response element from load/update of an instance of Batch
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Batch_Reference  Application_BatchObject  [0..1]  Batch Reference   
top
 

Application_BatchObject

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

Application_BatchObjectID

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

Application_Batch_Data

part of: Put_Batch_Request
Contains each Batch based on the Request Criteria. The data returned is the current information as of the dates in the response filter.
 
Parameter name Type/Value Cardinality Description Validations
Batch_ID  string  [1..1]  Batch ID is the unique identifier.   
Application_Batch_Usage_Reference  Application_Batch_UsageObject  [1..1]  The application batch usage ID; valid values are ABSENCE, PAYROLL, PAYROLL_HISTORY, PAYROLL_INTERFACE, or PAYROLL_OFF-CYCLE. Although Batch Usage is not yet required, entering an application batch usage improves performance by allowing processing in parallel.   
Source_Reference  Integration_System__Audited_Object  [0..1]  Source (e.g. Integration System)   
top
 

Application_Batch_UsageObject

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

Application_Batch_UsageObjectID

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

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

Application_BatchReferenceEnumeration

part of: Application_BatchObjectID
Base Type
string
top
 

Application_Batch_UsageReferenceEnumeration

part of: Application_Batch_UsageObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top