Upcoming Point Sweep

GET 
/client/users/:correlation_id/upcomingPointSweep

This request returns the upcoming point sweep for a member, grouped by upcoming month.

Note that the endpoint is gated by a feature switch that will cause an HTTP status code 400 to be returned if the feature is not enabled.

Request

Body

The request has no Body.

Response

Attribute	Definition	Format	Notes
pointSweeps	Contains the upcoming point sweep grouped by month	Array	Each element of the array has the 'sweepMonth' and 'pointsAmount' attributes.
count	Total of records	Number
pageSize	Page size of the results	Number
firstPage	First page of the results	Number
currentPage	Current page of the results	Number
lastPage	Last page of the results	Number

Error Responses

statusCode	errorMessage	errorCode	Definition
400 - Bad Request	FIFO feature is not enabled.	INVALID_REQUEST	This is a valid request to get upcoming point sweep, but the feature is disabled.
400 - Bad Request	PageSize required to be a valid positive number	INVALID_REQUEST	The 'pageSize' query parameter is not a positive number.
400 - Bad Request	Page required to be a valid positive number	INVALID_REQUEST	The 'page' query parameter is not a positive number.
400 - Bad Request	Cannot get upcoming sweep points for this account.	INVALID_REQUEST	Account is CLOSED or DECEASED

Request

Responses

200

200 - Get Upcoming Point Sweep

Response Headers

Date
Example: Tue, 08 Nov 2022 15:25:11 GMT
Content-Length
Example: 303
Connection
Example: keep-alive
x-amzn-RequestId
Example: c01fa2ae-0bf2-4a04-a7c5-db193684f24b
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-6b03e181-580b-4ed1-8648-a431908345b6
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: November 8th 2022, 3:25:11
x-amz-apigw-id
Example: bScxsHoMoAMFgWw=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-636a74d7-6b148315696911c96b1724a7;Sampled=0

400

400 - FIFO Not Enabled

Response Headers

Date
Example: Tue, 08 Nov 2022 15:57:26 GMT
Content-Length
Example: 93
Connection
Example: keep-alive
x-amzn-RequestId
Example: 49d768e7-15a5-44ab-8e80-66d4d0eac8e0
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-ebea3447-c3b9-4e06-8041-dbb1c2ccd9e3
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: November 8th 2022, 3:57:26
x-amz-apigw-id
Example: bShgBGe9IAMFg-A=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-636a7c66-484a27b8764e197d2c9f7831;Sampled=0