Get a recommendation
get
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations/{recommendationsUniqID}
Request
Path Parameters
-
ApplicationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
recommendationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Recommendations resource and used to uniquely identify an instance of Recommendations. The client should not generate the hash key value. Instead, the client should query on the Recommendations collection resource in order to navigate to a specific instance of Recommendations to get the hash key.
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(required):
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(required):
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 : admissionApplications-recommendations-item-response
Type:
Show Source
object
-
LastInviteSentDate: string
(date-time)
Title:
Last Invite Sent Date
Read Only:true
The last date and time a recommendation invite was sent for the row. -
LengthOfRelationship: number
Title:
Length of Relationship
Indicates how long the student has known the recommender, in years. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationAddress: string
Title:
External Organization Address
Maximum Length:500
Location address of the external organization associated with the recommender. -
OrganizationName: string
Title:
Organization Name
Read Only:true
Maximum Length:100
Indicates whether an external organization name has been entered by the student. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization associated with the recommender. -
PhoneAreaCode: string
Title:
Recommender Phone Area Code
Maximum Length:10
Phone area code of the recommender. -
PhoneCountryCode: string
Title:
Recommender Phone Country Code
Maximum Length:10
Phone country code of the recommender. -
PhoneNumber: string
Title:
Recommender Phone Number
Maximum Length:40
Phone Number of the recommender. -
RecommendationTransactionId: integer
(int64)
Title:
Recommendation Transaction ID
Read Only:true
Recommendation transaction unique identifier. -
RecommendationTypeCode: string
Title:
Recommendation Type Code
Maximum Length:30
Type code for the individual, group, or organization offering the recommendation. -
RecommendationTypeCodeMeaning: string
Title:
Recommendation Type
Read Only:true
Maximum Length:80
Meaning of recommendation type code. -
RecommenderAddress: string
Title:
Recommender Address
Maximum Length:1000
Address of the recommender. -
RecommenderDescription: string
Title:
Recommender Description
Maximum Length:1000
Description of the recommender. -
RecommenderEmailAddress: string
Title:
Recommender Email Address
Maximum Length:1000
Email address of the recommender. -
RecommenderFirstName: string
Title:
Recommender First Name
Maximum Length:150
First name of the recommender. -
RecommenderLastName: string
Title:
Recommender Last Name
Maximum Length:150
Last name of the recommender. -
RecommenderNameTitle: string
Title:
Recommender Title
Maximum Length:100
Title of the recommender, such as counselor. -
RelationshipToStudent: string
Title:
Relationship to Student
Maximum Length:200
Indicates how the student knows the recommender. -
SendInviteFlag: boolean
Title:
Send Invite Indicator
Indicates if invite has been sent.
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
- organizationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: OrganizationPartyId; Target Attribute: PartyId
- Display Attribute: OrganizationName
- phoneCountryCodesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName
- recommendationTypeCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_RECOMMENDATION_TYPE%2CLookupCode%3D{RecommendationTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: RecommendationTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: