Jump to

• Request
• Response

Get all referrals (Deprecated)

get

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

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a member referral with a specified member identifier.
    Finder Variables:
    • LoyMemberId; integer; The member identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ContactId; integer; 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.
  • LoyMemberId; integer; 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; 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; 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; 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; 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; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

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.

Body ()

Root Schema : loyaltyMembers-MemberReferrals

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/loyaltyMembers-MemberReferrals-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object loyaltyMembers-MemberReferrals-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/loyaltyMembers-MemberReferrals-item-response"
    }
}

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