Service Directory > v31.2 > Human_Resources > Put_Social_Benefits_Locality
 

Operation: Put_Social_Benefits_Locality

This operation adds or updates a Social Benefits Locality.


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

Request element for Put Social Benefits Locality
 
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.   
Social_Benefits_Locality_Reference  Social_Benefits_LocalityObject  [0..1]  A unique identifier used to reference a Social Benefits Locality   
Social_Benefits_Locality_Data  Social_Benefits_Locality_Data  [1..1]  Encapsulating element containing all Social Benefits Locality data.   
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
top
 

Response Element: Put_Social_Benefits_Locality_Response

Response element for the Put Political Affiliation operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Social_Benefits_Locality_Reference  Social_Benefits_LocalityObject  [0..1]  A unique identifier used to reference a Social Benefits Locality   
top
 

Social_Benefits_LocalityObject

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

Social_Benefits_LocalityObjectID

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

Social_Benefits_Locality_Data

part of: Put_Social_Benefits_Locality_Request
Encapsulating element containing all Social Benefits Locality data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the Social Benefits Locality (Social_Benefits_Locality_ID).   
Name  string  [1..1]  The name of the Social Benefits Locality. 
Validation Description
Name is required.   
A Social Benefits Locality with the same name already exists for this Country. Each Social Benefits Locality name within a Country must be unique.   
 
Code  string  [0..1]  The code for the Social Benefits Locality.   
Description  string  [0..1]  The description for the Social Benefits Locality.   
Location_Reference  Location_ContextObject  [1..1]  The country that the Social Benefits Locality is for. 
Validation Description
Location (Country or Country Region) is required.   
 
Inactive  boolean  [0..1]  A boolean flag indicating whether the Social Benefits Locality is active or not.   
top
 

Location_ContextObject

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

Location_ContextObjectID

part of: Location_ContextObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, 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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_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 of a parent object   
top
 

Social_Benefits_LocalityReferenceEnumeration

part of: Social_Benefits_LocalityObjectID
Base Type
string
top
 

Location_ContextReferenceEnumeration

part of: Location_ContextObjectID
Base Type
string
top
 

Base Type
string

top