Service Directory > v32.1 > Student_Recruiting > Put_Recruiting_Region
 

Operation: Put_Recruiting_Region

Creates a new Recruiting Region (or updates an existing Recruiting Region) using the information provided in the request.


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

Wrapper element for the Put Student Recruiting Region Request Information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Recruiting_Region_Reference  RegionObject  [0..1]  The reference to the Student Recruiting Region being updated. For new Student Recruiting Region, this element will not exist.   
Recruiting_Region_Data  Recruiting_Region_Data  [1..1]  Wrapper element for the Student Recruiting Region data.   
Validation Description
The Web Service is set to Add Only, but the Recruiting Region already exists.   
top
 

Response Element: Put_Recruiting_Region_Response

Put Response for a Recruiting Region
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Recruiting_Region_Reference  RegionObject  [0..1]  References a Recruiting Region   
Organization_Common_Data  Organization_Common_Data  [0..*]  Contains the detailed information about an Organization. 
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.  'Include Organization ID in Name' can only be set to true for supervisory organizations. 
Choose a different REFERENCE_ID. The current value is already in use by the [org type]:[var]   
You can't submit this field(Phonetic Name) until you first select both the Enabled and Workday-Supported checkboxes for your preferred language(Japanese, Korean, Chinese) in the Languages Section on the Edit Tenant Setup - Global task. You must also specify your preferred language in the "Enable Languages of Phonetic Name for Company" field.   
You are using an invalid task to submit this field (Phonetic Name).   
 
Recruiting_Region_Geographic_Criteria_Data  Recruiting_Region_Geographic_Criteria_Data  [0..*]  Wrapper element for the Student Recruiting Region Geographic Criteria data.   
top
 

RegionObject

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

RegionObjectID

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

Recruiting_Region_Data

part of: Put_Recruiting_Region_Request
Wrapper element for Student Recruiting Region data.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Subtype_Reference  Organization_SubtypeObject  [1..1]  References an Organization Subtype for a Recruiting Region   
Organization_Common_Data  Organization_Common_Data  [1..1]  Wrapper element for Organization Common data. 
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.  'Include Organization ID in Name' can only be set to true for supervisory organizations. 
Choose a different REFERENCE_ID. The current value is already in use by the [org type]:[var]   
You can't submit this field(Phonetic Name) until you first select both the Enabled and Workday-Supported checkboxes for your preferred language(Japanese, Korean, Chinese) in the Languages Section on the Edit Tenant Setup - Global task. You must also specify your preferred language in the "Enable Languages of Phonetic Name for Company" field.   
You are using an invalid task to submit this field (Phonetic Name).   
 
Recruiting_Region_Criteria_Data  Recruiting_Region_Criteria_Data  [1..*]  Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level 
Validation Description
A row of Geographic Criteria is empty. Enter at least 1 value or remove the row.   
Enter at least 1 row of Geographic Criteria.   
 
top
 

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

Organization_Common_Data

part of: Recruiting_Region_Data, Put_Recruiting_Region_Response
Contains the detailed information about an Organization.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Integration Reference ID used for integration purposes; This is also the Organization ID   
Include_Organization_ID_in_Name  boolean  [0..1]  If this option is turned on, Organization ID will be shown in Organization Name. This option is only activated for Supervisory Organizations for now. A new effective-dated organization name is automatically created if value for this field is different as of specified effective date.   
Organization_Name  string  [0..1]  The name of the Organization that appears on pages and reports. A new effective-dated organization name is automatically created if value for this field is different as of specified effective date. 
Validation Description
Enter an Organization Name or select the 'Include Manager/Leader in Name' checkbox or use the Organization Code as the name by entering an Organization Code and selecting the 'Include Organization Code in Name' checkbox.  Enter an Organization Name or select the 'Include Manager/Leader in Name' checkbox or use the Organization Code as the name by entering an Organization Code and selecting the 'Include Organization Code in Name' checkbox. 
 
Phonetic_Name  string  [0..1]  Phonetic Name   
Organization_Code  string  [0..1]  Text attribute identifying Organization Code. A new effective-dated organization name is automatically created if value for this field is different as of specified effective date. 
Validation Description
Organization Code is required If 'Include Organization Code in Name' is selected.  Organization Code is required If 'Include Organization Code in Name' is selected. 
 
Include_Organization_Code_in_Name  boolean  [0..1]  Boolean attribute identifying whether to include the Organization Code within the name (Display ID within Workday). A new effective-dated organization name is automatically created if value for this field is different as of specified effective date.   
Organization_Active  boolean  [0..1]  Field that indicates if the organization is active.   
Availability_Date  date  [1..1]  Date the Organization is available for staffing events. If availability date is specified, it must be earlier or equal to the existing availability date, otherwise it will be ignored. If availability date is not specified, the existing availability date will be retained. If availability date is not specified, and there is no existing availability date, the current effective moment will be set as the availability date.   
Organization_Visibility_Reference  Unique_IdentifierObject  [0..1]  Visibility for the organization. A subordinate organization inherits visibility from its top-level organization. If visibility is not specified for a top-level organization, it defaults to Everyone. If visibility is specified for a subordinate organization, it will be ignored.   
External_URL_Reference  External_URLObject  [0..1]  Non-Workday URL link for more Organizational information.   
Integration_ID_Data  External_Integration_ID_Data  [0..*]  Contains external system name and its corresponding ID that can be used to match data between systems during an integration.   
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.  'Include Organization ID in Name' can only be set to true for supervisory organizations. 
Choose a different REFERENCE_ID. The current value is already in use by the [org type]:[var]   
You can't submit this field(Phonetic Name) until you first select both the Enabled and Workday-Supported checkboxes for your preferred language(Japanese, Korean, Chinese) in the Languages Section on the Edit Tenant Setup - Global task. You must also specify your preferred language in the "Enable Languages of Phonetic Name for Company" field.   
You are using an invalid task to submit this field (Phonetic Name).   
top
 

Unique_IdentifierObject

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

External_URLObject

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

External_URLObjectID

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

External_Integration_ID_Data

part of: Organization_Common_Data
Integration ID Help Text
 
Parameter name Type/Value Cardinality Description Validations
ID  ID  [1..*]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Recruiting_Region_Criteria_Data

part of: Recruiting_Region_Data
Wrapper element for the Recruiting Region Data Information.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Region_Criteria_Reference  Recruiting_Region_CriteriaObject  [0..1]  Recruiting Region Criteria Reference   
Has_Academic_Unit_Data  Has_Academic_Curricular_Division_Data  [1..*]  Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level 
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
 
Recruiting_Region_Geographic_Criteria_Data  Recruiting_Region_Geographic_Criteria_Data  [1..*]  Wrapper element for the Student Recruiting Region Geographic Criteria data.   
Validation Description
A row of Geographic Criteria is empty. Enter at least 1 value or remove the row.   
Enter at least 1 row of Geographic Criteria.   
top
 

Recruiting_Region_CriteriaObject

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

Recruiting_Region_CriteriaObjectID

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

Has_Academic_Curricular_Division_Data

part of: Recruiting_Region_Criteria_Data
Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Nonsingular Workset   
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

Academic_LevelObject

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

Academic_LevelObjectID

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

Recruiting_Region_Geographic_Criteria_Data

part of: Put_Recruiting_Region_Response, Recruiting_Region_Criteria_Data
Wrapper element for the Student Recruiting Region Geographic Criteria data.
 
Parameter name Type/Value Cardinality Description Validations
Geographic_Criteria_Reference  Geographic_CriteriaObject  [0..1]  References instances of the Geographic Criteria class   
Country_Reference  CountryObject  [0..1]  Specify Country as criteria for Student Recruiting Region   
Country_Region_Reference  Country_RegionObject  [0..1]  Specify Country Region as criteria for Student Recruiting Region   
City  string  [0..1]  Specify City as criteria for Student Recruiting Region   
Postal_Code_Set_Reference  Postal_Code_SetObject  [0..1]  Specify Postal Code Set as criteria for Student Recruiting Region   
Postal_Code  string  [0..1]  Specify Postal Code as a criterion for Student Recruiting Region.   
Educational_Institution_District_Reference  Educational_Institution_DistrictObject  [0..1]  References an Educational Institution District for Geographic Criteria   
Educational_Institution_Reference  Educational_InstitutionObject  [0..*]  References an Educational Institution for Geographic Criteria   
top
 

Geographic_CriteriaObject

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

Geographic_CriteriaObjectID

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

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Country_RegionObject

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

Country_RegionObjectID

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

Postal_Code_SetObject

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

Postal_Code_SetObjectID

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

Educational_Institution_DistrictObject

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

Educational_Institution_DistrictObjectID

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

Educational_InstitutionObject

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

Educational_InstitutionObjectID

part of: Educational_InstitutionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Educational_Institution_CCD_ID, Educational_Institution_ID, Educational_Institution_Postsecondary_CEEB_ATP_ID, Educational_Institution_Postsecondary_Federal_ID, Educational_Institution_Postsecondary_IPEDS_ID, Educational_Institution_Postsecondary_Local_ID, Educational_Institution_Postsecondary_OPEID_ID, Educational_Institution_Postsecondary_Other_ID, Educational_Institution_Postsecondary_State_ID, Educational_Institution_Secondary_CEEB_ATP_ID, Educational_Institution_Secondary_Local_ID, Educational_Institution_Secondary_NCES_ID, Educational_Institution_Secondary_Other_ID, Educational_Institution_Secondary_State_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
 

RegionReferenceEnumeration

part of: RegionObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

Recruiting_Region_CriteriaReferenceEnumeration

part of: Recruiting_Region_CriteriaObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Geographic_CriteriaReferenceEnumeration

part of: Geographic_CriteriaObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Postal_Code_SetReferenceEnumeration

part of: Postal_Code_SetObjectID
Base Type
string
top
 

Educational_Institution_DistrictReferenceEnumeration

part of: Educational_Institution_DistrictObjectID
Base Type
string
top
 

Educational_InstitutionReferenceEnumeration

part of: Educational_InstitutionObjectID
Base Type
string
top