Create all Student Management organization names
post
/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names
Request
Path Parameters
-
ContactPartyId(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
-
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. -
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. -
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.
Response
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-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 : 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
- NameTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_NAME_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: NameTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: