Create a group member association with a given loyalty member
post
/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/groupMembers
Request
Path Parameters
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
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
-
AssociationEndDate: string
(date)
Title:
Association End Date
The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
AssociationStartDate: string
(date)
Title:
Association Start Date
The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationId: integer
(int64)
Title:
Member Association ID
The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationPUID: string
Title:
Member Association Public Unique ID
The public unique identifier of the member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute.
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 : loyMembers-groupMembers-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
Title:
Association End Date
The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
AssociationStartDate: string
(date)
Title:
Association Start Date
The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
GroupMemberName: string
Title:
Group Member Name
Read Only:true
Maximum Length:100
The group member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
GroupMemberNumber: string
Title:
Group Member Public Unique ID
Read Only:true
Maximum Length:30
The group member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberAssociationId: integer
(int64)
Title:
Member Association ID
The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationPUID: string
Title:
Member Association Public Unique ID
The public unique identifier of the member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationType: string
Title:
Member Association Type
Read Only:true
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member association type of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Read Only:true
Maximum Length:100
The member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Read Only:true
Maximum Length:30
The member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute.
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.