Jump to

• Request
• Response

Create a referral (Deprecated)

post

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberReferrals

Request

Path Parameters

• MemberNumber(required): string
  The member number. This attribute is an alternative identifier for a 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

{
    "type":"object",
    "properties":{
    }
}

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 : loyaltyMembers-MemberReferrals-item-response

Type: object

Show Source

• ContactId: integer (int64)
  Title: Contact ID

  Read Only: true

  The contact identifier of the member referral. This is the contact information of the member who is referred by the current top level member resource. 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.
• LoyMemberId: integer (int64)
  Title: Loyalty Member ID

  Read Only: true

  The member identifier of the member that referred the current member to the program. A single member can refer multiple members to a single program. There is no default value, dependency, or limitation associated with this attribute.
• MemNumber: string
  Title: Member Number

  Read Only: true

  Maximum Length: 30

  The MemNumber attribute in the child MemberReferrals resource shows the member number of the member to whom the parent member refers to in a program. There is no default value, dependency, or limitation associated with this attribute.
• MemTypeCode: string
  Title: Member Type

  Read Only: true

  Maximum Length: 30

  The member type of the member referral. That is, the type of membership that is held by the current member child referral record. Example values are ORA_MEM_TYPE_INDIVIDUAL, ORA_MEM_TYPE_COMP, and ORA_MEM_TYPE_HOUSEHOLD. There is no default value, dependency, or limitation associated with this attribute.
• Name: string
  Title: Member Name

  Read Only: true

  Maximum Length: 100

  The name of the member referral. When a single member refers other multiple members to a program, then the Name attribute in child MemberReferrals shows the referred member names. There is no default value, dependency, or limitation associated with this attribute.
• ReferredById: integer (int64)
  Title: Referred by ID

  Read Only: true

  The referred by identifier of the member referral. The child MemberReferral resource shows information on the parent members that referred the child members. There is no default value, dependency, or limitation associated with this attribute.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The status code of the member referral. This shows the status of the member that is referred to program, for example, Active or Inactive. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LoyMemberId":{
            "title":"Loyalty Member ID",
            "type":"integer",
            "description":"The member identifier of the member that referred the current member to the program. A single member can refer multiple members to a single program. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MemTypeCode":{
            "title":"Member Type",
            "maxLength":"30",
            "type":"string",
            "description":"The member type of the member referral. That is, the type of membership that is held by the current member child referral record. Example values are ORA_MEM_TYPE_INDIVIDUAL,\nORA_MEM_TYPE_COMP, and ORA_MEM_TYPE_HOUSEHOLD. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferredById":{
            "title":"Referred by ID",
            "type":"integer",
            "description":"The referred by identifier of the member referral. The child MemberReferral resource shows information on the parent members that referred the child members. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The contact identifier of the member referral. This is the contact information of the member who is referred by the current top level member resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the member referral. This shows the status of the member that is referred to program, for example, Active or Inactive. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemNumber":{
            "title":"Member Number",
            "maxLength":"30",
            "type":"string",
            "description":"The MemNumber attribute in the child MemberReferrals resource shows the member number of the member to whom the parent member refers to in a program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Member Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the member referral. When a single member refers other multiple members to a program, then the Name attribute in child MemberReferrals shows the referred member names. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":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