Get all enrolled promotion (Deprecated)
get
/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberPromotions
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 enrolled in promotion with a specified promotion member identifier.
Finder Variables:- LoyPromomemId; integer; The promotion member identifier.
- PrimaryKey: Finds a member enrolled in promotion with a specified promotion 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:- Active; string; The active status of the member promotion enrollment. The member might be enrolled in a promotion in the past and also in the future. For a current record, if this flag is true. then the enrollment of the member into an enrollable Promotion is active. There is no default value, dependency, or limitation associated with this attribute.
- EnrollmentEnd; string; The date when the promotion enrollment ends. A member can be enrolled into a particular promotion until this date. There is no default value, dependency, or limitation associated with this attribute.
- EnrollmentStart; string; The date when the promotion enrollment begins. A member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute.
- LoyPromomemId; integer; The promotion member identifier, which is the primary identifier to uniquely identify a member enrolled into a promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.
- ObjectVersionNumber; integer; The member promotion enrollment object version number. There is no default value, dependency, or limitation associated with this attribute.
- PromotionSubType; string; The promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.
- PromotionType; string; The promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. 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 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 : loyaltyMembers-MemberPromotions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyaltyMembers-MemberPromotions-item-response
Type:
Show Source
object
-
Active: string
Title:
Active
Read Only:true
Maximum Length:1
The active status of the member promotion enrollment. The member might be enrolled in a promotion in the past and also in the future. For a current record, if this flag is true. then the enrollment of the member into an enrollable Promotion is active. There is no default value, dependency, or limitation associated with this attribute. -
EnrollmentEnd: string
(date-time)
Title:
Member Enrollment End Date in Promotion.
The date when the promotion enrollment ends. A member can be enrolled into a particular promotion until this date. There is no default value, dependency, or limitation associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Promotion Enrollment Date
The date when the promotion enrollment begins. A member can be enrolled into a particular promotion beginning on this date. 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. -
LoyPromomemId: integer
(int64)
Title:
Loyalty Promotion Member ID
The promotion member identifier, which is the primary identifier to uniquely identify a member enrolled into a promotion for a given period. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
The member number, which is an alternative key to identify a member, and is shown along with the promotion name while identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The member promotion enrollment object version number. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
Promotion Name
The promotion name which is has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current member. There is no default value, dependency, or limitation associated with this attribute. -
PromotionSubType: string
Read Only:
true
The promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
PromotionType: string
Read Only:
true
The promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. 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.