Service Directory > v32.1 > Human_Resources > Put_Addresses_for_Country_Format_Extension
 

Operation: Put_Addresses_for_Country_Format_Extension

Use this operation ONLY for the country format extension and for local script addresses population. 1. Country Format Extension Since many countries require more granular address components than Workday currently supports, the Alternate Address Formats allow Workday customers to define a Basic and an Extended Address Format metadata for these countries. Customers can then control address formats using Tenant Setup - Global when they want to use extended formats for a country. This operation uploads addresses for a specified country after the addresses are modified to fit a new extended format. Note that the attribute use Extended Address Format in Tenant Setup - Global must be enabled for the country beforeusing this operation to uploading addresses. 2. Local Script Address Population Local script address components were added in W18 to allow address input in local script. This operation uploads addresses with new local address components.


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

Request element containing Address update information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Address_Reference  Unique_IdentifierObject  [1..1]  Identifies instance of Address.   
Address_Data  Global_Address_Data  [1..*]  Wrapper for Address Update Data. 
Validation Description
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Region is required for certain countries.  Region is required for certain countries. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not Valid for this Country.  Region Subdivision 2 - Local is not Valid for this Country. 
Region Subdivision 1 - Local is not Valid for this Country.  Region Subdivision 1 - Local is not Valid for this Country. 
City Subdivision 2 - Local is not Valid for this Country.  City Subdivision 2 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not Valid for this Country.  City Subdivision 1 - Local is not Valid for this Country. 
City - Local is not Valid for this Country.  City - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 - Local is not Valid for this Country.  Address Line 6 - Local is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 2 - Local is not Valid for this Country.  Address Line 2 - Local is not Valid for this Country. 
Address Line 1 - Local is not Valid for this Country.  Address Line 1 - Local is not Valid for this Country. 
Submunicipality 2 (or City Subdivision 2 - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality 2 (or City Subdivision 2 - Local if configured on Tenant Setup Global) is required for certain countries. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
 
Validation Description
Address must be related to a Contactable.  Validates that the address is related to an active contactable. 
top
 

Response Element: Put_Addresses_for_Country_Format_Extension_Response

Response element containing Address reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Address_Reference  Unique_IdentifierObject  [0..1]  Represents a unique instance of Address.   
top
 

Unique_IdentifierObject

part of: Put_Addresses_for_Country_Format_Extension_Request, Put_Addresses_for_Country_Format_Extension_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  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
 

Global_Address_Data

part of: Put_Addresses_for_Country_Format_Extension_Request
Contains address information.
 
Parameter name Type/Value Cardinality Description Validations
Address_Line_1  string  [0..1]  Contains Address information.   
Address_Line_2  string  [0..1]  Contains Address information.   
Address_Line_3  string  [0..1]  Contains Address information.   
Address_Line_4  string  [0..1]  Contains Address information.   
Address_Line_5  string  [0..1]  Contains Address information.   
Address_Line_6  string  [0..1]  Contains Address information.   
Address_Line_7  string  [0..1]  Contains Address information.   
Address_Line_8  string  [0..1]  Contains Address information.   
Address_Line_9  string  [0..1]  Contains Address information.   
City  string  [0..1]  Contains Address information.   
City_Subdivision_1  string  [0..1]  Contains Address information.   
City_Subdivision_2  string  [0..1]  Contains Address information.   
Country_Region_Reference  Country_RegionObject  [0..1]  Contains Address information.   
Region_Subdivision_1  string  [0..1]  Contains Address information.   
Region_Subdivision_2  string  [0..1]  Contains Address information.   
Postal_Code  string  [0..1]  Contains Address information.   
Country_Reference  CountryObject  [0..1]  Contains Address information.   
Address_Line_1_-_Local  string  [0..1]  Contains Address information.   
Address_Line_2_-_Local  string  [0..1]  Contains Address information.   
Address_Line_3_-_Local  string  [0..1]  Contains Address information.   
Address_Line_4_-_Local  string  [0..1]  Contains Address information.   
Address_Line_5_-_Local  string  [0..1]  Contains Address information.   
Address_Line_6_-_Local  string  [0..1]  Contains Address information.   
Address_Line_7_-_Local  string  [0..1]  Contains Address information.   
Address_Line_8_-_Local  string  [0..1]  Contains Address information.   
Address_Line_9_-_Local  string  [0..1]  Contains Address information.   
City_-_Local  string  [0..1]  Contains Address information.   
City_Subdivision_1_-_Local  string  [0..1]  Contains Address information.   
City_Subdivision_2_-_Local  string  [0..1]  Contains Address information.   
Region_Subdivision_1_-_Local  string  [0..1]  Contains Address information.   
Region_Subdivision_2_-_Local  string  [0..1]  Contains Address information.   
Validation Description
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Region is required for certain countries.  Region is required for certain countries. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not Valid for this Country.  Region Subdivision 2 - Local is not Valid for this Country. 
Region Subdivision 1 - Local is not Valid for this Country.  Region Subdivision 1 - Local is not Valid for this Country. 
City Subdivision 2 - Local is not Valid for this Country.  City Subdivision 2 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not Valid for this Country.  City Subdivision 1 - Local is not Valid for this Country. 
City - Local is not Valid for this Country.  City - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 - Local is not Valid for this Country.  Address Line 6 - Local is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 2 - Local is not Valid for this Country.  Address Line 2 - Local is not Valid for this Country. 
Address Line 1 - Local is not Valid for this Country.  Address Line 1 - Local is not Valid for this Country. 
Submunicipality 2 (or City Subdivision 2 - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality 2 (or City Subdivision 2 - Local if configured on Tenant Setup Global) is required for certain countries. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
top
 

Country_RegionObject

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

CountryObject

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top