1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Student Management Organization Contacts

Get all Student Management organization contacts

get

/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts

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

    • ByContactPartyIdFinder Finds all Student Management organization contacts that match the Party ID.
      Finder Variables
      • ContactPartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
    • ByKeywordFinder Finds all Student Management organization contacts that match the keyword provided.
      Finder Variables
      • Keyword; string; A keyword to search for contact name, job title, department, contact type, email address, and contact party ID.
    • PrimaryKey Finds all Student Management organization contacts that match the Party ID.
      Finder Variables
      • ContactPartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
  • 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:
    • ConstituentId; string; The unique identifier for a constituent.
    • ContactPartyId; integer; The unique identifier for the party. Party can be a person or an organization. Organizational contacts will always be a party of type person.
    • ContactStatusCode; string; The contact status code for this contact.
    • ContactStatusMeaning; string; The meaning of the default contact type code for this contact.
    • CreatedBy; string; The user who created the row.
    • CreationDate; string; The date the row was created.
    • DefaultContactTypeCode; string; The default contact type code for this contact.
    • DefaultContactTypeMeaning; string; The meaning of the default contact type code for this contact.
    • DefaultDepartment; string; The default department of this contact.
    • DefaultJobTitle; string; The default job title for this contact.
    • FirstName; string; The first name of the person.
    • FullName; string; The first and last name of the person displayed as a single string.
    • LastName; string; The last name of the person.
    • LastUpdateDate; string; The date the row was last updated.
    • LastUpdatedBy; string; The user who last updated the row.
    • MiddleName; string; The middle name of the person.
    • NameSuffix; string; The name suffix of the person such as junior or senior.
    • PreferredFirstName; string; The preferred first name of a person.
    • PreferredFullName; string; The preferred first and last name of the person displayed as a single string.
    • PreferredLastName; string; The preferred last name of a person.
    • PreferredMiddleName; string; The preferred middle name of a person.
    • PreferredNameSuffix; string; The name suffix of the person such as junior or senior.
    • PreferredNameTitle; string; The title of the person, such as Mr or Mrs.
    • PrimaryEmailAddress; string; The email address of the person.
    • PrimaryPhoneAreaCode; string; The area code within a country.
    • PrimaryPhoneCountryCode; string; The international country code for a phone number. For example, 33 for France.
    • PrimaryPhoneExtension; string; The extension number for a phone number.
    • PrimaryPhoneNumber; string; The phone number formatted in the local format. The number should not include area code, country code, or extension.
    • Title; string; The title of the person, such as Mr or Mrs.
  • 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 : hedOrganizationContacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : hedOrganizationContacts-item-response
Type: object
Show Source
Nested Schema : Student Management Organization Contact Associations
Type: array
Title: Student Management Organization Contact Associations
The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.
Show Source
Nested Schema : Student Management Organization Contact Emails
Type: array
Title: Student Management Organization Contact Emails
The emails resource contains the email addresses of the Student Management organization contacts.
Show Source
Nested Schema : Student Management Organization Contact Names
Type: array
Title: Student Management Organization Contact Names
The names resource contains the names of the Student Management organization contacts.
Show Source
Nested Schema : Student Management Organization Contact Phones
Type: array
Title: Student Management Organization Contact Phones
The phones resource contains the phone numbers of the Student Management organization contacts.
Show Source
Nested Schema : hedOrganizationContacts-contactAssociations-item-response
Type: object
Show Source
Nested Schema : hedOrganizationContacts-emails-item-response
Type: object
Show Source
  • Title: Email
    Maximum Length: 320
    The email address of the contact.
  • Title: Email ID
    Read Only: true
    The unique identifier for an email address.
  • Links
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred email address to use for the contact. The default value is: false.
  • Title: Purpose Code
    Maximum Length: 30
    The type of purpose for the email contact point, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Purpose
    Read Only: true
    Maximum Length: 80
    The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE_WEB.
Nested Schema : hedOrganizationContacts-names-item-response
Type: object
Show Source
  • Title: First Name
    Maximum Length: 150
    The first name of a person.
  • Title: Full Name
    Maximum Length: 360
    The first and last name of the person displayed as a single string.
  • Title: Last Name
    Maximum Length: 150
    The last name of a person.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    The middle name of a person.
  • Title: Name Suffix
    Maximum Length: 30
    The name suffix of a person such as junior or senior.
  • Title: Name Type
    Maximum Length: 30
    The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
  • Title: Name Type
    Read Only: true
    Maximum Length: 80
    The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
  • Title: Party Name ID
    Read Only: true
    The unique identifier for a name.
  • Title: Preferred
    Indicates that this name record contains the person's preferred name.
  • Title: Only One Name
    Maximum Length: 1
    Default Value: false
    Indicates if the person has single name, typically a last name only, and that other names such as first name and middle name are intentionally blank.
  • Title: Title
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : hedOrganizationContacts-phones-item-response
Type: object
Show Source
  • Links
  • Title: Area Code
    Maximum Length: 20
    The area code within a country.
  • Title: Country Code
    Maximum Length: 10
    The international country code for a phone number. For example, 33 for France.
  • Title: Phone Extension
    Maximum Length: 20
    The extension number for a phone number.
  • Title: Phone ID
    Read Only: true
    The unique identifier for a phone number.
  • Title: Phone Number
    Maximum Length: 40
    The phone number formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Preferred
    Maximum Length: 1
    Default Value: false
    Indicates the preferred phone number to use for the contact. The default value is: false.
  • Title: Purpose Code
    Maximum Length: 30
    The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
  • Title: Purpose
    Read Only: true
    Maximum Length: 80
    The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
Back to Top