NAV Navbar
PHP HTTP Shell JavaScript

REST API v3.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

REST API version 3.0 is currently in Beta and is NOT stable. Please use version 2.0^ for production ready applications.

Base URLs:

Email: Support License: Apache 2.0

Authentication

Scope Scope Description
user.read Read your profile information
user.write Update user's profile info
user.instrument.read View user's saved instruments
user.instrument.write Manage user's saved instruments
user.payment.read View user's stored payment card information
user.order.read View user’s completed order information
user.savings_account View user's savings account statistics, cashback balance
user.retailers Manage user's retailer preferences
programme.read View programme information
programme.modules View programme's enabled modules
programme.statistics View programme's dashboard data, milestones, timeline of events
checkout.basket.read View active basket information
checkout.basket.write Update basket by adding or removing items
checkout.payment Make payment on behalf of user
retailers.read View a list of retailers, products and offers supported through SmartSpending™
device.manage Manage registering/unregistering devices for notifications to be sent out
scim.readOnly Read member information on your programme. This will NOT allow the client to write any data.
scim.readWrite Read member information on your programme as well as be able to make changes to Eligibility Listen
user.app.review App review service
notification.read Read members notifications
notification.write Manage notifcations
notification.preferences.read Read members notification preferences
notification.preferences.write Manager members notification preferences
srw.feed.read List the Social Recognition Wall feed
srw.feed.write Add feed items the Social Recognition Wall feed
srw.feed.filter.read Filters on Social Recognition Wall
srw.feed.reaction.read List the Social Recognition Wall feed item reactions
srw.feed.reaction.write React on the Social Recognition Wall feed item
srw.feed.comment.read List the Social Recognition Wall feed item comments
srw.feed.comment.write Comment on the Social Recognition Wall feed item
srw.feed.comment.reply.read List the Social Recognition Wall feed item comment replies
srw.feed.comment.reply.write Reply on the Social Recognition Wall feed item comment
srw.feed.reaction.toolbar.read List the Social Recognition Wall toolbar reactions
srw.ecard.read List the Social Recognition Wall ecard categories within ecards
srw.user.activity.read List user SRW activity
srw.user.stats.read List user SRW statistics
user.hierarchy.read List user hierarchy
user.details.read List user details
user.search Search members
surveys.read Read surveys data
surveys.write Manage surveys data
programme.create Create a programme
programme.write Write to a programme
programme.admin Manage all programmes
trs.read Read TRS Statements for the user
recognition.external.read Get external recognition form structure.
recognition.external.write Store external recognition details.
rr.rules.admin Read and write R&R rules

Total Reward Statement

Endpoints to manage a members Total Reward Statements.

Get the total reward statement for current user

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/trs/getSections', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/trs/getSections HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Accept: application/vnd.rewardgateway+json;version=3.0
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/trs/getSections \
  -H 'Accept: application/json' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Accept':'application/vnd.rewardgateway+json;version=3.0',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/trs/getSections',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /trs/getSections

This endpoint will return the total reward statement for the user associated with the access token.

Parameters

Name In Type Required Description
Accept header string true Accept Header with Vendor Versioning
Authorization header string true Authorization Header with Bearer Token

Example responses

401 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
401 Unauthorized Unauthorized standardModel

trsAuth

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/trs/auth', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/trs/auth HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST https://api.rewardgateway.net/trs/auth \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "password": "password"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.rewardgateway.net/trs/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /trs/auth

Auth trs user

Body parameter

{
  "password": "password"
}

Parameters

Name In Type Required Description
body body Auth false none

Example responses

200 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation standardModel
400 Bad Request Data validation errors None
401 Unauthorized Unauthorized Access Exception None

Reward Gateway for Small Business

All internal endpoints related to Reward Gateway for Small Businesses

Handle subscription & billing webhook lifecycle events

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Basic cmJfYXV0aDpyYl8ha0pHVGRWZGE3UUVFRVM1QmdsRWJic01oMW9rZ2JlZXM=',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/billing/webhook', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/billing/webhook?v=v2&webhookKey=webhook_key HTTP/1.1
Host: api.rewardgateway.net

Authorization: Basic cmJfYXV0aDpyYl8ha0pHVGRWZGE3UUVFRVM1QmdsRWJic01oMW9rZ2JlZXM=

# You can also use wget
curl -X POST https://api.rewardgateway.net/billing/webhook?v=v2&webhookKey=webhook_key \
  -H 'Authorization: Basic cmJfYXV0aDpyYl8ha0pHVGRWZGE3UUVFRVM1QmdsRWJic01oMW9rZ2JlZXM='


const headers = {
  'Authorization':'Basic cmJfYXV0aDpyYl8ha0pHVGRWZGE3UUVFRVM1QmdsRWJic01oMW9rZ2JlZXM='
};

fetch('https://api.rewardgateway.net/billing/webhook?v=v2&webhookKey=webhook_key',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /billing/webhook

Application will handle 3rd lifecycle billing/subscription events

Parameters

Name In Type Required Description
Authorization header string true Basic cmJfYXV0aDpyYl8ha0pHVGRWZGE3UUVFRVM1QmdsRWJic01oMW9rZ2JlZXM= - above is an example. of basic field not exact for security reasons.
v query string true version of api requested
webhookKey query string true webhook key passed for extra security

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request BadRequest - request parameters invalid. None
401 Unauthorized Unauthorized - incorrect parameters passed for authoirisation. None
404 Not Found Invalid Authorisation and/or access request parameters None
500 Internal Server Error Internal server error. None

Collect client's onboarding feedback value

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/onboarding/{uuid}/feedback', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/onboarding/{uuid}/feedback HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/onboarding/{uuid}/feedback \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '{
  "feedbackValue": 5,
  "message": "feedback message"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/onboarding/{uuid}/feedback',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /onboarding/{uuid}/feedback

This endpoint collect client onboarding feedback value

Body parameter

{
  "feedbackValue": 5,
  "message": "feedback message"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
uuid path string true Onboarding member identifier
body body OnboardingFeedback false none

Example responses

200 Response

{
  "onboardingUuid": "327c1682-c7b7-11ec-9d64-0242ac120002",
  "feedbackValue": 5,
  "message": "feedback message"
}

Responses

Status Meaning Description Schema
200 OK Successful operation OnboardingFeedback
400 Bad Request Data validation errors standardModel

Returns list of documents for the programme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{schemeId}/comms', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{schemeId}/comms HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{schemeId}/comms \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/comms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{schemeId}/comms

This endpoint will return you a list of documents related to your programme. i.e. Posters, Flyers etc

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path string true scheme id or UUID
category query array[string] false filter documents list by category

Example responses

200 Response

[
  {
    "title": "Discounts Poster",
    "downloadPath": "https://site1.rewardgateway.dev/admin/comms/document/DiscountsPoster",
    "thumbnailPath": "https://static.rewardgateway.dev/BrandAssets/responsive/img/SelfService/admin/comms/discounts-poster.jpg",
    "type": "PDF",
    "buttonText": "Download",
    "category": "Launch"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [commsDocument] false none [Class CommsDocument]
» title string false none Document Title
» downloadPath string false none URL to PDF download path
» thumbnailPath string false none URL to thumbnail image
» type string false none Document Type
» buttonText string false none Text to appear as button label
» category string false none Document category

New Client onboarding record

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/onboarding/{uuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/onboarding/{uuid} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/onboarding/{uuid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '{
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "0437819232",
  "email": "john.doe@rewardgateway.com",
  "token": "foo-bar",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "numberOfEmployees": 50,
  "companyRegistrationNumber": "string",
  "streetAddress": "265 Tottenham Court Rd",
  "streetAddressLineTwo": "265 Tottenham Court Rd",
  "city": "London",
  "county": "Greater London",
  "postalCode": "W1T 7RQ",
  "schemeAlias": "companyname.rewardgateway.com",
  "termsAndConditions": "2020-07-14 12:45:00",
  "localeId": 1,
  "referralCode": "string",
  "freeTrial": true,
  "skipAllowed": true,
  "password": "string",
  "trackingCampaign": "string",
  "trackingSource": "string",
  "currentSeatCount": 0,
  "plan": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/onboarding/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /onboarding/{uuid}

This endpoint update information for a new RGSB account

Body parameter

{
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "0437819232",
  "email": "john.doe@rewardgateway.com",
  "token": "foo-bar",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "numberOfEmployees": 50,
  "companyRegistrationNumber": "string",
  "streetAddress": "265 Tottenham Court Rd",
  "streetAddressLineTwo": "265 Tottenham Court Rd",
  "city": "London",
  "county": "Greater London",
  "postalCode": "W1T 7RQ",
  "schemeAlias": "companyname.rewardgateway.com",
  "termsAndConditions": "2020-07-14 12:45:00",
  "localeId": 1,
  "referralCode": "string",
  "freeTrial": true,
  "skipAllowed": true,
  "password": "string",
  "trackingCampaign": "string",
  "trackingSource": "string",
  "currentSeatCount": 0,
  "plan": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
uuid path string true Onboarding member identifier
body body Onboarding false none

Example responses

200 Response

{
  "uuid": "string",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "0437819232",
  "email": "john.doe@rewardgateway.com",
  "token": "foo-bar",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "numberOfEmployees": 50,
  "companyRegistrationNumber": "string",
  "streetAddress": "265 Tottenham Court Rd",
  "streetAddressLineTwo": "265 Tottenham Court Rd",
  "city": "London",
  "county": "Greater London",
  "postalCode": "W1T 7RQ",
  "schemeAlias": "companyname.rewardgateway.com",
  "schemeId": 272,
  "schemeStatus": "Live",
  "termsAndConditions": "2020-07-14 12:45:00",
  "status": "New Prospect",
  "localeId": 1,
  "verificationSentTimes": 1,
  "kycStatus": "string",
  "kycResult": "string",
  "referralCode": "string",
  "couponId": "string",
  "created": "string",
  "freeTrial": true,
  "skipAllowed": true,
  "password": "string",
  "trackingCampaign": "string",
  "trackingSource": "string",
  "pricePerSeat": 0,
  "currentSeatCount": 0,
  "plan": "string",
  "firstBillingDate": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Onboarding
400 Bad Request Data validation errors standardModel

Get client onboarding record

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/onboarding/{uuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/onboarding/{uuid} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/onboarding/{uuid} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/onboarding/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /onboarding/{uuid}

This endpoint get information for RGSB account

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
uuid path string true Onboarding member identifier

Example responses

200 Response

{
  "uuid": "string",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "0437819232",
  "email": "john.doe@rewardgateway.com",
  "token": "foo-bar",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "numberOfEmployees": 50,
  "companyRegistrationNumber": "string",
  "streetAddress": "265 Tottenham Court Rd",
  "streetAddressLineTwo": "265 Tottenham Court Rd",
  "city": "London",
  "county": "Greater London",
  "postalCode": "W1T 7RQ",
  "schemeAlias": "companyname.rewardgateway.com",
  "schemeId": 272,
  "schemeStatus": "Live",
  "termsAndConditions": "2020-07-14 12:45:00",
  "status": "New Prospect",
  "localeId": 1,
  "verificationSentTimes": 1,
  "kycStatus": "string",
  "kycResult": "string",
  "referralCode": "string",
  "couponId": "string",
  "created": "string",
  "freeTrial": true,
  "skipAllowed": true,
  "password": "string",
  "trackingCampaign": "string",
  "trackingSource": "string",
  "pricePerSeat": 0,
  "currentSeatCount": 0,
  "plan": "string",
  "firstBillingDate": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Onboarding
400 Bad Request Data validation errors standardModel

Client Skip the onboarding flow

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/onboarding/{uuid}/skip', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/onboarding/{uuid}/skip HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/onboarding/{uuid}/skip \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/onboarding/{uuid}/skip',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /onboarding/{uuid}/skip

This endpoint create a new RGSB free trial account

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
uuid path string true Onboarding member identifier

Example responses

200 Response

{
  "uuid": "string",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "0437819232",
  "email": "john.doe@rewardgateway.com",
  "token": "foo-bar",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "numberOfEmployees": 50,
  "companyRegistrationNumber": "string",
  "streetAddress": "265 Tottenham Court Rd",
  "streetAddressLineTwo": "265 Tottenham Court Rd",
  "city": "London",
  "county": "Greater London",
  "postalCode": "W1T 7RQ",
  "schemeAlias": "companyname.rewardgateway.com",
  "schemeId": 272,
  "schemeStatus": "Live",
  "termsAndConditions": "2020-07-14 12:45:00",
  "status": "New Prospect",
  "localeId": 1,
  "verificationSentTimes": 1,
  "kycStatus": "string",
  "kycResult": "string",
  "referralCode": "string",
  "couponId": "string",
  "created": "string",
  "freeTrial": true,
  "skipAllowed": true,
  "password": "string",
  "trackingCampaign": "string",
  "trackingSource": "string",
  "pricePerSeat": 0,
  "currentSeatCount": 0,
  "plan": "string",
  "firstBillingDate": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Onboarding
400 Bad Request Data validation errors standardModel

Reactivate client's closed scheme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/onboarding/{uuid}/reactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/onboarding/{uuid}/reactivate HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/onboarding/{uuid}/reactivate \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/onboarding/{uuid}/reactivate',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /onboarding/{uuid}/reactivate

This endpoint reactivate a RGSB account

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
uuid path string true Onboarding member identifier

Example responses

200 Response

{
  "uuid": "string",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "0437819232",
  "email": "john.doe@rewardgateway.com",
  "token": "foo-bar",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "numberOfEmployees": 50,
  "companyRegistrationNumber": "string",
  "streetAddress": "265 Tottenham Court Rd",
  "streetAddressLineTwo": "265 Tottenham Court Rd",
  "city": "London",
  "county": "Greater London",
  "postalCode": "W1T 7RQ",
  "schemeAlias": "companyname.rewardgateway.com",
  "schemeId": 272,
  "schemeStatus": "Live",
  "termsAndConditions": "2020-07-14 12:45:00",
  "status": "New Prospect",
  "localeId": 1,
  "verificationSentTimes": 1,
  "kycStatus": "string",
  "kycResult": "string",
  "referralCode": "string",
  "couponId": "string",
  "created": "string",
  "freeTrial": true,
  "skipAllowed": true,
  "password": "string",
  "trackingCampaign": "string",
  "trackingSource": "string",
  "pricePerSeat": 0,
  "currentSeatCount": 0,
  "plan": "string",
  "firstBillingDate": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Onboarding
400 Bad Request Data validation errors standardModel

Send a request to account admins to unlock features

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/onboarding/{onboardingUuid}/unlock-request', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/onboarding/{onboardingUuid}/unlock-request HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json

# You can also use wget
curl -X POST https://api.rewardgateway.net/onboarding/{onboardingUuid}/unlock-request \
  -H 'Content-Type: application/json'

const inputBody = '{
  "product": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('https://api.rewardgateway.net/onboarding/{onboardingUuid}/unlock-request',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /onboarding/{onboardingUuid}/unlock-request

This endpoint emails current RGSB scheme admins with an unlock request

Body parameter

{
  "product": "string"
}

Parameters

Name In Type Required Description
onboardingUuid path string true Onboarding member identifier
body body object false none
» product body string false Limited product that member requesting for unlock

Responses

Status Meaning Description Schema
200 OK Successful operation None

Replaces programme logo image

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/scheme/{schemeId}/logo', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/scheme/{schemeId}/logo HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X POST https://api.rewardgateway.net/scheme/{schemeId}/logo \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/logo',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /scheme/{schemeId}/logo

Replaces scheme logo image using binary file in request body. Content-Type header must be correct mime-type or multipart/form-data

Body parameter

file: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path string true scheme id
body body object false none
» file body string(file) true new logo image to replace existing logo

Example responses

200 Response

{
  "imageUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Validation Errors standardModel
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
» imageUrl string false none none

Updates scheme colour settings

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/scheme/{schemeId}/colour', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/scheme/{schemeId}/colour HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/scheme/{schemeId}/colour \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/colour',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /scheme/{schemeId}/colour

This endpoint allows you to update programme colors associated with your programme. These are * the themese colors used with the site.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path string true scheme id

Example responses

200 Response

{
  "navigationBackground": "003865",
  "buttonBackground": "003865"
}

Responses

Status Meaning Description Schema
200 OK Successful operation schemeColour
400 Bad Request Validation Errors standardModel
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Creates a programme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/scheme', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/scheme HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X POST https://api.rewardgateway.net/scheme \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '{
  "name": "Reward Hub",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "accountId": "0061j000007EKwDAAW",
  "subAccountId": "0061j000007EKwDAAW",
  "parentAccountId": "0061j000007EKwDAAW",
  "opportunityId": "0061j000007EKwDAAW",
  "emailDomain": "string",
  "schemeType": "rarebreed",
  "localeId": 1,
  "postalCode": "W1T 7RQ",
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "string",
  "addressLine3": "London",
  "addressLine4": "string",
  "companyRegistrationNumber": "string",
  "accountManagerEmail": "account.manager@rewardgateway.com",
  "implementationManagerEmail": "implementation.manager@rewardgateway.com",
  "status": 0,
  "type": 0,
  "user": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@rewardgateway.com",
    "id": "43a0cbfb-f17b-4b8e-9d22-a93b077e8c4d",
    "phoneNumber": "0437819232",
    "verificationCode": 123456
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /scheme

This endpoint will allow you to create a brand new programme for use.

Body parameter

{
  "name": "Reward Hub",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "accountId": "0061j000007EKwDAAW",
  "subAccountId": "0061j000007EKwDAAW",
  "parentAccountId": "0061j000007EKwDAAW",
  "opportunityId": "0061j000007EKwDAAW",
  "emailDomain": "string",
  "schemeType": "rarebreed",
  "localeId": 1,
  "postalCode": "W1T 7RQ",
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "string",
  "addressLine3": "London",
  "addressLine4": "string",
  "companyRegistrationNumber": "string",
  "accountManagerEmail": "account.manager@rewardgateway.com",
  "implementationManagerEmail": "implementation.manager@rewardgateway.com",
  "status": 0,
  "type": 0,
  "user": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@rewardgateway.com",
    "id": "43a0cbfb-f17b-4b8e-9d22-a93b077e8c4d",
    "phoneNumber": "0437819232",
    "verificationCode": 123456
  }
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
body body self_service_scheme false none

Example responses

200 Response

{
  "id": "string",
  "uuid": "string",
  "name": "Reward Hub",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "accountId": "0061j000007EKwDAAW",
  "subAccountId": "0061j000007EKwDAAW",
  "parentAccountId": "0061j000007EKwDAAW",
  "opportunityId": "0061j000007EKwDAAW",
  "emailDomain": "string",
  "schemeType": "rarebreed",
  "localeId": 1,
  "postalCode": "W1T 7RQ",
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "string",
  "addressLine3": "London",
  "addressLine4": "string",
  "companyRegistrationNumber": "string",
  "accountManagerEmail": "account.manager@rewardgateway.com",
  "implementationManagerEmail": "implementation.manager@rewardgateway.com",
  "status": 0,
  "type": 0,
  "user": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@rewardgateway.com",
    "id": "43a0cbfb-f17b-4b8e-9d22-a93b077e8c4d",
    "phoneNumber": "0437819232",
    "verificationCode": 123456
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation self_service_scheme
403 Forbidden Access to the resource has been denied standardModel

Updates programme details

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/scheme/{schemeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/scheme/{schemeId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/scheme/{schemeId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '{
  "name": "Reward Hub",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "accountId": "0061j000007EKwDAAW",
  "subAccountId": "0061j000007EKwDAAW",
  "parentAccountId": "0061j000007EKwDAAW",
  "opportunityId": "0061j000007EKwDAAW",
  "emailDomain": "string",
  "schemeType": "rarebreed",
  "localeId": 1,
  "postalCode": "W1T 7RQ",
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "string",
  "addressLine3": "London",
  "addressLine4": "string",
  "companyRegistrationNumber": "string",
  "accountManagerEmail": "account.manager@rewardgateway.com",
  "implementationManagerEmail": "implementation.manager@rewardgateway.com",
  "status": 0,
  "type": 0,
  "user": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@rewardgateway.com",
    "id": "43a0cbfb-f17b-4b8e-9d22-a93b077e8c4d",
    "phoneNumber": "0437819232",
    "verificationCode": 123456
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /scheme/{schemeId}

This endpoint allows you to update all details related to a programme.

Body parameter

{
  "name": "Reward Hub",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "accountId": "0061j000007EKwDAAW",
  "subAccountId": "0061j000007EKwDAAW",
  "parentAccountId": "0061j000007EKwDAAW",
  "opportunityId": "0061j000007EKwDAAW",
  "emailDomain": "string",
  "schemeType": "rarebreed",
  "localeId": 1,
  "postalCode": "W1T 7RQ",
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "string",
  "addressLine3": "London",
  "addressLine4": "string",
  "companyRegistrationNumber": "string",
  "accountManagerEmail": "account.manager@rewardgateway.com",
  "implementationManagerEmail": "implementation.manager@rewardgateway.com",
  "status": 0,
  "type": 0,
  "user": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@rewardgateway.com",
    "id": "43a0cbfb-f17b-4b8e-9d22-a93b077e8c4d",
    "phoneNumber": "0437819232",
    "verificationCode": 123456
  }
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path string true scheme id or UUID
body body self_service_scheme false none

Example responses

200 Response

{
  "id": "string",
  "uuid": "string",
  "name": "Reward Hub",
  "companyName": "My Company",
  "companyLegalName": "My Company Ltd.",
  "accountId": "0061j000007EKwDAAW",
  "subAccountId": "0061j000007EKwDAAW",
  "parentAccountId": "0061j000007EKwDAAW",
  "opportunityId": "0061j000007EKwDAAW",
  "emailDomain": "string",
  "schemeType": "rarebreed",
  "localeId": 1,
  "postalCode": "W1T 7RQ",
  "addressLine1": "265 Tottenham Court Rd",
  "addressLine2": "string",
  "addressLine3": "London",
  "addressLine4": "string",
  "companyRegistrationNumber": "string",
  "accountManagerEmail": "account.manager@rewardgateway.com",
  "implementationManagerEmail": "implementation.manager@rewardgateway.com",
  "status": 0,
  "type": 0,
  "user": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@rewardgateway.com",
    "id": "43a0cbfb-f17b-4b8e-9d22-a93b077e8c4d",
    "phoneNumber": "0437819232",
    "verificationCode": 123456
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation self_service_scheme
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Re-send members invitations

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/scheme/{schemeId}/invitations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/scheme/{schemeId}/invitations HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/scheme/{schemeId}/invitations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '[
  {
    "memberId": "327c1682-c7b7-11ec-9d64-0242ac120002",
    "resend": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/invitations',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /scheme/{schemeId}/invitations

This endpoint allows you to re-sends invitation emails to all currently invited members of the * RG for Small Business scheme.

Body parameter

[
  {
    "memberId": "327c1682-c7b7-11ec-9d64-0242ac120002",
    "resend": true
  }
]

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path string true scheme id or UUID
body body self_service_invitations true none

Example responses

400 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Validation Errors standardModel
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Retrieve the locales for a scheme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{schemeId}/locales', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{schemeId}/locales HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{schemeId}/locales \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/locales',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{schemeId}/locales

Endpoint returns all the locales that are supported for a given scheme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path integer true scheme id

Example responses

200 Response

[
  {
    "id": 1,
    "name": "GB",
    "lang": "en_GB",
    "currency": "GBP",
    "symbol": "£",
    "states": [
      {
        "code": "string",
        "name": "string"
      }
    ],
    "contactFields": {
      "firstName": "First Name",
      "lastName": "Surname",
      "emailAddress": "Email Address",
      "mobilePhoneNumber": "Mobile Phone Number",
      "addressLine1": "Address Line 1",
      "addressLine2": "Address Line 2",
      "addressLine3": "Address Line 3",
      "addressLine4": "Address Line 4",
      "postCode": "Postcode"
    },
    "mappings": {
      "locale": "Locale CDN url",
      "fallback": "Fallback locale CDN url"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [GenericLocale] false none none
» id integer(int32) true none Locale identifier
» name string true none Locale name
» lang string true none Locale language
» currency string true none Locale currency
» symbol string true none Locale currency symbol
» states [GenericState] true none Locale state list
»» code string true none none
»» name string true none none
» contactFields object true none none
»» firstName any false none List of translated contact fields
»» lastName any false none none
»» emailAddress any false none none
»» mobilePhoneNumber any false none none
»» addressLine1 any false none none
»» addressLine2 any false none none
»» addressLine3 any false none none
»» addressLine4 any false none none
»» postCode any false none none
» mappings object false none none
»» locale string false none Mappings to download jsons for React apps
»» fallback string false none none

Retrieve discrimantory fields.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{schemeUuid}/discriminatory-fields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{schemeUuid}/discriminatory-fields HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{schemeUuid}/discriminatory-fields \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeUuid}/discriminatory-fields',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{schemeUuid}/discriminatory-fields

Endpoint returns all the discriminatory fields that are supported for the user's programme.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeUuid path string true scheme uuid

Example responses

200 Response

[
  {
    "id": "string",
    "rawId": 0,
    "field": "string",
    "values": [
      {
        "id": 1,
        "name": "Foo"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [GenericProfileField] false none [Discrimantory field for a programme.]
» id string true none id of the current field.
» rawId integer true none raw id of the current field.
» field string true none current field name.
» values [object] false none Possible field values.
»» id integer true none Id of the possible answer
»» name string true none Discriminatory field answer

Returns the programme domain

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/{schemeId}/alias', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/{schemeId}/alias HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/{schemeId}/alias \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/alias',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/{schemeId}/alias

This endpoint will return the domains attached to the programme identifier that is passed.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path integer true none

Example responses

200 Response

{
  "id": "string",
  "hostname": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation self_service_alias
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme or alias is not found standardModel

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/scheme/{schemeId}/alias', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/scheme/{schemeId}/alias HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/scheme/{schemeId}/alias \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'

const inputBody = '{
  "hostname": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/{schemeId}/alias',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /scheme/{schemeId}/alias

This endpoint will allow you to replace the current domain attached to a programme.

Body parameter

{
  "hostname": "string"
}
Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
schemeId path integer true scheme id
body body self_service_alias false none

Example responses

200 Response

{
  "id": "string",
  "hostname": "string"
}
Status Meaning Description Schema
200 OK Successful operation self_service_alias
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme is not found standardModel

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/scheme/alias', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/scheme/alias?hostname=Scheme%20hostname HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X GET https://api.rewardgateway.net/scheme/alias?hostname=Scheme%20hostname \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/scheme/alias?hostname=Scheme%20hostname',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /scheme/alias

This endpoint will return the preferred domain related if found.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
hostname query string true Scheme hostname

Example responses

200 Response

{
  "id": "string",
  "hostname": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation self_service_alias
403 Forbidden Access to the resource has been denied standardModel
404 Not Found Scheme alias not found standardModel

Change user password

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/user/{userId}/password', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/user/{userId}/password HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz

# You can also use wget
curl -X PUT https://api.rewardgateway.net/user/{userId}/password \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz'
};

fetch('https://api.rewardgateway.net/user/{userId}/password',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /user/{userId}/password

This endpoint will allow you to change a user's password. Currently only available for RGSB clients.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
userId path string true none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@acme.com",
  "emailVisible": true,
  "summary": "Ipsum dolor sit amet",
  "timezone": "UK, Western Europe (GMT +1:00)",
  "gender": "X",
  "addressLine1": "123 Some Road",
  "addressLine2": "Floor 4",
  "addressLine3": "London",
  "addressLine4": "London",
  "postalCode": "AA00 0AA",
  "country": "United Kingdom",
  "mobileNumber": "07700900077",
  "mobileNumberVisible": true,
  "telephoneNumber": "02700900077",
  "avatar": "https://www.acme.com/path/to/image.jpg",
  "dateOfBirth": "2019-08-24T14:15:22Z",
  "dateOfBirthVisible": true,
  "registrationDate": "2019-08-24T14:15:22Z",
  "registrationInfo": "Lorem ipsum dolor sit amet",
  "pushNotifications": true,
  "registrationQuestionsAnswers": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation MyUser
401 Unauthorized Access token expired standardModel
403 Forbidden Access to the resource has been denied standardModel

Comms Content

All things avaiable around blogs, posts and pages.

Get a list of blogs based on identifiers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/content/blogs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/content/blogs HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/content/blogs \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/content/blogs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/content/blogs

This endpoint returns a list of Blogs based on identifiers

Parameters

Name In Type Required Description
id query array[any] false Object identificators
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": 198,
      "author": "Joey Tribbiani",
      "dateAdded": "2020-10-15 14:29:07",
      "lastSaved": "2020-10-15 14:29:07",
      "title": "Joye's Pizza",
      "url": "/SmartPage/my-cool-page-198"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation commsContent
403 Forbidden Access to the resource has been denied errorModel

Get a list of posts based on identifiers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/content/posts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/content/posts HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/content/posts \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/content/posts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/content/posts

This endpoint returns a list of blog posts based on identifiers

Parameters

Name In Type Required Description
id query array[any] false Object identificators
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": 198,
      "author": "Joey Tribbiani",
      "dateAdded": "2020-10-15 14:29:07",
      "lastSaved": "2020-10-15 14:29:07",
      "title": "Joye's Pizza",
      "url": "/SmartPage/my-cool-page-198"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation commsContent
403 Forbidden Access to the resource has been denied errorModel

Get a list of pages based on identifiers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/content/pages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/content/pages HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/content/pages \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/content/pages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/content/pages

This endpoint returns a list of Smart Page based on identifiers

Parameters

Name In Type Required Description
id query array[any] false Object identificators
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": 198,
      "author": "Joey Tribbiani",
      "dateAdded": "2020-10-15 14:29:07",
      "lastSaved": "2020-10-15 14:29:07",
      "title": "Joye's Pizza",
      "url": "/SmartPage/my-cool-page-198"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation commsContent
403 Forbidden Access to the resource has been denied errorModel

Get a list of tiles based on identifiers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/content/tiles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/content/tiles HTTP/1.1
Host: api.rewardgateway.net

Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/content/tiles \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/content/tiles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/content/tiles

This endpoint returns a list of SmartTiles based on identifiers

Parameters

Name In Type Required Description
id query array[any] false Object identificators
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied None

Comms Blog Post

All things avaiable around blog posts.

Fetch post details.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/blog/post/{postId}/details', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/blog/post/{postId}/details HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/blog/post/{postId}/details \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/{postId}/details',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/blog/post/{postId}/details

Fetch post details.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
postId path integer true Post origin Id

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "role": {
        "value": "Admin",
        "key": "admin"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK If post is found. commsPostDetails
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Fetch alerts statuses for post.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/blog/post/{postId}/alerts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/blog/post/{postId}/alerts HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/blog/post/{postId}/alerts \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/{postId}/alerts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/blog/post/{postId}/alerts

Fetch alerts status for post.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
postId path integer true Post origin Id

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "icon": "checked",
      "text": "Alerts sent",
      "items": {
        "icon": "checked",
        "timeText": "1 min ago",
        "text": "0 mention alerts sent"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK If post if found and user have access. commsPostAlerts
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Fetch post segments explanation

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/blog/post/{postId}/segment/explanation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/blog/post/{postId}/segment/explanation HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/blog/post/{postId}/segment/explanation \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/{postId}/segment/explanation',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/blog/post/{postId}/segment/explanation

Fetch post segments explanation

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
postId path integer true Post Id

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "role": {
        "value": "Admin",
        "key": "admin"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Segments ordering explanation if is found. commsPostDetails
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Fetch versions for post

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/comms/blog/post/{postId}/version', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/comms/blog/post/{postId}/version HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/comms/blog/post/{postId}/version \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/{postId}/version',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /comms/blog/post/{postId}/version

Fetch versions for post

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
postId path integer true Post Id

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Segments ordering explanation if is found. commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Blogs

Blogging product endpoints

Fetch all available blogs.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/blogs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/blogs HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/blogs \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/blogs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /blogs

Fetch all scheme blogs

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 123,
    "title": "Awesome Blog",
    "subtitle": "Subtitle for blog",
    "isActive": true,
    "isDeleted": false,
    "isAnnouncement": false,
    "defaultRoleId": 10,
    "defaultRoleText": "Contributor",
    "url": [
      {
        "full": "https://schemename.rg.com/blogpost/slug",
        "relative": "/blogpost/slug"
      }
    ],
    "updated": [
      {
        "dateFormatted": "6 Jul 2022, 08:26:27",
        "dateUtc": "2022-07-06 07:26:27",
        "memberId": "123",
        "memberName": "Example User"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Array of blogs Inline
401 Unauthorized Product is not enabled or member dont have access to it. errorModel
500 Internal Server Error Internal Server error errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [blogModel] false none [Default blog model response.]
» id integer false none Blog indetifier
» title string false none Title of blog
» subtitle string false none Subtitle of blog
» isActive boolean false none Wheather blog is active or not
» isDeleted boolean false none Wheather blog is deleted or not
» isAnnouncement boolean false none If all published blogposts are announcements
» defaultRoleId integer false none Default blog role id for all members which dont have assigned one
» defaultRoleText string false none Default blog role name for all members which dont have assigned one
» url [bloggingUrl] false none [Default url response.]
»» full string false none Full url to recourse
»» relative string false none Path url to resource
» updated [bloggingUpdated] false none [Default updated response.]
»» dateFormatted string false none Scheme locale formatted date
»» dateUtc string false none Datetime utc tz
»» memberId string false none Member id of last blog settings update.
»» memberName string false none Member full name of last blog settings update.

Create a new blog

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/blogs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/blogs HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/blogs \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/blogs',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /blogs

Create a new blog

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "id": 123,
  "title": "Awesome Blog",
  "subtitle": "Subtitle for blog",
  "isActive": true,
  "isDeleted": false,
  "isAnnouncement": false,
  "defaultRoleId": 10,
  "defaultRoleText": "Contributor",
  "url": [
    {
      "full": "https://schemename.rg.com/blogpost/slug",
      "relative": "/blogpost/slug"
    }
  ],
  "updated": [
    {
      "dateFormatted": "6 Jul 2022, 08:26:27",
      "dateUtc": "2022-07-06 07:26:27",
      "memberId": "123",
      "memberName": "Example User"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Array of blog settings blogModel
401 Unauthorized Blogs are not active for that scheme or member. errorModel
500 Internal Server Error Internal Server error errorModel

Fetch blog settings

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/blogs/{blogId}/settings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/blogs/{blogId}/settings HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/blogs/{blogId}/settings \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/blogs/{blogId}/settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /blogs/{blogId}/settings

Fetch blog settings

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
blogId path integer true Id of blog record.

Example responses

200 Response

{
  "id": 123,
  "title": "Awesome Blog",
  "subtitle": "Subtitle for blog",
  "isActive": true,
  "isDeleted": false,
  "isAnnouncement": false,
  "defaultRoleId": 10,
  "defaultRoleText": "Contributor",
  "url": [
    {
      "full": "https://schemename.rg.com/blogpost/slug",
      "relative": "/blogpost/slug"
    }
  ],
  "updated": [
    {
      "dateFormatted": "6 Jul 2022, 08:26:27",
      "dateUtc": "2022-07-06 07:26:27",
      "memberId": "123",
      "memberName": "Example User"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Array of blog settings blogModel
401 Unauthorized Blogs are not active for that scheme or member. errorModel
500 Internal Server Error Internal Server error errorModel

Update blog settings

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/blogs/{blogId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/blogs/{blogId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/blogs/{blogId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "title": "Awesome Blog",
  "subtitle": "Subtitle for blog",
  "active": true,
  "delete": false,
  "announce": false,
  "publicBlog": 30,
  "lastUpdaterContactId": 1,
  "url": "new_title_3_1657007132"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/blogs/{blogId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /blogs/{blogId}

Update blog settings

Body parameter

{
  "title": "Awesome Blog",
  "subtitle": "Subtitle for blog",
  "active": true,
  "delete": false,
  "announce": false,
  "publicBlog": 30,
  "lastUpdaterContactId": 1,
  "url": "new_title_3_1657007132"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
blogId path integer true Id of blog record.
body body blogSettings false none

Example responses

200 Response

{
  "id": 123,
  "title": "Awesome Blog",
  "subtitle": "Subtitle for blog",
  "isActive": true,
  "isDeleted": false,
  "isAnnouncement": false,
  "defaultRoleId": 10,
  "defaultRoleText": "Contributor",
  "url": [
    {
      "full": "https://schemename.rg.com/blogpost/slug",
      "relative": "/blogpost/slug"
    }
  ],
  "updated": [
    {
      "dateFormatted": "6 Jul 2022, 08:26:27",
      "dateUtc": "2022-07-06 07:26:27",
      "memberId": "123",
      "memberName": "Example User"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Array of blog settings blogModel
400 Bad Request Payload is empty errorModel
401 Unauthorized Blogs are not active for that scheme or member. errorModel
500 Internal Server Error Internal Server error errorModel

Fetch stats about blogs

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/blogs/{blogIds}/stats', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/blogs/{blogIds}/stats HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/blogs/{blogIds}/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/blogs/{blogIds}/stats',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /blogs/{blogIds}/stats

Fetch stats about blogs

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
blogIds path string true Comma separeted blog ids

Example responses

200 Response

{
  "blogStats": [
    {
      "blogId": 321,
      "posts": 1333,
      "views": 12,
      "visitors": 321
    }
  ],
  "engagement": {
    "visitors": {
      "count": 321,
      "change": 3333
    },
    "views": {
      "count": 321,
      "change": 3333
    },
    "reactions": {
      "count": 321,
      "change": 3333
    },
    "comments": {
      "count": 321,
      "change": 3333
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Stats engagementStats
401 Unauthorized Product is not enabled or member dont have access to it. errorModel
500 Internal Server Error Internal Server error errorModel

Create a new blog post.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/blogs/{blogId}/posts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/blogs/{blogId}/posts HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/blogs/{blogId}/posts \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/blogs/{blogId}/posts',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /blogs/{blogId}/posts

Create a new post from blog with {blogId}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
blogId path integer true Id of blog record.

Example responses

200 Response

{
  "id": 123,
  "blogId": 4,
  "bloggerId": 12,
  "createdFrom": 1,
  "postType": 0,
  "hookStatus": 1,
  "url": [
    {
      "full": "https://schemename.rg.com/blogpost/slug",
      "relative": "/blogpost/slug"
    }
  ],
  "updated": [
    {
      "dateFormatted": "6 Jul 2022, 08:26:27",
      "dateUtc": "2022-07-06 07:26:27",
      "memberId": "123",
      "memberName": "Example User"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Json array containing newly created post. postModel
401 Unauthorized Client is not a registered member. errorModel
403 Forbidden Client does not have permission to create post in this blog. errorModel
404 Not Found Resource was not found. errorModel
500 Internal Server Error Internal Server error errorModel

Post Segments

Segmentation end-points for post.

Create new version for that post.

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/comms/blog/post/{postId}/version', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/comms/blog/post/{postId}/version HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/comms/blog/post/{postId}/version \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/{postId}/version',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /comms/blog/post/{postId}/version

Create new version for that post.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
postId path integer true Post origin Id

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK If new version is created. commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Delete post version

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/comms/blog/post/version/{versionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/comms/blog/post/version/{versionId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/comms/blog/post/version/{versionId} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/version/{versionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /comms/blog/post/version/{versionId}

Delete post version.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
versionId path integer true Version id

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Deleted version as response. commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Duplicate specific version

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/comms/blog/post/version/{versionId}/duplicate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/comms/blog/post/version/{versionId}/duplicate HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/comms/blog/post/version/{versionId}/duplicate \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/version/{versionId}/duplicate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /comms/blog/post/version/{versionId}/duplicate

Duplicate post version.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
versionId path integer true Version id

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK All versions commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Update name of version

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/comms/blog/post/version/{versionId}/name', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/comms/blog/post/version/{versionId}/name HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/comms/blog/post/version/{versionId}/name \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "Property": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/version/{versionId}/name',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /comms/blog/post/version/{versionId}/name

Update name of version

Body parameter

Property: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
versionId path integer true Version id
body body object false none
» Property body string true Json body contains new VersionName

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Full version if name was successfully updated. commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Update segment for version

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/comms/blog/post/version/{versionId}/segment', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/comms/blog/post/version/{versionId}/segment HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/comms/blog/post/version/{versionId}/segment \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "SegmentId": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/version/{versionId}/segment',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /comms/blog/post/version/{versionId}/segment

Update segment for version

Body parameter

SegmentId: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
versionId path integer true Version id
body body object false none
» SegmentId body integer true Json body contains new VersionName

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Version information with new segment. commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Update order of versions

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/comms/blog/post/version/{versionId}/order', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/comms/blog/post/version/{versionId}/order HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/comms/blog/post/version/{versionId}/order \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "position": 0,
  "current": 0
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/comms/blog/post/version/{versionId}/order',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /comms/blog/post/version/{versionId}/order

Update order of versions

Body parameter

position: 0
current: 0

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
versionId path integer true Version id
body body object false none
» position body integer true New possition (starting from 1)
» current body integer true Current possition (starting from 1)

Example responses

200 Response

{
  "data": [
    {
      "name": "All Users",
      "sort": 3,
      "segment": {
        "id": 2,
        "name": "Do Not Show",
        "query": "Licence ID is"
      },
      "version": {
        "id": 123,
        "title": "New Title",
        "content": "New blog post...",
        "reading_time": "reading_time",
        "is_draft": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK All versions for that post with right order. commsPostVersionResponse
400 Bad Request If some of parameters are not valid. errorModel
401 Unauthorized If current token doesnt have access to that resource. errorModel
404 Not Found Resource was not found. errorModel

Profile Badges

All endpoints for profile's badges

Get list with badges for a member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/profile-badges/{member}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/profile-badges/{member} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/profile-badges/{member} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/profile-badges/{member}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /profile-badges/{member}

Get list with badges for a member profile, filtered by date range

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
member path string true Member UUID
fromDate query string false Start date for listing in YYYY-MM-DD format
toDate query string false End date for listing YYYY-MM-DD format
limit query integer false Maximum number of fetched earnings

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "dateEarned": "2019-08-24T14:15:22Z",
      "badge": {
        "name": "string",
        "description": "string",
        "icon": "string"
      }
    }
  ],
  "total": 0
}

Responses

Status Meaning Description Schema
200 OK All details for member's earned badges. profileBadges
404 Not Found Resource was not found. errorModel

Recognition & Reward

All endpoints related to our Recognition & Reward product. This will allow you to send out recognition to other users as well as see what recognition moments each users has received etc.

Get a member's alternate approvers configuration

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/config', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/config HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/config \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/config',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/member/{memberUuid}/alternateApprovers/config

This endpoint will return information about a member's alternate approvers configuration

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Get a member's alternate approvers list

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/member/{memberUuid}/alternateApprovers

This endpoint will return information about a member's alternate approvers

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Create alternate approver for a member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "approverContactIds": [
    0
  ],
  "startDate": "string",
  "endDate": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recognition/member/{memberUuid}/alternateApprovers

This endpoint will create an alternate approver item for a member

Body parameter

{
  "approverContactIds": [
    0
  ],
  "startDate": "string",
  "endDate": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier
body body object false none
» approverContactIds body [integer] false none
» startDate body string false none
» endDate body string false none

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Update alternate approver for a member

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "approverContactIds": [
    0
  ],
  "startDate": "string",
  "endDate": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId}

This endpoint will update an alternate approver item for a member

Body parameter

{
  "approverContactIds": [
    0
  ],
  "startDate": "string",
  "endDate": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier
alternateApproverItemId path integer true Alternate approver item identifer
body body object false none
» approverContactIds body [integer] false none
» startDate body string false none
» endDate body string false none

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Delete a member's alternate approvers

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /recognition/member/{memberUuid}/alternateApprovers/{alternateApproverItemId}

This endpoint will delete a member's alternate approvers

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier
alternateApproverItemId path integer true Alternate approver item identifer

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Get a member's recognition award

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/member/{memberUuid}/award/{nomineeUuid}

This endpoint will return information about a member's award

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier
nomineeUuid path string true Nominee identifier

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Claim a member's recognition award

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid}/claim', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid}/claim HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid}/claim \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/{memberUuid}/award/{nomineeUuid}/claim',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/member/{memberUuid}/award/{nomineeUuid}/claim

This endpoint will claim a member's award

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
memberUuid path string true Member identifier
nomineeUuid path string true Nominee identifier

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Get the current member's recognition

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/member/awards', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/member/awards?identifier=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/member/awards?identifier=string \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/member/awards?identifier=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/member/awards

This endpoint will return a list of all monetary recognition the current member has received. These maybe claimed by the member or unclaimed in some cases.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
identifier query string true Member identifier
offset query string false Pagination offset
limit query string false Pagination limit

Example responses

403 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied standardModel

Give me all types of recognition the authenticated user can send

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/categories', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/categories HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/categories \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/categories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/categories

This endpoint will return information about rrSchemes that can be used by member

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "results": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [any] false none The array of rrScheme objects

Get additional information about an R&R programme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/categories/info', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/categories/info?program_id=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/categories/info?program_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/categories/info?program_id=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/categories/info

Get additional information about an R&R programme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
program_id query string true R&R Scheme ID

Example responses

200 Response

{
  "id": 124,
  "name": "My Award Programme",
  "productName": "Award",
  "type": "InstantAwards",
  "html": "A description with extra information",
  "status": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation rrSchemeInfo
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Show who can receive specified recognition

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/categories/recipients', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/categories/recipients HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data

Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/categories/recipients \
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "recipients": "string",
  "rrSchemeId": "string",
  "potId": "string",
  "rrType": "string",
  "awardId": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/categories/recipients',
{
  method: 'GET',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/categories/recipients

Returns a list of eligible and ineligible members to receive recognition

Body parameter

recipients: string
rrSchemeId: string
potId: string
rrType: string
awardId: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» recipients body string true List of recipients uuid seperated by comma
» rrSchemeId body string true rr scheme id
» potId body string false Pot from which the award value is deducted. Required if using pots. Ignored when Rules Replacing Pots is enabled.
» rrType body string true rr recognition Type
» awardId body string false awardId

Responses

Status Meaning Description Schema
200 OK Successful operation None

Send a non-monetary recognition moment

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/ecard', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/ecard HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/ecard \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "cardId": 0,
  "categoryId": 0,
  "message": "string",
  "recipients": "string",
  "form": "string",
  "notListedRecipients[][emailAddress]": "string",
  "notListedRecipients[][firstName]": "string",
  "notListedRecipients[][lastName]": "string",
  "shared": 0,
  "assetType": "string",
  "assetId": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/ecard',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /ecard

This endpoint will send a non-monetary recognition moment (eCard) on behalf of the current user. * Either the recipient property or nonListedRecipient property need to be input when calling this endpoint.

Body parameter

cardId: 0
categoryId: 0
message: string
recipients: string
form: string
"notListedRecipients[][emailAddress]": string
"notListedRecipients[][firstName]": string
"notListedRecipients[][lastName]": string
shared: 0
assetType: string
assetId: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» cardId body integer true eCard identifier
» categoryId body integer true Category identifier
» message body string true Ecard message
» recipients body string true List of recipients
» form body string true Request is send from [android, ios, web]
» notListedRecipients[][emailAddress] body string false Non registered recipient email address
» notListedRecipients[][firstName] body string false Non registed recipient first name
» notListedRecipients[][lastName] body string false Non registed recipient last name
» shared body integer false eCard is shared
» assetType body string false List of recipients
» assetId body string false List of recipients

Example responses

200 Response

{
  "id": 1234,
  "name": "Acme Rewards",
  "companyName": "Acme Ltd",
  "url": "https://acme.rewardgateway.com",
  "hasUsernameEndpoint": true,
  "branding": {}
}

Responses

Status Meaning Description Schema
200 OK Successful operation scheme
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Scheme is not found errorModel

Get Dreamship shop

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /admin/recognition/redemption/dreamship/shop

Retrieves the Dreamship shop for a scheme

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 1,
    "schemeId": 1,
    "shopName": "Bank of America"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionDreamshipShop] false none none
» id integer true none Id of the shop in the database
» schemeId integer false none The scheme Id
» shopName string true none Name given to the shop

Create Dreamship shop

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "shopName": "string",
  "shopKey": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/admin/recognition/redemption/dreamship/shop',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /admin/recognition/redemption/dreamship/shop

Create a Dreamship shop for a scheme

Body parameter

shopName: string
shopKey: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» shopName body string true Shop name
» shopKey body string true Used to identify the store in the API. No capital letters, spaces or special characters except hyphens (-) and underscores (_)

Example responses

200 Response

[
  {
    "id": 1,
    "schemeId": 1,
    "shopName": "Bank of America"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionDreamshipShop] false none none
» id integer true none Id of the shop in the database
» schemeId integer false none The scheme Id
» shopName string true none Name given to the shop

Get a list of products for given locale

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/admin/recognition/redemption/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/admin/recognition/redemption/products?localeId=0 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/admin/recognition/redemption/products?localeId=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/admin/recognition/redemption/products?localeId=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /admin/recognition/redemption/products

This endpoint returns a list of products filtered by locale

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
localeId query integer true Id of the locale for which to return data for

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "getUsableOnline": true,
    "getUsableInstore": true,
    "description": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Invalid request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionAdminProduct] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» getUsableOnline boolean true none Get usable online
» getUsableInstore boolean true none Get usable in store
» description string true none Description

Get all items in the RR shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/basket', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/basket HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/basket \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.rewardgateway.net/recognition/redemption/basket',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/basket

Get all items in the RR shopping basket

Example responses

200 Response

{
  "code": null,
  "message": null,
  "details": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation standardModel
401 Unauthorized Unauthorized Access Exception errorModel
403 Forbidden Basket cannot be paid for. errorModel
404 Not Found Basket was not found. errorModel

Add product to basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recognition/redemption/basket', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recognition/redemption/basket HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recognition/redemption/basket \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/basket',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recognition/redemption/basket

This endpoint adds a product to R&R basket

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

403 Response

{
  "code": null,
  "message": null
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Get categories for scheme

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/physical/categories', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/physical/categories?type=string&departmentId=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/physical/categories?type=string&departmentId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/physical/categories?type=string&departmentId=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/physical/categories

This endpoint returns a list of R&R redemption categories for the selected physical store

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
type query string true Physical store type e.g. amazon
departmentId query string true The id of the department that we want to show the categories for

Example responses

200 Response

[
  {
    "searchIndex": "HomeAndKitchen",
    "name": "Home & Kitchen",
    "logo": "https://static.cdn.rewardgateway.net/BrandAssets/responsive/img/rr-redemption-assets/category-icon-homekitchen.svg",
    "activeInDepartment": true,
    "activeInSearch": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
401 Unauthorized Access token expired standardModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [physicalCategory] false none none
» searchIndex string true none The searchIndex name given to the category
» name string true none The name of the category
» logo string true none An image logo for the category
» activeInDepartment boolean false none ActiveInDepartment
» activeInSearch boolean false none ActiveInSearch

Creates a new rrredemptioncategories category

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recognition/redemption/categories', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recognition/redemption/categories HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recognition/redemption/categories \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "id": 0,
  "name": "string",
  "logo": "string",
  "description": "string",
  "configurationId": 0,
  "categoryType": "string",
  "deleted": true,
  "enabled": true,
  "hasCustomImage": true,
  "defaultLogo": "string",
  "productIds": [
    12
  ],
  "displayName": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recognition/redemption/categories

This endpoint creates a nmew rrredemptioncategory

Body parameter

{
  "id": 0,
  "name": "string",
  "logo": "string",
  "description": "string",
  "configurationId": 0,
  "categoryType": "string",
  "deleted": true,
  "enabled": true,
  "hasCustomImage": true,
  "defaultLogo": "string",
  "productIds": [
    12
  ],
  "displayName": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body redemptionCategory false none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "description": "string",
    "configurationId": 0,
    "categoryType": "string",
    "deleted": true,
    "enabled": true,
    "hasCustomImage": true,
    "defaultLogo": "string",
    "productIds": [
      12
    ],
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionCategory] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» description string true none Description
» configurationId integer¦null true none ConfigurationId
» categoryType string true none CategoryType
» deleted boolean true none Deleted
» enabled boolean true none Enabled
» hasCustomImage boolean false none HasCustomImage
» defaultLogo string¦null false none DefaultLogo
» productIds [integer]¦null false none ProductIds
» displayName string¦null false none DisplayName

Return one rrredemptioncategory by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/categories/{categoryId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/categories/{categoryId} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/categories/{categoryId}

This endpoint returns one rrredemptioncategory by id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId path string true The id of the category, e.g. 1

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "description": "string",
    "configurationId": 0,
    "categoryType": "string",
    "deleted": true,
    "enabled": true,
    "hasCustomImage": true,
    "defaultLogo": "string",
    "productIds": [
      12
    ],
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionCategory] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» description string true none Description
» configurationId integer¦null true none ConfigurationId
» categoryType string true none CategoryType
» deleted boolean true none Deleted
» enabled boolean true none Enabled
» hasCustomImage boolean false none HasCustomImage
» defaultLogo string¦null false none DefaultLogo
» productIds [integer]¦null false none ProductIds
» displayName string¦null false none DisplayName

Updates rrredemptioncategory

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}?categoryId=string HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}?categoryId=string \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "id": 0,
  "name": "string",
  "logo": "string",
  "description": "string",
  "configurationId": 0,
  "categoryType": "string",
  "deleted": true,
  "enabled": true,
  "hasCustomImage": true,
  "defaultLogo": "string",
  "productIds": [
    12
  ],
  "displayName": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}?categoryId=string',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /recognition/redemption/categories/{categoryId}

This endpoint updates one rrredemptioncategory by id

Body parameter

{
  "id": 0,
  "name": "string",
  "logo": "string",
  "description": "string",
  "configurationId": 0,
  "categoryType": "string",
  "deleted": true,
  "enabled": true,
  "hasCustomImage": true,
  "defaultLogo": "string",
  "productIds": [
    12
  ],
  "displayName": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId query string true The id of the category to update, e.g. 1
body body redemptionCategory true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "description": "string",
    "configurationId": 0,
    "categoryType": "string",
    "deleted": true,
    "enabled": true,
    "hasCustomImage": true,
    "defaultLogo": "string",
    "productIds": [
      12
    ],
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionCategory] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» description string true none Description
» configurationId integer¦null true none ConfigurationId
» categoryType string true none CategoryType
» deleted boolean true none Deleted
» enabled boolean true none Enabled
» hasCustomImage boolean false none HasCustomImage
» defaultLogo string¦null false none DefaultLogo
» productIds [integer]¦null false none ProductIds
» displayName string¦null false none DisplayName

Deletes rrredemptioncategory by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}?categoryId=string HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}?categoryId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}?categoryId=string',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /recognition/redemption/categories/{categoryId}

This endpoint deletes one rrredemptioncategory by id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId query string true The id of the category to delete, e.g. 1

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "description": "string",
    "configurationId": 0,
    "categoryType": "string",
    "deleted": true,
    "enabled": true,
    "hasCustomImage": true,
    "defaultLogo": "string",
    "productIds": [
      12
    ],
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionCategory] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» description string true none Description
» configurationId integer¦null true none ConfigurationId
» categoryType string true none CategoryType
» deleted boolean true none Deleted
» enabled boolean true none Enabled
» hasCustomImage boolean false none HasCustomImage
» defaultLogo string¦null false none DefaultLogo
» productIds [integer]¦null false none ProductIds
» displayName string¦null false none DisplayName

Enables rrredemptioncategory by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/enable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/enable HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/enable \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/enable',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/categories/{categoryId}/enable

This endpoint enables one rrredemptioncategory by id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId path string true The id of the category to enable, e.g. 1

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "description": "string",
    "configurationId": 0,
    "categoryType": "string",
    "deleted": true,
    "enabled": true,
    "hasCustomImage": true,
    "defaultLogo": "string",
    "productIds": [
      12
    ],
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionCategory] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» description string true none Description
» configurationId integer¦null true none ConfigurationId
» categoryType string true none CategoryType
» deleted boolean true none Deleted
» enabled boolean true none Enabled
» hasCustomImage boolean false none HasCustomImage
» defaultLogo string¦null false none DefaultLogo
» productIds [integer]¦null false none ProductIds
» displayName string¦null false none DisplayName

Disables rrredemptioncategory by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/disable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/disable HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/disable \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/disable',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/categories/{categoryId}/disable

This endpoint disables one rrredemptioncategory by id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId path string true The id of the category to disable, e.g. 1

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "logo": "string",
    "description": "string",
    "configurationId": 0,
    "categoryType": "string",
    "deleted": true,
    "enabled": true,
    "hasCustomImage": true,
    "defaultLogo": "string",
    "productIds": [
      12
    ],
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionCategory] false none none
» id integer true none Id
» name string true none Name
» logo string true none Logo
» description string true none Description
» configurationId integer¦null true none ConfigurationId
» categoryType string true none CategoryType
» deleted boolean true none Deleted
» enabled boolean true none Enabled
» hasCustomImage boolean false none HasCustomImage
» defaultLogo string¦null false none DefaultLogo
» productIds [integer]¦null false none ProductIds
» displayName string¦null false none DisplayName

Upload an Image

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/bulkschedule/uploadimage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/bulkschedule/uploadimage HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/bulkschedule/uploadimage \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "image": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/bulkschedule/uploadimage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /bulkschedule/uploadimage

Upload an Image for a Bulk Award

Body parameter

image: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object true none
» image body string false Image to uplad

Example responses

403 Response

{
  "code": null,
  "message": null
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
403 Forbidden Access to the resource has been denied errorModel

Retrieves the custom image override for a redemption category

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/categories/{categoryId}/customimage

This endpoint retrieves the custom image for a redemption category

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId path integer true The id of the category for which a custom image is being retrieved

Example responses

200 Response

{
  "id": 1,
  "categoryId": 3,
  "configurationId": 1,
  "logo": "https://ugc.rewardgateway.dev/img/RewardRecognition/Redemption/Categories/3-1.png",
  "originalImageName": "boom.png"
}

Responses

Status Meaning Description Schema
200 OK Successful operation redemptionCategoryCustomImage
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category custom image was not found errorModel

Creates a custom image override for the redemption category

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "imageName": "string",
  "imageExtension": "string",
  "originalImageName": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recognition/redemption/categories/{categoryId}/customimage

This endpoint override the redemption category image

Body parameter

{
  "imageName": "string",
  "imageExtension": "string",
  "originalImageName": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId path integer true The id of the category for which a custom image is being provided
body body object false none
» imageName body string true none
» imageExtension body string true none
» originalImageName body string false none

Example responses

200 Response

{
  "id": 1,
  "categoryId": 3,
  "configurationId": 1,
  "logo": "https://ugc.rewardgateway.dev/img/RewardRecognition/Redemption/Categories/3-1.png",
  "originalImageName": "boom.png"
}

Responses

Status Meaning Description Schema
200 OK Successful operation redemptionCategoryCustomImage
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Deletes a custom image override for the redemption category

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage?categoryId=5 HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage?categoryId=5 \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage?categoryId=5',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /recognition/redemption/categories/{categoryId}/customimage

This endpoint deletes a custom image override for the redemption category

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId query integer true The id of the category for which a custom image is being deleted

Example responses

200 Response

{
  "id": 1,
  "categoryId": 3,
  "configurationId": 1,
  "logo": "https://ugc.rewardgateway.dev/img/RewardRecognition/Redemption/Categories/3-1.png",
  "originalImageName": "boom.png"
}

Responses

Status Meaning Description Schema
200 OK Successful operation redemptionCategoryCustomImage
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category custom image was not found errorModel

Updates the custom image override for a redemption category

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage?categoryId=5 HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage?categoryId=5 \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "imageName": "string",
  "imageExtension": "string",
  "originalImageName": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/categories/{categoryId}/customimage?categoryId=5',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/categories/{categoryId}/customimage

This endpoint updates the custom image override for a redemption category

Body parameter

{
  "imageName": "string",
  "imageExtension": "string",
  "originalImageName": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
categoryId query integer true The id of the category for which a custom image is being provided
body body object false none
» imageName body string true none
» imageExtension body string true none
» originalImageName body string false none

Example responses

200 Response

{
  "id": 1,
  "categoryId": 3,
  "configurationId": 1,
  "logo": "https://ugc.rewardgateway.dev/img/RewardRecognition/Redemption/Categories/3-1.png",
  "originalImageName": "boom.png"
}

Responses

Status Meaning Description Schema
200 OK Successful operation redemptionCategoryCustomImage
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The category custom image was not found errorModel

Update the R&R configuration

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/recognition/redemption/configuration/{schemeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/recognition/redemption/configuration/{schemeId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/recognition/redemption/configuration/{schemeId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "pageRedeemTitle": "string",
  "pageRedeemDescription": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/configuration/{schemeId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /recognition/redemption/configuration/{schemeId}

This endpoint will update the R&R configuration

Body parameter

{
  "pageRedeemTitle": "string",
  "pageRedeemDescription": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
schemeId path integer true The id of the scheme which is being edited
body body object true none
» pageRedeemTitle body string false none
» pageRedeemDescription body string false none

Example responses

200 Response

[
  {
    "rrConfigurationId": 1,
    "schemeId": 2,
    "pageRedeemTitle": "Redeem Award",
    "pageRedeemDescription": "Don't forget, you can spend your awards at more than one retailer",
    "enabled": true,
    "global": false
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [redemptionConfigurationSuccess] false none [Class ConfigurationSuccess]
» rrConfigurationId integer true none The RR Configuration Id
» schemeId integer true none The scheme Id
» pageRedeemTitle string true none The page redeem title
» pageRedeemDescription string true none The page redeem description
» enabled boolean true none Is enabled
» global boolean true none Is global

Get all custom reward items in the shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/custom/basket', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/custom/basket HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/custom/basket \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/basket',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/custom/basket

This endpoint will return all items the current member has in their shopping basket.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
basketId query string false Basket identifier

Example responses

200 Response

{
  "basketId": "string",
  "currency": "string",
  "total": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "subtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "saving": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "rrUsed": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "items": [
    {
      "id": "string",
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "cost": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "tax": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "saving": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "quantity": 0,
      "termsAndConditions": "string",
      "variantInfo": [
        "string"
      ],
      "adjustments": [
        null
      ],
      "useQuantity": true
    }
  ],
  "messages": [
    "string"
  ],
  "originalCurrencySubtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation basket
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket was not found errorModel

Add custom reward product to basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recognition/redemption/custom/basket', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recognition/redemption/custom/basket HTTP/1.1
Host: api.rewardgateway.net
Content-Type: multipart/form-data
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recognition/redemption/custom/basket \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "productId": "string",
  "quantity": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/basket',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recognition/redemption/custom/basket

This endpoint adds a CustomReward product to the basket

Body parameter

productId: string
quantity: string

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» productId body string true The product id of the item that we would like added to the basket
» quantity body string false The quantity of the product that we want in the basket. Default value of 1 will be used if no value is provided

Example responses

200 Response

{
  "basketId": "string",
  "currency": "string",
  "total": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "subtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "saving": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "rrUsed": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "items": [
    {
      "id": "string",
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "cost": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "tax": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "saving": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "quantity": 0,
      "termsAndConditions": "string",
      "variantInfo": [
        "string"
      ],
      "adjustments": [
        null
      ],
      "useQuantity": true
    }
  ],
  "messages": [
    "string"
  ],
  "originalCurrencySubtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation basket
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket was not found. errorModel

Clear the custom reward shopping basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/recognition/redemption/custom/basket', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/recognition/redemption/custom/basket HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/recognition/redemption/custom/basket \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/basket',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /recognition/redemption/custom/basket

This endpoint will clear all items currently available in the current member's shopping basket.

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

{
  "basketId": "string",
  "currency": "string",
  "total": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "subtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "saving": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "rrUsed": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "items": [
    {
      "id": "string",
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "cost": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "tax": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "saving": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "quantity": 0,
      "termsAndConditions": "string",
      "variantInfo": [
        "string"
      ],
      "adjustments": [
        null
      ],
      "useQuantity": true
    }
  ],
  "messages": [
    "string"
  ],
  "originalCurrencySubtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation basket
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket was not found errorModel

Remove custom reward product from basket

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.rewardgateway.net/recognition/redemption/custom/basket/{productId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE https://api.rewardgateway.net/recognition/redemption/custom/basket/{productId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X DELETE https://api.rewardgateway.net/recognition/redemption/custom/basket/{productId} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/basket/{productId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /recognition/redemption/custom/basket/{productId}

This endpoint removes a CustomReward product from the basket

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
productId path string true The product id of the item that we would like removed from the basket

Example responses

200 Response

{
  "basketId": "string",
  "currency": "string",
  "total": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "subtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "saving": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "rrUsed": {
    "formattedValue": "£12.34",
    "value": 12.34
  },
  "items": [
    {
      "id": "string",
      "type": "string",
      "productId": 0,
      "productType": "string",
      "name": "string",
      "image": "string",
      "currency": "string",
      "price": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "cost": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "tax": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "saving": {
        "formattedValue": "£12.34",
        "value": 12.34
      },
      "quantity": 0,
      "termsAndConditions": "string",
      "variantInfo": [
        "string"
      ],
      "adjustments": [
        null
      ],
      "useQuantity": true
    }
  ],
  "messages": [
    "string"
  ],
  "originalCurrencySubtotal": {
    "formattedValue": "£12.34",
    "value": 12.34
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation basket
403 Forbidden Access to the resource has been denied errorModel
404 Not Found Basket or Product was not found. errorModel

Get a list of orders Fulfilled, Unfulfilled or both

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/custom/orders/fulfillment', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/custom/orders/fulfillment HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/custom/orders/fulfillment \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/orders/fulfillment',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/custom/orders/fulfillment

This endpoint returns a list of fulfilled, unfulfilled or both reward orders

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
offset query string false Pagination offset
limit query string false Pagination limit
fulfillmentStatus query string false Fulfillment status of the orders to get (Fulfilled, Unfulfilled), defaults to both.

Example responses

200 Response

{
  "items": [
    {
      "orderId": 1234,
      "orderDate": 1621004601,
      "memberName": "Joe Bloggs",
      "memberEmail": "joe.bloggs@email.com",
      "memberLicenceKey": "ABC12345",
      "title": "Lunch with the CEO",
      "qty": 2,
      "transactionId": 12345678,
      "status": "Unfulfilled",
      "productId": 12
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "count": 157,
    "additionalItems": true
  }
}

Responses

Status Meaning Description Schema
200 OK Successful operation customOrderFulfillment
403 Forbidden Access to the resource has been denied errorModel

Marks an order item as fulfilled

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/fulfil', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/fulfil HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/fulfil \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/fulfil',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/custom/order/{transactionId}/fulfil

Marks an order item as fulfilled via it's transaction id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path string true The transactionId belonging to one of the order items that we want marked as fulfilled, e.g. 1

Example responses

200 Response

{
  "orderId": 1234,
  "orderDate": 1621004601,
  "memberName": "Joe Bloggs",
  "memberEmail": "joe.bloggs@email.com",
  "memberLicenceKey": "ABC12345",
  "title": "Lunch with the CEO",
  "qty": 2,
  "transactionId": 12345678,
  "status": "Unfulfilled",
  "productId": 12
}

Responses

Status Meaning Description Schema
200 OK Successful operation customOrderFulfillmentItem
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The order item was not found in the unfulfilled state errorModel

Marks an order item as unfulfilled

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/unfulfil', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/unfulfil HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/unfulfil \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/order/{transactionId}/unfulfil',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/custom/order/{transactionId}/unfulfil

Marks an order item as unfulfilled via it's transaction id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
transactionId path string true The transactionId belonging to one of the order items that we want marked as unfulfilled, e.g. 1

Example responses

200 Response

{
  "orderId": 1234,
  "orderDate": 1621004601,
  "memberName": "Joe Bloggs",
  "memberEmail": "joe.bloggs@email.com",
  "memberLicenceKey": "ABC12345",
  "title": "Lunch with the CEO",
  "qty": 2,
  "transactionId": 12345678,
  "status": "Unfulfilled",
  "productId": 12
}

Responses

Status Meaning Description Schema
200 OK Successful operation customOrderFulfillmentItem
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The order item was not found in the fulfilled state errorModel

Marks order items as fulfilled in bulk

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/fulfil', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/fulfil HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/fulfil \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "transactionIds": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/fulfil',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/custom/order/bulk/fulfil

Marks order items as fulfilled in bulk via their transaction ids

Body parameter

{
  "transactionIds": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» transactionIds body string true The transaction ids to mark as fulfilled e.g. 1,3,4,12,13

Example responses

200 Response

{
  "processed": [
    0
  ],
  "unprocessed": [
    0
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation redemptionBulkProcessResult
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Marks order items as unfulfilled in bulk

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/unfulfil', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/unfulfil HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PATCH https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/unfulfil \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "transactionIds": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/order/bulk/unfulfil',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /recognition/redemption/custom/order/bulk/unfulfil

Marks order item as unfulfilled in bulk via their transaction ids

Body parameter

{
  "transactionIds": "string"
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body object false none
» transactionIds body string true The transaction ids to mark as unfulfilled e.g. 1,3,4,12,13

Example responses

200 Response

{
  "processed": [
    0
  ],
  "unprocessed": [
    0
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful operation redemptionBulkProcessResult
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Get custom rewards

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/custom', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/custom HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/custom \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/custom

This endpoint returns a list of custom rewards

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning

Example responses

200 Response

[
  {
    "id": 0,
    "title": "string",
    "description": "string",
    "localeId": 0,
    "image": "string",
    "currency": "string",
    "price": 1.99,
    "qty": 0,
    "rrConfigurationId": 0,
    "createdOn": "string",
    "createdBy": "string",
    "deleted": true,
    "enabled": true,
    "parentId": 0,
    "instructions": "string",
    "termsAndConditions": "string",
    "rrRedemptionCategoryId": 0,
    "purchasable": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [customReward] false none none
» id integer true none Id
» title string true none Type
» description string true none Description
» localeId integer true none LocaleId
» image string true none Image
» currency string false none currency
» price number(float) true none The price of the product
» qty integer¦null true none Qty
» rrConfigurationId integer true none rrConfigurationId
» createdOn string false none createdOn
» createdBy string false none createdBy
» deleted boolean false none Deleted
» enabled boolean false none Enabled
» parentId integer¦null false none parentId
» instructions string false none instructions
» termsAndConditions string false none terms and conditions
» rrRedemptionCategoryId integer¦null false none rrRedemptionCategoryId
» purchasable boolean¦null false none Purchasable

Creates a new custom reward

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.rewardgateway.net/recognition/redemption/custom', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.rewardgateway.net/recognition/redemption/custom HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X POST https://api.rewardgateway.net/recognition/redemption/custom \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "id": 0,
  "title": "string",
  "description": "string",
  "localeId": 0,
  "image": "string",
  "currency": "string",
  "price": 1.99,
  "qty": 0,
  "rrConfigurationId": 0,
  "createdOn": "string",
  "createdBy": "string",
  "deleted": true,
  "enabled": true,
  "parentId": 0,
  "instructions": "string",
  "termsAndConditions": "string",
  "rrRedemptionCategoryId": 0,
  "purchasable": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /recognition/redemption/custom

This endpoint creates a new custom reward

Body parameter

{
  "id": 0,
  "title": "string",
  "description": "string",
  "localeId": 0,
  "image": "string",
  "currency": "string",
  "price": 1.99,
  "qty": 0,
  "rrConfigurationId": 0,
  "createdOn": "string",
  "createdBy": "string",
  "deleted": true,
  "enabled": true,
  "parentId": 0,
  "instructions": "string",
  "termsAndConditions": "string",
  "rrRedemptionCategoryId": 0,
  "purchasable": true
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
body body customReward false none

Example responses

200 Response

[
  {
    "id": 0,
    "title": "string",
    "description": "string",
    "localeId": 0,
    "image": "string",
    "currency": "string",
    "price": 1.99,
    "qty": 0,
    "rrConfigurationId": 0,
    "createdOn": "string",
    "createdBy": "string",
    "deleted": true,
    "enabled": true,
    "parentId": 0,
    "instructions": "string",
    "termsAndConditions": "string",
    "rrRedemptionCategoryId": 0,
    "purchasable": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [customReward] false none none
» id integer true none Id
» title string true none Type
» description string true none Description
» localeId integer true none LocaleId
» image string true none Image
» currency string false none currency
» price number(float) true none The price of the product
» qty integer¦null true none Qty
» rrConfigurationId integer true none rrConfigurationId
» createdOn string false none createdOn
» createdBy string false none createdBy
» deleted boolean false none Deleted
» enabled boolean false none Enabled
» parentId integer¦null false none parentId
» instructions string false none instructions
» termsAndConditions string false none terms and conditions
» rrRedemptionCategoryId integer¦null false none rrRedemptionCategoryId
» purchasable boolean¦null false none Purchasable

Return one custom reward by id

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId} HTTP/1.1
Host: api.rewardgateway.net
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X GET https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId} \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'


const headers = {
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /recognition/redemption/custom/{customRewardId}

This endpoint returns one custom reward by id

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
customRewardId path string true The id of the custom reward, e.g. 1

Example responses

200 Response

[
  {
    "id": 0,
    "title": "string",
    "description": "string",
    "localeId": 0,
    "image": "string",
    "currency": "string",
    "price": 1.99,
    "qty": 0,
    "rrConfigurationId": 0,
    "createdOn": "string",
    "createdBy": "string",
    "deleted": true,
    "enabled": true,
    "parentId": 0,
    "instructions": "string",
    "termsAndConditions": "string",
    "rrRedemptionCategoryId": 0,
    "purchasable": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The custom reward was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [customReward] false none none
» id integer true none Id
» title string true none Type
» description string true none Description
» localeId integer true none LocaleId
» image string true none Image
» currency string false none currency
» price number(float) true none The price of the product
» qty integer¦null true none Qty
» rrConfigurationId integer true none rrConfigurationId
» createdOn string false none createdOn
» createdBy string false none createdBy
» deleted boolean false none Deleted
» enabled boolean false none Enabled
» parentId integer¦null false none parentId
» instructions string false none instructions
» termsAndConditions string false none terms and conditions
» rrRedemptionCategoryId integer¦null false none rrRedemptionCategoryId
» purchasable boolean¦null false none Purchasable

Updates custom reward

Code samples

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'xxxxx.yyyyy.zzzzz',
    'Accept' => 'application/vnd.rewardgateway+json;version=3.0',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId} HTTP/1.1
Host: api.rewardgateway.net
Content-Type: application/json
Accept: application/json
Authorization: xxxxx.yyyyy.zzzzz
Accept: application/vnd.rewardgateway+json;version=3.0

# You can also use wget
curl -X PUT https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: xxxxx.yyyyy.zzzzz' \
  -H 'Accept: application/vnd.rewardgateway+json;version=3.0'

const inputBody = '{
  "id": 0,
  "title": "string",
  "description": "string",
  "localeId": 0,
  "image": "string",
  "currency": "string",
  "price": 1.99,
  "qty": 0,
  "rrConfigurationId": 0,
  "createdOn": "string",
  "createdBy": "string",
  "deleted": true,
  "enabled": true,
  "parentId": 0,
  "instructions": "string",
  "termsAndConditions": "string",
  "rrRedemptionCategoryId": 0,
  "purchasable": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'xxxxx.yyyyy.zzzzz',
  'Accept':'application/vnd.rewardgateway+json;version=3.0'
};

fetch('https://api.rewardgateway.net/recognition/redemption/custom/{customRewardId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /recognition/redemption/custom/{customRewardId}

This endpoint updates one custom reward by id

Body parameter

{
  "id": 0,
  "title": "string",
  "description": "string",
  "localeId": 0,
  "image": "string",
  "currency": "string",
  "price": 1.99,
  "qty": 0,
  "rrConfigurationId": 0,
  "createdOn": "string",
  "createdBy": "string",
  "deleted": true,
  "enabled": true,
  "parentId": 0,
  "instructions": "string",
  "termsAndConditions": "string",
  "rrRedemptionCategoryId": 0,
  "purchasable": true
}

Parameters

Name In Type Required Description
Authorization header string true Authorization Header with Bearer Token
Accept header string true Accept Header with Vendor Versioning
customRewardId path string true The id of the custom reward to update, e.g. 1
body body customReward false none

Example responses

200 Response

[
  {
    "id": 0,
    "title": "string",
    "description": "string",
    "localeId": 0,
    "image": "string",
    "currency": "string",
    "price": 1.99,
    "qty": 0,
    "rrConfigurationId": 0,
    "createdOn": "string",
    "createdBy": "string",
    "deleted": true,
    "enabled": true,
    "parentId": 0,
    "instructions": "string",
    "termsAndConditions": "string",
    "rrRedemptionCategoryId": 0,
    "purchasable": true
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request errorModel
403 Forbidden Access to the resource has been denied errorModel
404 Not Found The custom reward was not found errorModel

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [customReward] false none none
» id integer true none Id
» title string true none Type
» description string true none Description
» localeId integer true none LocaleId
» image string true none Image
» currency string false none currency
» price number(float) true none The price of the product
» qty integer¦null true none Qty
» rrConfigurationId integer true none rrConfigurationId
» createdOn string false none createdOn
» createdBy string false none createdBy
» deleted boolean false none Deleted
» enabled boolean false none Enabled
» parentId integer¦null false none parentId
» instructions string false none instructions
» termsAndConditions string false none