Get all Student Management organization contacts
get
/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts
Request
Query Parameters
-
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 -
finder: string
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.
- ByContactPartyIdFinder Finds all Student Management organization contacts that match the Party ID.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
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 : hedOrganizationContacts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedOrganizationContacts-item-response
Type:
Show Source
object
-
ConstituentId: string
Title:
Constituent ID
Read Only:true
Maximum Length:30
The unique identifier for a constituent. -
contactAssociations: array
Student Management Organization Contact Associations
Title:
Student Management Organization Contact Associations
The contact associations resource is used to associate a Student Management organization contact with a Student Management organization. -
ContactPartyId: integer
(int64)
Title:
Party ID
Read Only:true
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
Title:
Contact Status Code
Maximum Length:30
Default Value:ORA_ACTIVE
The contact status code for this contact. -
ContactStatusMeaning: string
Title:
Contact Status
Read Only:true
Maximum Length:80
The meaning of the default contact type code for this contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Created On
Read Only:true
The date the row was created. -
DefaultContactTypeCode: string
Title:
Default Contact Type Code
Maximum Length:30
The default contact type code for this contact. -
DefaultContactTypeMeaning: string
Title:
Default Contact Type
Read Only:true
Maximum Length:80
The meaning of the default contact type code for this contact. -
DefaultDepartment: string
Title:
Default Department
Maximum Length:100
The default department of this contact. -
DefaultJobTitle: string
Title:
Default Job Title
Maximum Length:100
The default job title for this contact. -
emails: array
Student Management Organization Contact Emails
Title:
Student Management Organization Contact Emails
The emails resource contains the email addresses of the Student Management organization contacts. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Maximum Length:360
The first and last name of the person displayed as a single string. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
names: array
Student Management Organization Contact Names
Title:
Student Management Organization Contact Names
The names resource contains the names of the Student Management organization contacts. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The name suffix of the person such as junior or senior. -
phones: array
Student Management Organization Contact Phones
Title:
Student Management Organization Contact Phones
The phones resource contains the phone numbers of the Student Management organization contacts. -
PreferredFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The preferred first name of a person. -
PreferredFullName: string
Title:
Preferred Name
Read Only:true
Maximum Length:360
The preferred first and last name of the person displayed as a single string. -
PreferredLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The preferred last name of a person. -
PreferredMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The preferred middle name of a person. -
PreferredNameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The name suffix of the person such as junior or senior. -
PreferredNameTitle: string
Title:
Prefix
Read Only:true
Maximum Length:60
The title of the person, such as Mr or Mrs. -
PrimaryEmailAddress: string
Title:
Primary Email
Maximum Length:320
The email address of the person. -
PrimaryPhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:20
The area code within a country. -
PrimaryPhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PrimaryPhoneExtension: string
Title:
Phone Number Extension
Maximum Length:20
The extension number for a phone number. -
PrimaryPhoneNumber: string
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: string
Title:
Prefix
Maximum Length:60
The title of the person, such as Mr or Mrs.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AssociatedObjectId: integer
(int64)
Title:
Associated Object ID
Read Only:true
The unique identifier of the associated object. -
AssociationEndDate: string
(date)
Title:
End Date
Read Only:true
The end or expiration date of the contact association. -
AssociationStartDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the contact association. -
ContactAssociationId: integer
(int64)
Title:
Contact Association ID
Read Only:true
The unique identifier for the organization contact association record. -
ContactTypeCode: string
Title:
Contact Type Code
Read Only:true
Maximum Length:30
Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
ContactTypeMeaning: string
Title:
Contact Type
Read Only:true
Maximum Length:80
The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Created On
Read Only:true
The date the row was created. -
Department: string
Title:
Department
Read Only:true
Maximum Length:100
The name of the department that the contact belongs to. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the associated contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCategoryCode: string
Title:
Organization Category Code
Maximum Length:30
Default Value:ORA_HER_EXTERNAL_ORG
The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
OrganizationCategoryMeaning: string
Title:
Organization Category
Read Only:true
Maximum Length:80
The category name or meaning of the associated Student Management entity. -
OrganizationDescription: string
Title:
Organization Description
Read Only:true
A description of the associated Student Management entity. -
OrganizationName: string
Title:
Organization Name
Read Only:true
The name of the associated Student Management entity. -
PrimaryContactFlag: boolean
Title:
Primary Contact
Read Only:true
Maximum Length:1
Indicates that this person should be the primary contact.
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.
Nested Schema : hedOrganizationContacts-emails-item-response
Type:
Show Source
object
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
EmailId: integer
(int64)
Title:
Email ID
Read Only:true
The unique identifier for an email address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred email address to use for the contact. The default value is: false. -
PurposeCode: string
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. -
PurposeMeaning: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedOrganizationContacts-names-item-response
Type:
Show Source
object
-
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
FullName: string
Title:
Full Name
Maximum Length:360
The first and last name of the person displayed as a single string. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of a person. -
NameSuffix: string
Title:
Name Suffix
Maximum Length:30
The name suffix of a person such as junior or senior. -
NameTypeCode: string
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. -
NameTypeMeaning: string
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. -
PartyNameId: integer
(int64)
Title:
Party Name ID
Read Only:true
The unique identifier for a name. -
PreferredFlag: boolean
Title:
Preferred
Indicates that this name record contains the person's preferred name. -
SingleNameFlag: boolean
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: string
Title:
Title
Maximum Length:60
The title of the person, such as Mr or Mrs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedOrganizationContacts-phones-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code within a country. -
PhoneCountryCode: string
Title:
Country Code
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
The extension number for a phone number. -
PhoneId: integer
(int64)
Title:
Phone ID
Read Only:true
The unique identifier for a phone number. -
PhoneNumber: string
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. -
PreferredFlag: boolean
Title:
Preferred
Maximum Length:1
Default Value:false
Indicates the preferred phone number to use for the contact. The default value is: false. -
PurposeCode: string
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. -
PurposeMeaning: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source