Service Directory > v32.1 > Inventory > Get_Inventory_Par_Bins
 

Operation: Get_Inventory_Par_Bins

Get operation for Inventory Par Bins


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

Get Inventory Par Bins Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Par_Bins_Request_References  [0..1]  Inventory Par Bins Request Reference Element   
Request_Criteria  Inventory_Par_Bins_Request_Criteria  [0..1]  Par Bins 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_Inventory_Par_Bins_Response

Get Inventory Par Bins Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Par_Bins_Request_References  [0..1]  Inventory Par Bins Request Reference Element   
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  Inventory_Par_Bin_Response_Data  [0..1]  Inventory Par Bins Response Element   
top
 

Inventory_Par_Bins_Request_References

part of: Get_Inventory_Par_Bins_Response, Get_Inventory_Par_Bins_Request
Reference to Inventory Par Bins Element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Par_Bin_Reference  Par_Location_BinObject  [1..*]  Reference to Inventory Par Bins Element   
top
 

Par_Location_BinObject

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

Par_Location_BinObjectID

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

Inventory_Par_Bins_Request_Criteria

part of: Get_Inventory_Par_Bins_Request
Element containing Get Inventory Par Bins Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Par_Location_Reference  LocationObject  [0..1]  Inventory Par Location Reference   
top
 

LocationObject

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

LocationObjectID

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

Inventory_Par_Bin_Response_Data

part of: Get_Inventory_Par_Bins_Response
Inventory Par Bin Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Par_Bin  Inventory_Par_Bin  [0..*]  Inventory Par Bin Response Data Element   
top
 

Inventory_Par_Bin

part of: Inventory_Par_Bin_Response_Data
Inventory Par Bin Element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Par_Bin_Reference  Par_Location_BinObject  [0..1]  Inventory Par Bin Reference   
Inventory_Par_Bin_Data  Inventory_Par_Bin_Data  [0..*]  Inventory Par Bin Data 
Validation Description
Valid Par Location Reference must be entered  Valid Par Location Reference must be entered 
 
top
 

Inventory_Par_Bin_Data

part of: Inventory_Par_Bin
Inventory Par Bin Data Element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Bin Reference ID   
Bin_Name  string  [0..1]  Par Location Bin Name 
Validation Description
Enter a unique Bin Name for Location [location]. [name] is already in use.   
 
Par_Location_Reference  LocationObject  [1..1]  Par Location Reference 
Validation Description
Par Location cannot be changed on an existing bin   
 
Validation Description
Valid Par Location Reference must be entered  Valid Par Location Reference must be entered 
top
 

Par_Location_BinReferenceEnumeration

part of: Par_Location_BinObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top