1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Program Enrollments

Get all enrollments

get

/crmRestApi/resources/11.13.18.05/programEnrollments

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • EnrollmentNumber: The alternate key identifier of the program enrollment.
      Finder Variables:
      • EnrollmentNumber; string; The alternate key identifier of the program enrollment.
    • EnrollmentNumberRF: Finds an enrollment with the specified enrollment number.
      Finder Variables:
      • EnrollmentNumber; string; The alternate key identifier of the program enrollment.
    • PrimaryKey: Finds an enrollment with the specified program enrollment ID.
      Finder Variables:
      • ProgramEnrollmentId; number; The unique identifier of a partner program enrollment.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActiveEnrollment; string; The activity status of the enrollment. The accepted values are active and inactive.
    • CreatedBy; string; The user who created the enrollment record.
    • CreationDate; string; The date and time when the record was created.
    • EnrollmentNumber; string; The alternate key identifier of the program enrollment.
    • EnrollmentStatus; string; The status of the enrollment. The accepted values are draft, pending, approved, rejected, terminated, and renewed. A list of valid values is defined in the lookup ZPM_ENROLLMENT_STATUS.
    • ExpirationDate; string; The date when the enrollment expires.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • PartnerCompanyNumber; string; Public Unique Identifier of Partner company associated to the Program Enrollments.
    • PartnerPartyId; number; The unique identifier of a partner.
    • PartnerPartyName; string; The name of the partner.
    • PartnerProgramId; number; The unique identifier of a partner program.
    • PartnerTierId; integer; The tier of the partner.
    • PrimaryContactId; number; The unique identifier of the person to contact for the program enrollments.
    • ProgramDescription; string; The description of the program.
    • ProgramEnrollmentId; number; The unique identifier of a partner program enrollment.
    • ProgramName; string; The name of the partner program.
    • ProgramNumber; string; The alternate key identifier of the program.
    • RenewedEnrollment; string; The renewal status of the enrollment. The accepted values are new and renewal.
    • RenewedFromId; number; The unique identifier of the enrollment from which the renewal enrollment is copied.
    • StartDate; string; The effective date when the program enrollment starts.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : programEnrollments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : programEnrollments-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program.
Show Source
Nested Schema : Partner Programs
Type: array
Title: Partner Programs
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on.
Show Source
Nested Schema : Program Benefit Details
Type: array
Title: Program Benefit Details
The program benefit details resource is used to view the details of a program benefit.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : programEnrollments-Attachments-item-response
Type: object
Show Source
Nested Schema : programEnrollments-Notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the note record.
  • Title: Creation Date
    Read Only: true
    The date and time when the note record was created.
  • Title: Creator Party ID
    The unique party identifier for the note creator.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Title: Primary Address
    Read Only: true
    The address of the user who created the note.
  • Title: Primary Phone
    Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    The date when the note data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique Identifier of the note associated with the contact. This is the primary key of the notes table.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The actual note text.
  • Title: Type
    Maximum Length: 30
    This code indicating the type of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Title: Party ID
    Read Only: true
    The unique Identifier of the contact to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of a contact party.
  • Title: Related Object Type
    Maximum Length: 30
    The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • Title: Related Object
    Maximum Length: 64
    The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal, external or private. A list of valid values is defined in the lookup ZMM_NOTE_VISIBILITY.
Nested Schema : programEnrollments-PartnerProgram-item-response
Type: object
Show Source
  • Title: Countries
    Read Only: true
    The name of the countries for the program.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the program record.
  • Title: Creation Date
    Read Only: true
    The date and time when the program record was created.
  • Read Only: true
    Indicates if the record can be deleted. The default value is false.
  • Title: End Date
    The effective data when the program ends.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the program record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who updated the program record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Owner Party Number
    Read Only: true
    Maximum Length: 30
    Public Unique Identifier of Owner Party on the Partner Programs.
  • Title: Program ID
    The unique Identifier of the partner program associated with the enrollment. This is the primary key of the partnerprogram table.
  • Title: Description
    Maximum Length: 1000
    The description of the program.
  • Title: Program Manager ID
    The unique identifier of the person managing the partner program.
  • Title: Owner
    Maximum Length: 360
    The name of the program manager.
  • Title: Name
    Maximum Length: 150
    The name of the partner program.
  • Title: Program Number
    Maximum Length: 30
    The unique number generated for the program.
  • Title: Type
    Maximum Length: 30
    The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE.
  • Title: Start Date
    The effective date when the program starts.
  • Title: Status
    Maximum Length: 30
    Default Value: D
    The status of the partner program. The accepted values are draft, pending, published, and terminated.
  • Read Only: true
    Indicates if the record can be updated. The default value is false.
Nested Schema : programEnrollments-ProgramBenefitDetails-item-response
Type: object
Show Source
Nested Schema : programEnrollments-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : programEnrollments-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : programEnrollments-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : programEnrollments-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Examples

The following example shows how to get all enrollments by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/

Example of Response Body

The following shows an example of the response body in JSON format.

{
   "items" : [25]
   -0: {
EnrollmentStatus: "APPROVED"
LastUpdateDate: "2011-06-24T14:35:39-07:00"
PartnerPartyId: 100000016934002
PartnerProgramId: 300100000339515
ProgramEnrollmentId: 300100000408356
ApprovalDate: "2011-06-24"
ExpirationDate: "2014-06-24"
TerminationDate: null
StartDate: "2011-06-24"
RenewedFromId: null
RemainingDays: "0"
ProgramName: "BIQA_PRM PLATINUM PROGRAM"
ProgramDescription: "BIQA_PRM PLATINUM PROGRAM"
ActiveEnrollment: "INACTIVE"
RenewedEnrollment: "NEW"
PartnerPartyName: " High Technology "
...
}
    -1:
	{
...
}
...
}
Back to Top