Service Directory > v32.1 > Inventory > Get_Goods_Delivery_Groups
 

Operation: Get_Goods_Delivery_Groups

This service operation will get manage goods delivery groups for the specified criteria.


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

Contains request reference, criteria, filter and response group for getting goods delivery group data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Goods_Delivery_Group_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Goods_Delivery_Group_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_Group  Goods_Delivery_Group_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Goods_Delivery_Groups_Response

Get Goods Delivery Groups Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Goods_Delivery_Group_Request_References  [0..*]  Request References   
Request_Criteria  Goods_Delivery_Group_Request_Criteria  [0..*]  Request Criteria   
Response_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Goods_Delivery_Group_Response_Group  [0..*]  Response Group   
Response_Results  Response_Results  [0..*]  Response Results   
Response_Data  Goods_Delivery_Group_Response_Data  [0..*]  Response Data   
top
 

Goods_Delivery_Group_Request_References

part of: Get_Goods_Delivery_Groups_Request, Get_Goods_Delivery_Groups_Response
Element containing reference instances for goods delivery group
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Group_Request_Reference  Manage_Goods_Delivery_EventObject  [1..*]  Goods Delivery Group Request References   
top
 

Manage_Goods_Delivery_EventObject

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

Manage_Goods_Delivery_EventObjectID

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

Goods_Delivery_Group_Request_Criteria

part of: Get_Goods_Delivery_Groups_Request, Get_Goods_Delivery_Groups_Response
Utilize the following element to find goods delivery groups in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Group_Number  string  [0..1]  Goods Delivery Group Number   
Assigned_To_Worker_Reference  WorkerObject  [0..*]  Assigned To Worker Reference   
Delivery_Group_Created_On_or_After  date  [0..1]  Delivery Group Created On or After date   
Delivery_Group_Created_On_or_Before  date  [0..1]  Delivery Group Created On or Before date   
Delivery_Group_Status_Reference  Document_StatusObject  [0..*]  Delivery Group Status Reference   
Requester_Worker_Reference  WorkerObject  [0..1]  Requester Worker Reference   
Deliver_To_Location_Reference  LocationObject  [0..*]  Deliver To Location Reference   
Goods_Delivery_Ticket_Reference  Goods_DeliveryObject  [0..*]  Goods Delivery Ticket Reference   
Goods_Delivery_Run_Reference  Goods_Delivery_RunObject  [0..*]  Goods Delivery Run Reference   
top
 

WorkerObject

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

WorkerObjectID

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

Document_StatusObject

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

Document_StatusObjectID

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

LocationObject

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

Goods_DeliveryObject

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

Goods_DeliveryObjectID

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

Goods_Delivery_RunObject

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

Goods_Delivery_RunObjectID

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

Goods_Delivery_Group_Response_Group

part of: Get_Goods_Delivery_Groups_Request, Get_Goods_Delivery_Groups_Response
Element containing goods delivery group response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Goods_Delivery_Group_Response_Data

part of: Get_Goods_Delivery_Groups_Response
Goods Delivery Group Response Data
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Group  Goods_Delivery_Group  [0..*]  Goods Delivery Group   
top
 

Goods_Delivery_Group

part of: Goods_Delivery_Group_Response_Data
Goods Delivery Group
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Group_Reference  Manage_Goods_Delivery_EventObject  [0..1]  Goods Delivery Group Reference   
Goods_Delivery_Group_Data  Goods_Delivery_Group_Outbound_Data  [0..*]  Goods Delivery Group Data   
top
 

Goods_Delivery_Group_Outbound_Data

part of: Goods_Delivery_Group
Goods Delivery Group Outbound Data
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Group_ID  string  [0..1]  Goods Delivery Group ID   
Goods_Delivery_Group_Number  string  [0..1]  Goods Delivery Group Number   
Goods_Delivery_Group_Name  string  [0..1]  Goods Delivery Group Name   
Assigned_To_Reference  WorkerObject  [0..1]  Assigned To Reference   
Created_On  dateTime  [0..1]  Created On   
Goods_Delivery_Group_Status_Reference  Document_StatusObject  [0..1]  Goods Delivery Group Status Reference   
Goods_Delivery_Group_Line_Data  Goods_Delivery_Run_Line_Outbound_Data  [0..*]  Goods Delivery Group Run Line Data   
top
 

Goods_Delivery_Run_Line_Outbound_Data

part of: Goods_Delivery_Group_Outbound_Data
Element contains Goods Delivery Group Line Outbound Data
 
Parameter name Type/Value Cardinality Description Validations
Item_Reference  Item_DescriptorObject  [0..1]  Item Reference   
Item_Description  string  [0..1]  Item Description   
Quantity_to_Deliver  decimal (22, 2)   [0..1]  Quantity to Deliver   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of Measure Reference   
Alternate_Item_Identifiers_Data  Alternate_Item_Identifiers_for_Inventory_Transaction_Data  [0..*]  Purchase Item Alternate Item Identifiers Data   
Item_Tag_Reference  Item_TagObject  [0..*]  Item tags for the Purchase Item.   
top
 

Item_DescriptorObject

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

Item_DescriptorObjectID

part of: Item_DescriptorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Catalog_Item_ID, Catalog_Load_Item_ID, Expense_Item_ID, Purchase_Item_ID, Sales_Item_ID, Supplier_Item_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
 

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Alternate_Item_Identifiers_for_Inventory_Transaction_Data

part of: Goods_Delivery_Run_Line_Outbound_Data
Purchase Item Alternate Item Identifiers Data
 
Parameter name Type/Value Cardinality Description Validations
Item_Identifier_Type_Reference  Item_Identifier_TypeObject  [1..1]  Reference to existing Item Identifier Types associated with the Spend Category   
Alternate_Item_Identifier_Value  string  [0..1]  Item Identifier Type Value   
Manufacturer_Reference  ManufacturerObject  [0..1]  Reference to existing Manufacturer associated with the Item Identifier Type   
top
 

Item_Identifier_TypeObject

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

Item_Identifier_TypeObjectID

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

ManufacturerObject

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

ManufacturerObjectID

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

Item_TagObject

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

Item_TagObjectID

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

Manage_Goods_Delivery_EventReferenceEnumeration

part of: Manage_Goods_Delivery_EventObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Goods_DeliveryReferenceEnumeration

part of: Goods_DeliveryObjectID
Base Type
string
top
 

Goods_Delivery_RunReferenceEnumeration

part of: Goods_Delivery_RunObjectID
Base Type
string
top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Item_Identifier_TypeReferenceEnumeration

part of: Item_Identifier_TypeObjectID
Base Type
string
top
 

ManufacturerReferenceEnumeration

part of: ManufacturerObjectID
Base Type
string
top
 

Item_TagReferenceEnumeration

part of: Item_TagObjectID
Base Type
string
top