Get a relationship
get
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationships/{relationshipsUniqID}
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=
-
relationshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Relationships resource and used to uniquely identify an instance of Relationships. The client should not generate the hash key value. Instead, the client should query on the Relationships collection resource in order to navigate to a specific instance of Relationships 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-relationships-item-response
Type:
Show Source
object
-
AttendedInstDegreeRecCode: string
Title:
Institution Degree Code
Maximum Length:30
Code of the highest degree earned by the relationship specified. -
AttendedInstDegreeRecMeaning: string
Title:
Institution Degree
Read Only:true
Maximum Length:80
Meaning of the highest degree earned by the relationship specified. -
AttendedInstitutionDate: string
(date)
Title:
Institution Degree Date
Date the degree was received at this institution for the relationship specified. -
AttendedInstitutionFlag: boolean
Title:
Attended Institution
Maximum Length:1
Indicates whether the relationship specified has attended this institution. -
HighestDegreeEarnedCode: string
Title:
Highest Degree Earned Code
Maximum Length:30
Name of the degree earned at this institution for the relationship specified. -
HighestDegreeEarnedDate: string
(date)
Title:
Highest Degree Earned Date
Date on which the highest degree was earned for the relationship specified. -
HighestDegreeEarnedMeaning: string
Title:
Highest Degree Earned
Read Only:true
Maximum Length:80
Meaning of the degree earned for the relationship specified. -
HighestDegreeOrgPartyId: integer
(int64)
Title:
Highest Degree Institution ID
Trading community party identifier for the external organization where the relative has earned the highest degree. -
HighestDegreeOrgPartyName: string
Title:
Highest Degree Institution
Read Only:true
Maximum Length:100
Trading community party name of the external organization where the relative has earned the highest degree. -
HighestOrgOtherName: 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. -
HighestOrgOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Phone area code of the relationship specified. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Phone country code of the relationship specified. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
Phone contact number of the relationship specified. -
RelationshipEmployedIn: string
Title:
Relationship Place of Employment
Maximum Length:60
Place where the relationship specified is employed. -
RelationshipFirstName: string
Title:
Relationship First Name
Maximum Length:150
First name of the relationship specified. -
RelationshipGenderCode: string
Title:
Relationship Gender Code
Maximum Length:30
Gender of the relationship specified. -
RelationshipGenderMeaning: string
Title:
Relationship Gender
Read Only:true
Maximum Length:80
Meaning of relationship specified gender. -
RelationshipLastName: string
Title:
Relationship Last Name
Maximum Length:150
Last name of the relationship specified. -
RelationshipLivingFlag: boolean
Title:
Relationship Living
Maximum Length:1
Indicates whether the relationship specified is alive or deceased. -
RelationshipMailingAddr: string
Title:
Relationship Mailing Address
Maximum Length:1000
Mailing address of the relationship specified. -
RelationshipMiddleName: string
Title:
Relationship Middle Name
Maximum Length:60
Middle name of the relationship specified. -
RelationshipOccupation: string
Title:
Relationship Occupation
Maximum Length:60
Occupation or professional title of the relationship specified. -
RelationshipPersonalEmail: string
Title:
Relationship Personal Email
Maximum Length:1000
Email of the relationship specified. -
RelationshipPrefix: string
Title:
Relationship Prefix
Maximum Length:100
Name prefix for the relationship specified. -
RelationshipSuffix: string
Title:
Relationship Suffix
Maximum Length:30
Name suffix for the relationship specified. -
RelationshipTransactionId: integer
(int64)
Title:
Relationship Transaction ID
Read Only:true
Relationship transaction unique identifier. -
RelationshipTypeCode: string
Title:
Relationship Type Code
Maximum Length:30
Type code of the relationship. -
RelationshipTypeMeaning: string
Title:
Relationship Type
Read Only:true
Maximum Length:80
Meaning of the relationship code. -
RelativesBirthCountryCode: string
Title:
Relationship Birth Country Code
Maximum Length:30
Country where the relationship specified was born. -
RelativesBirthCountryName: string
Title:
Relationship Country of Birth
Read Only:true
Maximum Length:80
Name of country where the relationship specified was born. -
UndergradDegreeDate: string
(date)
Title:
Undergrad Degree Earned Date
Date the undergrad degree was earned for the relationship specified. -
UndergradDegreeEarnFlag: boolean
Title:
Undergrad Degree Earned
Maximum Length:1
Indicates whether the relationship specified holds an undergrad degree. -
UndergradOrgOtherName: 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. -
UndergradOrgOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
UndergradOrgPartyId: integer
(int64)
Title:
Undergrad Institution ID
Trading community party identifier for the external organization associated with the relationship specified. -
UndergradOrgPartyName: string
Title:
Undergrad Institution
Read Only:true
Maximum Length:100
Trading community party name of the external organization associated with the relationship specified.
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
- AttendedInstDegreeRecCodeLookupsLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_DEGREE%2CLookupCode%3D{AttendedInstDegreeRecCode}
The following properties are defined on the LOV link relation:- Source Attribute: AttendedInstDegreeRecCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- highestDegreeEarnedCodeLookupsLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_DEGREE%2CLookupCode%3D{HighestDegreeEarnedCode}
The following properties are defined on the LOV link relation:- Source Attribute: HighestDegreeEarnedCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- highestDegreeOrganizationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: HighestDegreeOrgPartyId; 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
- relationshipGenderCodeLookupsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_GENDER%2CLookupCode%3D{RelationshipGenderCode}
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipGenderCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- relationshipTypeCodeLookupsLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_RELATIONSHIP_TYPE%2CLookupCode%3D{RelationshipTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- territoriesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: RelativesBirthCountryCode; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- undergradOrganizationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: UndergradOrgPartyId; Target Attribute: PartyId
- Display Attribute: OrganizationName