Create an additional name
post
/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName
Request
Path Parameters
-
PartyNumber(required): string
The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
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:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases. -
Description: string
Title:
Description
Maximum Length:240
The description of the Additional Name record -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
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. -
Name: string
Title:
Additional Name
Maximum Length:360
The name of the organization, person, or group party. For example, "Oracle" or "John Smith". -
NameType: string
Title:
Additional Name Type
Maximum Length:30
The type of the name. For example, ALIAS or LEGAL. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartySourceSystem: string
The source system name.
-
PartySourceSystemReferenceValue: string
The identifier for the record from the original system.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'. -
SourceSystem: string
The name of the source system for the associated party.
-
SourceSystemReferenceValue: string
The identifier of the source system reference for the associated party.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
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 : contacts-AdditionalName-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the contact record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the contact record was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the Additional Name record -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the contact was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact record. -
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. -
Name: string
Title:
Additional Name
Maximum Length:360
The name of the organization, person, or group party. For example, "Oracle" or "John Smith". -
NameId: integer
(int64)
Read Only:
true
The unique identifier of the name. -
NameType: string
Title:
Additional Name Type
Maximum Length:30
The type of the name. For example, ALIAS or LEGAL. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The public unique identifier of the party. -
PartySourceSystem: string
The source system name.
-
PartySourceSystemReferenceValue: string
The identifier for the record from the original system.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'. -
SourceSystem: string
The name of the source system for the associated party.
-
SourceSystemReferenceValue: string
The identifier of the source system reference for the associated party.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
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:
NameTypeFinder
The type of the name. For example, ALIAS or LEGAL. - finder:
- StatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_STATUS
Indicates whether the additional identifier is currently active. - finder:
- TransliterationLanguageLOV
-
The transliteration language associated with the additional name for account.