Get an additional name
get
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}
Request
Path Parameters
-
NameId(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=
-
PartyNumber(required): string
The unique primary identifier for the household 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.
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 : households-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 additional name record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the additional name 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 when the additional name record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the additional name 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 record. -
NameId: integer
(int64)
Read Only:
true
The unique identifier of the name. -
NameType: string
Title:
Additional Name Type
Maximum Length:30
Determines the AdditionalName Types. Can be validated against HZ_NAME_AND_ID_TYPES_VL.TYPE_CODE. Sample values: LEGAL,PRIMARY etc.. -
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 following properties are defined on the LOV link relation:- Source Attribute: NameType; Target Attribute: TypeCode
- Display Attribute: TypeName
- finder:
- StatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TransliterationLanguageLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: TransliterationLanguage; Target Attribute: LanguageCode
- Display Attribute: Description