Service Directory > v32.1 > Revenue_Management > Put_Subaward
 

Operation: Put_Subaward

This service operation will update a Subaward. Subaward data includes Subaward Reference, Award Contract Reference, Award Contract Line Reference, Subrecipient Reference, Location Reference, Subject to FFATA Reference, Attachment Data, and Subaward Contact Data.


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

Element containing Subaward reference for update and for all Subaward data items.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Subaward_Reference  Subaward_AbstractObject  [1..1]  Reference to an existing Subaward for update only purposes.   
Subaward_Data  Subaward_Data  [0..1]  Wrapper element that includes all data for a single Subaward. 
Validation Description
Award Line entered does not have a Subrecipient.   
Subrecipient for Award Line does not match Subrecipient entered.   
Subrecipient for Subaward does not match Subrecipient entered.   
The grant on the supplier contract must match the grant on the award line.   
Award Line entered already has a different Subaward associated to it. Enter an Award Line that does not have a Subaward.   
Award Line entered does not match the Award Contract entered.   
You must enter Yes in the Subject to FFATA field if you enter an FFATA Amount.   
 
top
 

Response Element: Put_Subaward_Response

Response Element to hold Subaward Reference
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Subaward_Reference  Subaward_AbstractObject  [0..1]  Subaward Reference   
top
 

Subaward_AbstractObject

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

Subaward_AbstractObjectID

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

Subaward_Data

part of: Put_Subaward_Request
Element containing Grants related data for a single Subaward.
 
Parameter name Type/Value Cardinality Description Validations
Subaward_ID  string  [0..1]  Subaward Reference ID. This is the Subaward unique identifier.   
Award_Contract_Reference  Award_ContractObject  [0..1]  The Award Contract Reference related to the Subaward.   
Award_Contract_Line_Reference  Award_Contract_LineObject  [1..1]  Award Contract Line Reference related to the Subaward.   
Subrecipient_Reference  Subrecipient_AbstractObject  [0..1]  The Subrecipient Reference related to the Subaward.   
Location_Reference  LocationObject  [0..*]  The Location Reference related to the Subaward.   
Subject_to_FFATA_Reference  Subject_to_FFATAObject  [0..1]  The Subaward is subject to FFATA Reference related to the Subaward.   
FFATA_Amount  decimal (17, 2) >0   [0..1]  The amount subject to FFATA.   
Attachment_Data  Financials_Attachment_Data  [0..*]  Attachment Data 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Subaward_Contact_Data  Subaward_Business_Entity_Contact_Data  [0..*]  The Subaward Contact Data related to the Subaward. 
Validation Description
Business Entity Contact Type Usage is not Subaward.   
Business Entity Contact entered is already in use on another Subaward.   
Contact Type marked as Inactive cannot be added to the subaward.   
 
Validation Description
Award Line entered does not have a Subrecipient.   
Subrecipient for Award Line does not match Subrecipient entered.   
Subrecipient for Subaward does not match Subrecipient entered.   
The grant on the supplier contract must match the grant on the award line.   
Award Line entered already has a different Subaward associated to it. Enter an Award Line that does not have a Subaward.   
Award Line entered does not match the Award Contract entered.   
You must enter Yes in the Subject to FFATA field if you enter an FFATA Amount.   
top
 

Award_ContractObject

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

Award_ContractObjectID

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

Award_Contract_LineObject

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

Award_Contract_LineObjectID

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

Subrecipient_AbstractObject

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

Subrecipient_AbstractObjectID

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

LocationObject

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

LocationObjectID

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

Subject_to_FFATAObject

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

Subject_to_FFATAObjectID

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

Financials_Attachment_Data

part of: Subaward_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Subaward_Business_Entity_Contact_Data

part of: Subaward_Data
Element containing Business Entity Contact Data with Contact Type specific to Subawards.
 
Parameter name Type/Value Cardinality Description Validations
Contact_Type_Reference  Business_Entity_Contact_Type_TenantedObject  [0..1]  The Business Entity Contact Type Tenanted Reference related to Subaward Business Entity Contact Type Usage.   
Subaward_Business_Entity_Contact_Reference  Business_Entity_ContactObject  [0..1]  Business Entity Contact Data   
Validation Description
Business Entity Contact Type Usage is not Subaward.   
Business Entity Contact entered is already in use on another Subaward.   
Contact Type marked as Inactive cannot be added to the subaward.   
top
 

Business_Entity_Contact_Type_TenantedObject

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

Business_Entity_Contact_Type_TenantedObjectID

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

Business_Entity_ContactObject

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

Business_Entity_ContactObjectID

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

Subaward_AbstractReferenceEnumeration

part of: Subaward_AbstractObjectID
Base Type
string
top
 

Award_ContractReferenceEnumeration

part of: Award_ContractObjectID
Base Type
string
top
 

Award_Contract_LineReferenceEnumeration

part of: Award_Contract_LineObjectID
Base Type
string
top
 

Subrecipient_AbstractReferenceEnumeration

part of: Subrecipient_AbstractObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Subject_to_FFATAReferenceEnumeration

part of: Subject_to_FFATAObjectID
Base Type
string
top
 

Business_Entity_Contact_Type_TenantedReferenceEnumeration

part of: Business_Entity_Contact_Type_TenantedObjectID
Base Type
string
top
 

Business_Entity_ContactReferenceEnumeration

part of: Business_Entity_ContactObjectID
Base Type
string
top