Service Directory > v31.2 > Inventory > Get_Goods_Delivery_Rules
 

Operation: Get_Goods_Delivery_Rules

This service operation will get Goods Delivery Rules


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

Goods Delivery Rules Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Goods_Delivery_Rules_Request_References  [0..1]  Goods Delivery Rules Request References   
Request_Criteria [Choice]   Goods_Delivery_Rules_Request_Criteria  [0..1]  Goods Delivery Rules 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_Rules_Response_Group  [0..1]  Goods Delivery Rules Response Group   
top
 

Response Element: Get_Goods_Delivery_Rules_Response

Get Goods Delivery Rules Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Goods_Delivery_Rules_Request_References  [0..1]  Goods Delivery Rules Request References   
Request_Criteria  Goods_Delivery_Rules_Request_Criteria  [0..1]  Goods Delivery Rules Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Goods_Delivery_Rules_Response_Group  [0..1]  Goods Delivery Rules Response Group   
Response_Results  Response_Results  [0..*]  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.   
Response_Data  Goods_Delivery_Rules_Response_Data  [0..*]  Get Goods Delivery Rules Response   
top
 

Goods_Delivery_Rules_Request_References

part of: Get_Goods_Delivery_Rules_Request, Get_Goods_Delivery_Rules_Response
Goods Delivery Rules Request References
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Rules_Request_Reference  Goods_Delivery_RuleObject  [1..*]  Goods Delivery Rules Request Reference   
top
 

Goods_Delivery_RuleObject

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

Goods_Delivery_RuleObjectID

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

part of: Get_Goods_Delivery_Rules_Request, Get_Goods_Delivery_Rules_Response
Goods Delivery Rules Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Goods_Delivery_Rules_Request, Get_Goods_Delivery_Rules_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_Rules_Response_Group

part of: Get_Goods_Delivery_Rules_Request, Get_Goods_Delivery_Rules_Response
Goods Delivery Rules Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Goods_Delivery_Rules_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_Rules_Response_Data

part of: Get_Goods_Delivery_Rules_Response
Get Goods Delivery Rules Response
 
Parameter name Type/Value Cardinality Description Validations
Apply_Rules_on_Manual_Delivery_Creation  boolean  [0..1]  Apply Rules on Manual Delivery Creation boolean   
Goods_Delivery_Rules  Goods_Delivery_Rule  [0..*]  Goods Delivery Rule   
top
 

Goods_Delivery_Rule

part of: Goods_Delivery_Rules_Response_Data
Goods Delivery Rules Response Data
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Rule_Reference  Goods_Delivery_RuleObject  [0..1]  Goods Delivery Rule   
Goods_Delivery_Rules_Data  Goods_Delivery_Rules_Data  [0..*]  Goods Delivery Rules Data 
Validation Description
Goods Delivery Rules require a Company. Please provide a Company  Goods Delivery Rules require a Company. Please provide a Company 
Goods Delivery Rule cannot have both "Signature Required" and "Do Not Create Delivery" enabled.  Goods Delivery Rule cannot have both "Signature Required" and "Do Not Create Delivery" enabled. 
 
top
 

Goods_Delivery_Rules_Data

part of: Goods_Delivery_Rule
Goods Delivery Rules Data
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Rule_Request_ID  string  [0..1]  ID   
Goods_Delivery_Rule_Order  string  [0..1]  Goods Delivery Rule Order   
Company_Reference  CompanyObject  [1..1]  Company   
Ship-To_Address_Reference  Address_ReferenceObject  [0..*]  Ship-To Address   
Deliver-To_Location_Reference  LocationObject  [0..*]  Deliver-To Location   
Supplier_Reference  Resource_ProviderObject  [0..*]  Supplier   
Spend_Category_Reference  Spend_CategoryObject  [0..*]  Spend Category   
Item_Reference  Item_DescriptorObject  [0..*]  Item   
Purchase_Item_Group_Reference  Purchase_Item_GroupObject  [0..*]  Purchase Items   
Signature_Required  boolean  [0..1]  Signature Required boolean   
Do_Not_Create_Delivery  boolean  [0..1]  Do Not Create Delivery   
Validation Description
Goods Delivery Rules require a Company. Please provide a Company  Goods Delivery Rules require a Company. Please provide a Company 
Goods Delivery Rule cannot have both "Signature Required" and "Do Not Create Delivery" enabled.  Goods Delivery Rule cannot have both "Signature Required" and "Do Not Create Delivery" enabled. 
top
 

CompanyObject

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

CompanyObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Resource_ProviderObject

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

Resource_ProviderObjectID

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

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

Purchase_Item_GroupObject

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

Purchase_Item_GroupObjectID

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

part of: Goods_Delivery_RuleObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

Purchase_Item_GroupReferenceEnumeration

part of: Purchase_Item_GroupObjectID
Base Type
string
top