Service Directory > v32.1 > Resource_Management > Import_Guests
 

Operation: Import_Guests

This operation will add or update a Guest Listing File. Each file will load one or more Guests for a Worker. Guest data includes Name, Title and Company.


@ - 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: Guest_Header__HV__Request

Guest Header Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Guest_Listing_File_Reference  Guest_Listing_FileObject  [0..1]  Reference to an existing Guest Listing File for update only purposes.   
Guest_Listing_File_Data  Guest_Listing_File__HV__Data  [1..1]  Guest Listing File Data   
Validation Description
The Web Service is set to Add Only; but the Guest Listing File already exists.  The Web Service is set to Add Only; but the Guest Listing File already exists. 
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Guest_Listing_FileObject

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

Guest_Listing_FileObjectID

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

Guest_Listing_File__HV__Data

part of: Guest_Header__HV__Request
Element containing all Guest Listing File data.
 
Parameter name Type/Value Cardinality Description Validations
Guest_Listing_File_Number  string  [0..1]  Guest Listing File Number. This is the Guest Listing File unique identifier.   
Guest_Listing_File_Name  string  [0..1]  Guest Listing File Name   
Guest_Listing_File_Date  date  [0..1]  Guest Listing File Date   
Guest_Data  Guest__HV__Data  [0..*]  Guest Data   
top
 

Guest__HV__Data

part of: Guest_Listing_File__HV__Data
Element containing all Guest data.
 
Parameter name Type/Value Cardinality Description Validations
Guest_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Guest for update only purposes.   
Expense_Payee_Reference  Expense_PayeeObject  [1..*]  Expense Payee reference for Guest.   
Guest_Name  string  [1..1]  Guest Name   
Guest_Company  string  [0..1]  Guest Company   
Guest_Title  string  [0..1]  Guest Title   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Expense_PayeeObject

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

Expense_PayeeObjectID

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Guest_Listing_FileReferenceEnumeration

part of: Guest_Listing_FileObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Expense_PayeeReferenceEnumeration

part of: Expense_PayeeObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top