Create a recommendation
post
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendations
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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
LengthOfRelationship: number
Title:
Length of Relationship
Indicates how long the student has known the recommender, in years. -
OrganizationAddress: string
Title:
External Organization Address
Maximum Length:500
Location address of the external organization associated with the recommender. -
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. -
RecommendationTypeCode: string
Title:
Recommendation Type Code
Maximum Length:30
Type code for the individual, group, or organization offering the recommendation. -
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.
Response
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 : 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: