Service Directory > v31.2 > Benefits_Administration > Put_Postal_Code_Set
 

Operation: Put_Postal_Code_Set

Use this operation to add new postal codes to an existing postal code set, or to create a new postal code set.


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

Top-Level Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Postal_Code_Set_Reference  Postal_Code_SetObject  [0..1]  A reference to the postal code set to be update, if any. Do not enter data here if you are creating a new postal code set.   
Postal_Code_Set_Data  Postal_Code_Set_Data  [1..1]  The information to be used to update an existing set, or create a new set. 
Validation Description
You must enter at least 1 Postal Code.   
 
top
 

Response Element: Put_Postal_Code_Set_Response

Wrapper element for the Put Postal Code Set Returned data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Postal_Code_Set_Reference  Postal_Code_SetObject  [0..1]  Reference of the Postal Code Set containing the postal codes   
top
 

Postal_Code_SetObject

part of: Put_Postal_Code_Set_Request, Put_Postal_Code_Set_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  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
 

Postal_Code_Set_Data

part of: Put_Postal_Code_Set_Request
Data to use to create or update a postal code set.
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [1..1]  Name of the postal code set. This is required if creating a new set.   
Description  string  [0..1]  Description of the postal code set. This is not required.   
Postal_Code_Data  Postal_Code_Data_Unverified  [0..*]  The list of postal codes to add to this postal code set. All postal codes will be verified to be valid codes before they are added to the set.   
Validation Description
You must enter at least 1 Postal Code.   
top
 

Postal_Code_Data_Unverified

part of: Postal_Code_Set_Data
The postal codes to be added to the set. Each code will be checked for validity before being added to the set.
 
Parameter name Type/Value Cardinality Description Validations
Postal_Code  string  [1..1]  The numeric postal code to add to the set. 
Validation Description
"[postal code]" is not a valid postal code for "[region]".   
 
Country_Region_Reference  Country_RegionObject  [0..1]  The country region that the postal code belongs to.   
top
 

Country_RegionObject

part of: Postal_Code_Data_Unverified
 
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_SetReferenceEnumeration

part of: Postal_Code_SetObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top