Get a program benefit for an enrollment
get
/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Request
Path Parameters
-
EnrollmentNumber(required): string
The alternate key identifier of the program enrollment.
-
ProgramBenefitDetailId(required): integer
The unique identifier of the program benefit details.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : programEnrollments-ProgramBenefitDetails-item-response
Type:
Show Source
object
-
BenefitListValue: string
The value of the benefit. The attribute has a value when the Datatype is of type List.
-
BenefitValue: string
Title:
Benefit Value
Maximum Length:150
The value of the benefit. -
CategoryCode: string
Title:
Category
Read Only:true
Maximum Length:30
The code indicating the category of the benefit. For example, Financial, Sales, Technical Support, and so on. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The date and time when the record was last updated. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The user who last created the record. -
DataType: string
Title:
Value Type
Read Only:true
Maximum Length:30
The value type of the benefit. For example, Amount, List, Number, Text, Yes/No. -
DeleteFlag: boolean
Read Only:
true
Indicates if the record can be deleted. The default value is false. -
Description: string
Title:
Benefits Description
Read Only:true
Maximum Length:1000
The text describing the benefit. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the program benefit detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:155
The name of the benefit. -
PartnerProgramId: integer
(int64)
Title:
Program
The identifier of the partner program associated with the enrollment. -
ProgramBenefitDetailId: integer
Title:
Program Benefit Details
The unique identifier of the program benefit details. -
ProgramBenefitId: integer
(int64)
Title:
Benefit
The unique identifier of the program benefit. -
TierId: integer
(int64)
Title:
Tier
The unique identifier of the associated tier for the program benefit. -
TierName: string
Title:
Name
Read Only:true
Maximum Length:155
The name of the tier associated with the benefit. -
UpdateFlag: boolean
Read Only:
true
Indicates if the record can be updated. The default value is false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BenefitCategoryCodes
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZPM_BENEFIT_CATEGORY%2CBindLookupCode%3D{CategoryCode}
The list of values for the benefit category such as Financial, Marketing, Sales, and so on. This field cannot be updated.
The following properties are defined on the LOV link relation:- Source Attribute: CategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BenefitListTypeValues
-
The list of values for the benefit list type. The user creates the values while defining benefit of list type.
The following properties are defined on the LOV link relation:- Source Attribute: BenefitListValue; Target Attribute: BenefitListTypeValId
- Display Attribute: ValueName
- Benefits
-
The list of values for the name of the Program benefit. The user creates the values while defining benefit(s).
The following properties are defined on the LOV link relation:- Source Attribute: Name; Target Attribute: Name
- Display Attribute: Name
- ProgramTiers
-
The list of values for the program tier.The user creates the values by adding tier to a program.
The following properties are defined on the LOV link relation:- Source Attribute: TierId; Target Attribute: TierId
- Display Attribute: Name
Examples
The following example shows how to get a program benefit for a program enrollment by submitting a get request on the REST resource using cURL.
cURL Command
curl -v -u user:password
-X GET "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/CDRM_12005/child/ProgramBenefitDetails/300100071293762"
Example of Response Body
The following shows an example of the response body in JSON format.
{ "BenefitValue" : null, "CreatedBy" : "CHANNEL_PARTNER_MANAGER", "CreationDate" : "2016-02-17T16:53:58-08:00", "LastUpdateDate" : "2016-02-17T16:53:58-08:00", "LastUpdatedBy" : "CHANNEL_PARTNER_MANAGER", "PartnerProgramId": "300100000339515", "ProgramName": "PLATINUM PROGRAM", "ProgramDescription": "PLATINUM PROGRAM" "TierId" : null, "DataType" : "ORA_NUMBER", "Name" : "Discount Sale", "Description" : null, "TierName" : null, "CategoryCode" : null, "BenefitListValue" : null, "UpdateFlag" : "true", "DeleteFlag" : "true", ... }