Jump to

• Request
• Response

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:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MemberAssociationPUID":{
            "title":"Member Association Public Unique ID",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "AssociationStartDate":{
            "title":"Association Start Date",
            "type":"string",
            "description":"The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":false
        },
        "MemberAssociationId":{
            "title":"Member Association ID",
            "type":"integer",
            "description":"The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssociationEndDate":{
            "title":"Association End Date",
            "type":"string",
            "description":"The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : loyMembers-groupMembers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MemberAssociationPUID":{
            "title":"Member Association Public Unique ID",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupMemberNumber":{
            "title":"Group Member Public Unique ID",
            "maxLength":"30",
            "type":"string",
            "description":"The group member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberNumber":{
            "title":"Member Number",
            "maxLength":"30",
            "type":"string",
            "description":"The member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberAssociationType":{
            "title":"Member Association Type",
            "maxLength":"30",
            "type":"string",
            "description":"The member association type of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_MEM_TYPE_INDIVIDUAL",
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Association Start Date",
            "type":"string",
            "description":"The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MemberName":{
            "title":"Member Name",
            "maxLength":"100",
            "type":"string",
            "description":"The member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberAssociationId":{
            "title":"Member Association ID",
            "type":"integer",
            "description":"The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupMemberName":{
            "title":"Group Member Name",
            "maxLength":"100",
            "type":"string",
            "description":"The group member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"Association End Date",
            "type":"string",
            "description":"The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top