Introduction

Welcome to te roiward API! You can use our API to access Roiward endpoints which can create campaigns, send rewards or retrieve information.

Before starting, we want to explain a bit the roiward structure and how it works.

The first step is have an authorization token to make requests. you can see the steps to follow in the Authentication section.

The second one, have available budget. If you still don’t have, you must contact us to handle this. Or follow the steps in the UI to create a deposit request. In less than 48 hours we will check if everything is right and you can manage your campaigns.

When you have an autorization token and available budget, the next step to send a reward must be create a campaign.

You can manage it in the Campaign section.

The last step to send a reward is to choose the way to send (or retrieve) it. We have three ways to do it:

Single Send: Send one by one by email (sms and whatsapp message soon). To create a single send request, you must go to VoucherService.
Bulk Upload: Upload a bulk list with the configuration and we send it. To create a Bulk Upload request, you must go to BulkProcess.
Bulk Download: You can create a request with a certain number of rewards and download a list with the links to manage by yourself. To create a Bulk Download request, you must go to BulkDownloadProcess.

Quick Start

With the following steps you can send easyly a voucher.

Create a Campaign.
Choose the method:

If you want that sending will be managed by roiward with single send, we handle the request and send an email to the reiciver with a link to retrieve the reward.
Or if you want to send the voucher by yourself with single download, you can retrieve an url to manage it with your own flow.

To fill the request, you must retrieve some info about the vouchers:

Neccesary fields on both methods

campaignId The response when you create a campaign has the id of the campaign.
selectedVouchers An array with the info of the reward. If is a voucher, you only need to include voucherTypeId and amount. Else, you need to include Amazon Product amzProduct fields too.

Use GetProviders to get the voucher Info you need to retrieve a list of your available vouchers to send. you only need the id and one of the available amounts, if the amounts field is empty, you can fill the request with the quantity you need.

Neccesary fields only to send by roiward

Personal Data of the receiver like fullName or phone.
email of the reiciver.
sendingMethod by default you need to put 0 (by email).

Customization

When an user reicive a link to redeem his reward, him will land to a default design with roiward identity. Same happens when you send and email with our engine. You can solve it creating a custom templates.

We detected two touch points with the final user:

Email
Redeem Landing

To create a customized Email, you have two ways:

Using our default template and modifying differents params to align with your identity.
Create a fully customizable email with mjml.

To create a customized Landing you must create it with customized params.

To retrieve the different templates, create or edit, you can use the following endpoints:

Redeem Landing endpoints
Custom Email template endpoints
Default Email endpoints

Finally, you must attach this templates to a campaign.

Roiward API v1

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

Roiward API documentation

Base URLs:

https://atenea.api.dative.cloud/

Email: Roiward Web: Roiward

Authentication

API Key (Bearer)
- Parameter Name: Authorization, in: header. JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Balance

Get Balances

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/Balance/GetBalances", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/Balance/GetBalances

Example responses

200 Response

{"balances":[{"currencyId":0,"balance":0}]}

{
  "balances": [
    {
      "currencyId": 0,
      "balance": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	GetBalancesDto

BulkDownloadUrlProcess

Create Bulk Download Request

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "description": "string",
  "campaignId": 0,
  "bulkDownloadRequests": [
    {
      "quantity": 0,
      "vouchersGenerated": 0,
      "selectedVouchers": [
        {
          "voucherTypeId": 0,
          "amount": 0,
          "amzProduct": [
            {}
          ]
        }
      ]
    }
  ],
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/BulkDownloadUrlProcess/CreateDownloadUrlBulkRequest

Body parameter

{
  "name": "string",
  "description": "string",
  "campaignId": 0,
  "bulkDownloadRequests": [
    {
      "quantity": 0,
      "vouchersGenerated": 0,
      "selectedVouchers": [
        {
          "voucherTypeId": 0,
          "amount": 0,
          "amzProduct": [
            {}
          ]
        }
      ]
    }
  ],
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	BulkDownloadUrlRequestDto	false	none

Example responses

200 Response

{"name":"string","description":"string","status":0,"campaignId":0,"campaign":{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"campaignBudget":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0},"extensionData":"string","organizationUnitId":0,"id":0},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"extensionData":"string","vouchersGenerated":0,"quantity":0,"id":0}

{
  "name": "string",
  "description": "string",
  "status": 0,
  "campaignId": 0,
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "tenantId": 0,
  "extensionData": "string",
  "vouchersGenerated": 0,
  "quantity": 0,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	BulkDownloadUrlProcess

Trigger Bulk Download Request

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/BulkDownloadUrlProcess/TriggerBulkDownloadUrlRequestsProcess

Parameters

Name	In	Type	Required	Description
BulkProcessId	query	integer(int32)	false	none

Example responses

200 Response

[{"status":0,"voucherId":0,"multiVoucher":[{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","redeemUrl":"string","voucherGuid":"79bf5cd0-f72a-4724-a3cb-49f58d54ba5b"}],"multiVoucherDetails":[{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","voucherId":0,"voucherTypeId":0,"code":"string","voucherCodeId":0,"status":0,"amount":0,"extensionData":"string"}],"bulkProcessId":0,"creationTime":"2019-08-24T14:15:22Z","voucherGuid":"79bf5cd0-f72a-4724-a3cb-49f58d54ba5b","campaignId":0,"voucherUrl":"string"}]

[
  {
    "status": 0,
    "voucherId": 0,
    "multiVoucher": [
      {
        "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
        "redeemUrl": "string",
        "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b"
      }
    ],
    "multiVoucherDetails": [
      {
        "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
        "voucherId": 0,
        "voucherTypeId": 0,
        "code": "string",
        "voucherCodeId": 0,
        "status": 0,
        "amount": 0,
        "extensionData": "string"
      }
    ],
    "bulkProcessId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b",
    "campaignId": 0,
    "voucherUrl": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DownloadVoucherUrlResponseDto]	false	none	none
» status	DownloadVoucherUrlRequestStatus(int32)	true	none	none
» voucherId	integer(int32)	true	none	none
» multiVoucher	[SelectedVoucher]¦null	false	none	none
»» guid	string(uuid)¦null	false	none	none
»» redeemUrl	string¦null	false	none	none
»» voucherGuid	string(uuid)	false	none	none
» multiVoucherDetails	[VoucherDetailResponse]¦null	false	none	none
»» guid	string(uuid)	true	none	none
»» voucherId	integer(int32)	true	none	none
»» voucherTypeId	integer(int32)	true	none	none
»» code	string¦null	false	none	none
»» voucherCodeId	integer(int32)	true	none	none
»» status	VoucherDetailStatus(int32)	true	none	none
»» amount	number(double)	false	none	none
»» extensionData	string¦null	false	none	none
» bulkProcessId	integer(int32)¦null	false	none	none
» creationTime	string(date-time)	false	none	none
» voucherGuid	string(uuid)	false	none	none
» campaignId	integer(int32)	false	none	none
» voucherUrl	string¦null	false	none	none

Enumerated Values

Property	Value
status	0
status	1
status	2
status	0
status	1
status	2

BulkProcess

Create Bulk Upload Request for MultiVoucher

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "description": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "requests": [
    {
      "tenantId": 0,
      "email": "string",
      "phone": "string",
      "sendingMethod": 0,
      "fullName": "string",
      "campaignId": 0,
      "selectedVouchers": [
        {
          "voucherTypeId": 0,
          "amount": 0,
          "amzProduct": [
            {}
          ]
        }
      ],
      "status": 0
    }
  ],
  "campaignId": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/BulkProcess/CreateBulkRequestForMultiVoucher

Body parameter

{
  "name": "string",
  "description": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "requests": [
    {
      "tenantId": 0,
      "email": "string",
      "phone": "string",
      "sendingMethod": 0,
      "fullName": "string",
      "campaignId": 0,
      "selectedVouchers": [
        {
          "voucherTypeId": 0,
          "amount": 0,
          "amzProduct": [
            {}
          ]
        }
      ],
      "status": 0
    }
  ],
  "campaignId": 0
}

Parameters

Name	In	Type	Required	Description
body	body	BulkRequestMultiVoucherDto	false	none

Example responses

200 Response

{"name":"string","description":"string","status":0,"campaignId":0,"campaign":{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"campaignBudget":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0},"extensionData":"string","organizationUnitId":0,"id":0},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"extensionData":"string","quantity":0,"vouchersGenerated":0,"id":0}

{
  "name": "string",
  "description": "string",
  "status": 0,
  "campaignId": 0,
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "tenantId": 0,
  "extensionData": "string",
  "quantity": 0,
  "vouchersGenerated": 0,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	BulkProcess

Trigger Bulk Upload Request

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json

const inputBody = '{
  "bulkRequestId": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/BulkProcess/TriggerBulkRequest", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/BulkProcess/TriggerBulkRequest

Body parameter

{
  "bulkRequestId": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TriggerBulkRequesttDto	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Campaign

A Campaign is a way to frame a group of voucher requests. A campaign has Budget, validity period, visual configuration and voucher types you can send.

For example: with this organization you can difference between the summer or christmas promos, compare performances or customize each campaign with different styles.

Create a new Campaign

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/Campaign/CreateCampaign", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/Campaign/CreateCampaign

This endpoint creates a campaign. To fill the request you need some info before:

Country fields

countryId retrieve a list of available countries with CountryTenant
currencyId retrieve a list of available currencies with CurrencyTenant

Customization fields

templateId it configures the redeem landing style.
templateConfigurationId
landingConfigurationId

You can read more about customization.

Body parameter

{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	CreateCampaignDto	false	none

Example responses

200 Response

{"name":"string","countryId":0,"currencyId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"activeVoucherTypes":[{"voucherTypeId":0}],"campaignBudget":0,"organizationUnitId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","campaignMetrics":{"vouchersByCampaign":0,"redeemVouchersInCampaign":0,"refundedVouchersInCampaign":0,"budgetSpent":0,"refundedVouchersTotalAmount":0,"redeemVouchersTotalAmount":0},"id":0}

{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "campaignMetrics": {
    "vouchersByCampaign": 0,
    "redeemVouchersInCampaign": 0,
    "refundedVouchersInCampaign": 0,
    "budgetSpent": 0,
    "refundedVouchersTotalAmount": 0,
    "redeemVouchersTotalAmount": 0
  },
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CreateCampaignResponseDto

Edit an existing Campaign

Code samples

# You can also use wget
curl -X PUT https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

PUT https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.put('https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('PUT','https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://atenea.api.dative.cloud/api/services/app/Campaign/UpdateCampaign", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/services/app/Campaign/UpdateCampaign

Body parameter

{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	CreateCampaignDto	false	none

Example responses

200 Response

{"name":"string","countryId":0,"currencyId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"activeVoucherTypes":[{"voucherTypeId":0}],"campaignBudget":0,"organizationUnitId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","campaignMetrics":{"vouchersByCampaign":0,"redeemVouchersInCampaign":0,"refundedVouchersInCampaign":0,"budgetSpent":0,"refundedVouchersTotalAmount":0,"redeemVouchersTotalAmount":0},"id":0}

{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "campaignMetrics": {
    "vouchersByCampaign": 0,
    "redeemVouchersInCampaign": 0,
    "refundedVouchersInCampaign": 0,
    "budgetSpent": 0,
    "refundedVouchersTotalAmount": 0,
    "redeemVouchersTotalAmount": 0
  },
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CreateCampaignResponseDto

Get Campaign

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/Campaign/Get \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/Campaign/Get HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Campaign/Get',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/Campaign/Get',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/Campaign/Get', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/Campaign/Get', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Campaign/Get");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/Campaign/Get", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/Campaign/Get

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Example responses

200 Response

{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"activeVoucherTypes":[{"voucherTypeId":0}],"activeVoucherTypesDetails":[{"title":"string","countryCode":"string","countryName":"string","countryId":0,"description":"string","amounts":"string","currency":"string","currencyId":0,"logo":"string","cardImage":"string","notes":"string","category":"string","validity":"string","cumulable":"string","spendMultipleTimes":"string","ideaShopping":"string","multipurpose":"string","singleService":"string","whereToRedeem":"string","info":"string","termsAndConditions":"string","stockVouchers":true,"voucherProviderTypes":[{"voucherProviderId":0,"voucherProvider":{"name":null,"voucherProviderTypes":null,"creatorUserId":null,"creationTime":null,"lastModifierUserId":null,"lastModificationTime":null,"id":null},"voucherTypeId":0,"voucherType":{"title":null,"countryCode":null,"countryName":null,"countryId":null,"description":null,"amounts":null,"currency":null,"currencyId":null,"logo":null,"cardImage":null,"notes":null,"category":null,"validity":null,"cumulable":null,"spendMultipleTimes":null,"ideaShopping":null,"multipurpose":null,"singleService":null,"whereToRedeem":null,"info":null,"termsAndConditions":null,"stockVouchers":null,"voucherProviderTypes":null,"voucherTypeCategoryId":null,"currencyFK":null,"country":null,"voucherTypeCategory":null,"creatorUserId":null,"creationTime":null,"lastModifierUserId":null,"lastModificationTime":null,"id":null},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","id":0}],"voucherTypeCategoryId":0,"currencyFK":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0},"voucherTypeCategory":{"name":"string","id":0},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","id":0}],"campaignBudget":0,"organizationUnitId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","currentCampaignBudget":0,"campaignMetrics":{"vouchersByCampaign":0,"redeemVouchersInCampaign":0,"refundedVouchersInCampaign":0,"budgetSpent":0,"refundedVouchersTotalAmount":0,"redeemVouchersTotalAmount":0},"id":0}

{
  "name": "string",
  "currencyId": 0,
  "countryId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "activeVoucherTypesDetails": [
    {
      "title": "string",
      "countryCode": "string",
      "countryName": "string",
      "countryId": 0,
      "description": "string",
      "amounts": "string",
      "currency": "string",
      "currencyId": 0,
      "logo": "string",
      "cardImage": "string",
      "notes": "string",
      "category": "string",
      "validity": "string",
      "cumulable": "string",
      "spendMultipleTimes": "string",
      "ideaShopping": "string",
      "multipurpose": "string",
      "singleService": "string",
      "whereToRedeem": "string",
      "info": "string",
      "termsAndConditions": "string",
      "stockVouchers": true,
      "voucherProviderTypes": [
        {
          "voucherProviderId": 0,
          "voucherProvider": {
            "name": null,
            "voucherProviderTypes": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          },
          "voucherTypeId": 0,
          "voucherType": {
            "title": null,
            "countryCode": null,
            "countryName": null,
            "countryId": null,
            "description": null,
            "amounts": null,
            "currency": null,
            "currencyId": null,
            "logo": null,
            "cardImage": null,
            "notes": null,
            "category": null,
            "validity": null,
            "cumulable": null,
            "spendMultipleTimes": null,
            "ideaShopping": null,
            "multipurpose": null,
            "singleService": null,
            "whereToRedeem": null,
            "info": null,
            "termsAndConditions": null,
            "stockVouchers": null,
            "voucherProviderTypes": null,
            "voucherTypeCategoryId": null,
            "currencyFK": null,
            "country": null,
            "voucherTypeCategory": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          },
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        }
      ],
      "voucherTypeCategoryId": 0,
      "currencyFK": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "id": 0
      },
      "voucherTypeCategory": {
        "name": "string",
        "id": 0
      },
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "currentCampaignBudget": 0,
  "campaignMetrics": {
    "vouchersByCampaign": 0,
    "redeemVouchersInCampaign": 0,
    "refundedVouchersInCampaign": 0,
    "budgetSpent": 0,
    "refundedVouchersTotalAmount": 0,
    "redeemVouchersTotalAmount": 0
  },
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CampaignDto

Get all Campaigns

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/Campaign/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/Campaign/GetAll

Parameters

Name	In	Type	Required	Description
Name	query	string	false	none
IsActive	query	integer(int32)	false	none
CurrencyId	query	integer(int32)	false	none
Sorting	query	string	false	none
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"activeVoucherTypes":[{"voucherTypeId":0}],"activeVoucherTypesDetails":[{"title":"string","countryCode":"string","countryName":"string","countryId":0,"description":"string","amounts":"string","currency":"string","currencyId":0,"logo":"string","cardImage":"string","notes":"string","category":"string","validity":"string","cumulable":"string","spendMultipleTimes":"string","ideaShopping":"string","multipurpose":"string","singleService":"string","whereToRedeem":"string","info":"string","termsAndConditions":"string","stockVouchers":true,"voucherProviderTypes":[{}],"voucherTypeCategoryId":0,"currencyFK":{"name":null,"symbol":null,"code":null,"id":null},"country":{"name":null,"code":null,"currencyId":null,"currency":null,"id":null},"voucherTypeCategory":{"name":null,"id":null},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","id":0}],"campaignBudget":0,"organizationUnitId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","currentCampaignBudget":0,"campaignMetrics":{"vouchersByCampaign":0,"redeemVouchersInCampaign":0,"refundedVouchersInCampaign":0,"budgetSpent":0,"refundedVouchersTotalAmount":0,"redeemVouchersTotalAmount":0},"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "activeVoucherTypes": [
        {
          "voucherTypeId": 0
        }
      ],
      "activeVoucherTypesDetails": [
        {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            {}
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {
            "name": null,
            "symbol": null,
            "code": null,
            "id": null
          },
          "country": {
            "name": null,
            "code": null,
            "currencyId": null,
            "currency": null,
            "id": null
          },
          "voucherTypeCategory": {
            "name": null,
            "id": null
          },
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        }
      ],
      "campaignBudget": 0,
      "organizationUnitId": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "currentCampaignBudget": 0,
      "campaignMetrics": {
        "vouchersByCampaign": 0,
        "redeemVouchersInCampaign": 0,
        "refundedVouchersInCampaign": 0,
        "budgetSpent": 0,
        "refundedVouchersTotalAmount": 0,
        "redeemVouchersTotalAmount": 0
      },
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CampaignDtoPagedResultDto

Delete a Campaign

Code samples

# You can also use wget
curl -X DELETE https://atenea.api.dative.cloud/api/services/app/Campaign/Delete \
  -H 'Authorization: API_KEY'

DELETE https://atenea.api.dative.cloud/api/services/app/Campaign/Delete HTTP/1.1
Host: atenea.api.dative.cloud


const headers = {
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Campaign/Delete',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://atenea.api.dative.cloud/api/services/app/Campaign/Delete',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete('https://atenea.api.dative.cloud/api/services/app/Campaign/Delete', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('DELETE','https://atenea.api.dative.cloud/api/services/app/Campaign/Delete', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Campaign/Delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://atenea.api.dative.cloud/api/services/app/Campaign/Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/services/app/Campaign/Delete

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

CountryTenant

Get all countries available in account

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/CountryTenant/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/CountryTenant/GetAll

Parameters

Name	In	Type	Required	Description
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none
Sorting	query	string	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"countryId":0,"tenantId":0,"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0},"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "countryId": 0,
      "tenantId": 0,
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "id": 0
      },
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CountryTenantDtoPagedResultDto

CurrencyTenant

Get all currencies available in account

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/CurrencyTenant/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/CurrencyTenant/GetAll

Parameters

Name	In	Type	Required	Description
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none
Sorting	query	string	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"currencyId":0,"tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "currencyId": 0,
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	CurrencyTenantDtoPagedResultDto

LandingConfiguration

Create a redeem landing configuration

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/LandingConfiguration/Create

Body parameter

{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	LandingConfigurationDto	false	none

Example responses

200 Response

{"name":"string","backgroundImg":"string","backgroundColor":"string","btn":"string","logoImg":"string","logoStyle":"string","redeemTitle":"string","sendVoucherTitle":"string","default":true,"id":0}

{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LandingConfigurationDto

Update a redeem landing configuration

Code samples

# You can also use wget
curl -X PUT https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

PUT https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.put('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('PUT','https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/services/app/LandingConfiguration/Update

Body parameter

{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	LandingConfigurationDto	false	none

Example responses

200 Response

{"name":"string","backgroundImg":"string","backgroundColor":"string","btn":"string","logoImg":"string","logoStyle":"string","redeemTitle":"string","sendVoucherTitle":"string","default":true,"id":0}

{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LandingConfigurationDto

Delete a redeem landing configuration

Code samples

# You can also use wget
curl -X DELETE https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete \
  -H 'Authorization: API_KEY'

DELETE https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete HTTP/1.1
Host: atenea.api.dative.cloud


const headers = {
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('DELETE','https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/services/app/LandingConfiguration/Delete

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get a redeem landing configuration

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/Get", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/LandingConfiguration/Get

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Example responses

200 Response

{"name":"string","backgroundImg":"string","backgroundColor":"string","btn":"string","logoImg":"string","logoStyle":"string","redeemTitle":"string","sendVoucherTitle":"string","default":true,"id":0}

{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LandingConfigurationDto

Get all redeem landing's configurations available in account

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/LandingConfiguration/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/LandingConfiguration/GetAll

Parameters

Name	In	Type	Required	Description
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none
Sorting	query	string	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"name":"string","backgroundImg":"string","backgroundColor":"string","btn":"string","logoImg":"string","logoStyle":"string","redeemTitle":"string","sendVoucherTitle":"string","default":true,"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "backgroundImg": "string",
      "backgroundColor": "string",
      "btn": "string",
      "logoImg": "string",
      "logoStyle": "string",
      "redeemTitle": "string",
      "sendVoucherTitle": "string",
      "default": true,
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	LandingConfigurationDtoPagedResultDto

Template

Create Email Template

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/Template/Create \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/Template/Create HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Template/Create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/Template/Create',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/Template/Create', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/Template/Create', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Template/Create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/Template/Create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/Template/Create

Body parameter

{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TemplateDto	false	none

Example responses

200 Response

{"name":"string","mjml":"string","default":true,"id":0}

{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateDto

Get an email template

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/Template/Get \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/Template/Get HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Template/Get',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/Template/Get',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/Template/Get', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/Template/Get', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Template/Get");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/Template/Get", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/Template/Get

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Example responses

200 Response

{"name":"string","mjml":"string","default":true,"id":0}

{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateDto

Update an email template

Code samples

# You can also use wget
curl -X PUT https://atenea.api.dative.cloud/api/services/app/Template/Update \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

PUT https://atenea.api.dative.cloud/api/services/app/Template/Update HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Template/Update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://atenea.api.dative.cloud/api/services/app/Template/Update',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.put('https://atenea.api.dative.cloud/api/services/app/Template/Update', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('PUT','https://atenea.api.dative.cloud/api/services/app/Template/Update', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Template/Update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://atenea.api.dative.cloud/api/services/app/Template/Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/services/app/Template/Update

Body parameter

{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TemplateDto	false	none

Example responses

200 Response

{"name":"string","mjml":"string","default":true,"id":0}

{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateDto

Get all no default Email Templates

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/Template/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/Template/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/Template/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/Template/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/Template/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/Template/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/Template/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/Template/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/Template/GetAll

Parameters

Name	In	Type	Required	Description
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none
Sorting	query	string	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"name":"string","mjml":"string","default":true,"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "mjml": "string",
      "default": true,
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateDtoPagedResultDto

TemplateConfiguration

Delete an email template configuration

Code samples

# You can also use wget
curl -X DELETE https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete \
  -H 'Authorization: API_KEY'

DELETE https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete HTTP/1.1
Host: atenea.api.dative.cloud


const headers = {
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('DELETE','https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/services/app/TemplateConfiguration/Delete

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get an email template configuration

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Get", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/TemplateConfiguration/Get

Parameters

Name	In	Type	Required	Description
Id	query	integer(int32)	false	none

Example responses

200 Response

{"name":"string","subject":"string","properties":"string","default":true,"id":0}

{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateConfigurationDto

Update an email template configuration

Code samples

# You can also use wget
curl -X PUT https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

PUT https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.put('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('PUT','https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/services/app/TemplateConfiguration/Update

Body parameter

{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TemplateConfigurationDto	false	none

Example responses

200 Response

{"name":"string","subject":"string","properties":"string","default":true,"id":0}

{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateConfigurationDto

Create an email template configuration

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/Create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/TemplateConfiguration/Create

Body parameter

{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TemplateConfigurationDto	false	none

Example responses

200 Response

{"name":"string","subject":"string","properties":"string","default":true,"id":0}

{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateConfigurationDto

Get all template's configurations available in account

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/TemplateConfiguration/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/TemplateConfiguration/GetAll

Parameters

Name	In	Type	Required	Description
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none
Sorting	query	string	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"name":"string","subject":"string","properties":"string","default":true,"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "subject": "string",
      "properties": "string",
      "default": true,
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateConfigurationDtoPagedResultDto

TokenAuth

Authenticate

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/TokenAuth/Authenticate \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain'

POST https://atenea.api.dative.cloud/api/TokenAuth/Authenticate HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "userNameOrEmailAddress": "string",
  "password": "string",
  "rememberClient": true
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain'
};

fetch('https://atenea.api.dative.cloud/api/TokenAuth/Authenticate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/TokenAuth/Authenticate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain'
}

r = requests.post('https://atenea.api.dative.cloud/api/TokenAuth/Authenticate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/TokenAuth/Authenticate', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/TokenAuth/Authenticate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/TokenAuth/Authenticate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/TokenAuth/Authenticate

Remember to include in the header Request the param abp-tenantid with your tenantId

Body parameter

{
  "userNameOrEmailAddress": "string",
  "password": "string",
  "rememberClient": true
}

Parameters

Name	In	Type	Required	Description
body	body	AuthenticateModel	false	none

Example responses

200 Response

{"accessToken":"string","encryptedAccessToken":"string","expireInSeconds":0,"userId":0}

{
  "accessToken": "string",
  "encryptedAccessToken": "string",
  "expireInSeconds": 0,
  "userId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	AuthenticateResultModel

User

Create User

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/User/Create \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/User/Create HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/Create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/User/Create',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/User/Create', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/User/Create', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/Create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/User/Create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/User/Create

Body parameter

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateUserDto	false	none

Example responses

200 Response

{"userName":"string","name":"string","surname":"string","emailAddress":"user@example.com","isActive":true,"fullName":"string","lastLoginTime":"2019-08-24T14:15:22Z","creationTime":"2019-08-24T14:15:22Z","roleNames":["string"],"organizationUnitId":[0],"id":0}

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "fullName": "string",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "creationTime": "2019-08-24T14:15:22Z",
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	UserDto

Edit User

Code samples

# You can also use wget
curl -X PUT https://atenea.api.dative.cloud/api/services/app/User/Update \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

PUT https://atenea.api.dative.cloud/api/services/app/User/Update HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "fullName": "string",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "creationTime": "2019-08-24T14:15:22Z",
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/Update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://atenea.api.dative.cloud/api/services/app/User/Update',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.put('https://atenea.api.dative.cloud/api/services/app/User/Update', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('PUT','https://atenea.api.dative.cloud/api/services/app/User/Update', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/Update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://atenea.api.dative.cloud/api/services/app/User/Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/services/app/User/Update

Body parameter

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "fullName": "string",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "creationTime": "2019-08-24T14:15:22Z",
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	UserDto	false	none

Example responses

200 Response

{"userName":"string","name":"string","surname":"string","emailAddress":"user@example.com","isActive":true,"fullName":"string","lastLoginTime":"2019-08-24T14:15:22Z","creationTime":"2019-08-24T14:15:22Z","roleNames":["string"],"organizationUnitId":[0],"id":0}

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "fullName": "string",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "creationTime": "2019-08-24T14:15:22Z",
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	UserDto

Delete User

Code samples

# You can also use wget
curl -X DELETE https://atenea.api.dative.cloud/api/services/app/User/Delete \
  -H 'Authorization: API_KEY'

DELETE https://atenea.api.dative.cloud/api/services/app/User/Delete HTTP/1.1
Host: atenea.api.dative.cloud


const headers = {
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/Delete',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://atenea.api.dative.cloud/api/services/app/User/Delete',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete('https://atenea.api.dative.cloud/api/services/app/User/Delete', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('DELETE','https://atenea.api.dative.cloud/api/services/app/User/Delete', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/Delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://atenea.api.dative.cloud/api/services/app/User/Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/services/app/User/Delete

Parameters

Name	In	Type	Required	Description
Id	query	integer(int64)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Activate User

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/User/Activate \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/User/Activate HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json

const inputBody = '{
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/Activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/User/Activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/User/Activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/User/Activate', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/Activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/User/Activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/User/Activate

Body parameter

{
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	Int64EntityDto	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Deactivate User

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/User/DeActivate \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/User/DeActivate HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json

const inputBody = '{
  "id": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/DeActivate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/User/DeActivate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/User/DeActivate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/User/DeActivate', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/DeActivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/User/DeActivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/User/DeActivate

Body parameter

{
  "id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	Int64EntityDto	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Change Language

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json

const inputBody = '{
  "languageName": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/User/ChangeLanguage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/User/ChangeLanguage

Body parameter

{
  "languageName": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ChangeUserLanguageDto	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get User

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/User/Get \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/User/Get HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/Get',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/User/Get',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/User/Get', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/User/Get', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/Get");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/User/Get", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/User/Get

Parameters

Name	In	Type	Required	Description
Id	query	integer(int64)	false	none

Example responses

200 Response

{"userName":"string","name":"string","surname":"string","emailAddress":"user@example.com","isActive":true,"fullName":"string","lastLoginTime":"2019-08-24T14:15:22Z","creationTime":"2019-08-24T14:15:22Z","roleNames":["string"],"organizationUnitId":[0],"id":0}

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "fullName": "string",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "creationTime": "2019-08-24T14:15:22Z",
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	UserDto

Get All Users

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/User/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/User/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/User/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/User/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/User/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/User/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/User/GetAll

Parameters

Name	In	Type	Required	Description
Keyword	query	string	false	none
IsActive	query	boolean	false	none
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"userName":"string","name":"string","surname":"string","emailAddress":"user@example.com","isActive":true,"fullName":"string","lastLoginTime":"2019-08-24T14:15:22Z","creationTime":"2019-08-24T14:15:22Z","roleNames":["string"],"organizationUnitId":[0],"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "userName": "string",
      "name": "string",
      "surname": "string",
      "emailAddress": "user@example.com",
      "isActive": true,
      "fullName": "string",
      "lastLoginTime": "2019-08-24T14:15:22Z",
      "creationTime": "2019-08-24T14:15:22Z",
      "roleNames": [
        "string"
      ],
      "organizationUnitId": [
        0
      ],
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	UserDtoPagedResultDto

Change User Password

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/User/ChangePassword \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/User/ChangePassword HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "currentPassword": "string",
  "newPassword": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/ChangePassword',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/User/ChangePassword',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/User/ChangePassword', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/User/ChangePassword', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/ChangePassword");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/User/ChangePassword", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/User/ChangePassword

Body parameter

{
  "currentPassword": "string",
  "newPassword": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ChangePasswordDto	false	none

Example responses

200 Response

true

true

Responses

Status	Meaning	Description	Schema
200	OK	Success	boolean

Reset User Password

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/User/ResetPassword \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/User/ResetPassword HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "adminPassword": "string",
  "userId": 0,
  "newPassword": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/User/ResetPassword',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/User/ResetPassword',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/User/ResetPassword', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/User/ResetPassword', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/User/ResetPassword");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/User/ResetPassword", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/User/ResetPassword

Body parameter

{
  "adminPassword": "string",
  "userId": 0,
  "newPassword": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ResetPasswordDto	false	none

Example responses

200 Response

true

true

Responses

Status	Meaning	Description	Schema
200	OK	Success	boolean

VoucherService

Create Single Request MultiVoucher

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "email": "string",
  "phone": "string",
  "sendingMethod": 0,
  "fullName": "string",
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateSingleRequestMultiVoucher", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/VoucherService/CreateSingleRequestMultiVoucher

Body parameter

{
  "email": "string",
  "phone": "string",
  "sendingMethod": 0,
  "fullName": "string",
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	SingleRequestMultiVoucherInputDto	false	none

Example responses

200 Response

{"status":0,"sendingMethod":0,"email":"string","phone":"string","fullName":"string","voucherId":0,"campaignId":0,"bulkProcessId":0,"tenantId":0,"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","campaign":{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"campaignBudget":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0},"extensionData":"string","organizationUnitId":0,"id":0},"voucher":{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","campaignId":0,"code":"string","status":0,"isSandBox":true,"expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","campaign":{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"campaignBudget":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":null,"symbol":null,"code":null,"id":null},"id":0},"extensionData":"string","organizationUnitId":0,"id":0},"tenantId":0,"extensionData":"string","organizationUnitId":0,"id":0},"bulkProcess":{"name":"string","description":"string","status":0,"campaignId":0,"campaign":{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"campaignBudget":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":null,"symbol":null,"code":null,"id":null},"id":0},"extensionData":"string","organizationUnitId":0,"id":0},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"extensionData":"string","quantity":0,"vouchersGenerated":0,"id":0},"organizationUnitId":0,"id":0}

{
  "status": 0,
  "sendingMethod": 0,
  "email": "string",
  "phone": "string",
  "fullName": "string",
  "voucherId": 0,
  "campaignId": 0,
  "bulkProcessId": 0,
  "tenantId": 0,
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "voucher": {
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "campaignId": 0,
    "code": "string",
    "status": 0,
    "isSandBox": true,
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "campaign": {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "campaignBudget": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": null,
          "symbol": null,
          "code": null,
          "id": null
        },
        "id": 0
      },
      "extensionData": "string",
      "organizationUnitId": 0,
      "id": 0
    },
    "tenantId": 0,
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "bulkProcess": {
    "name": "string",
    "description": "string",
    "status": 0,
    "campaignId": 0,
    "campaign": {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "campaignBudget": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": null,
          "symbol": null,
          "code": null,
          "id": null
        },
        "id": 0
      },
      "extensionData": "string",
      "organizationUnitId": 0,
      "id": 0
    },
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "extensionData": "string",
    "quantity": 0,
    "vouchersGenerated": 0,
    "id": 0
  },
  "organizationUnitId": 0,
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	VoucherRequest

Create MultiVoucher and Get Guid and Redeem landing Url

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/VoucherService/CreateMultiVoucherAndGetUrl", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/VoucherService/CreateMultiVoucherAndGetUrl

Body parameter

{
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	MultiVoucherUrlDto	false	none

Example responses

200 Response

{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","redeemUrl":"string","voucherGuid":"79bf5cd0-f72a-4724-a3cb-49f58d54ba5b"}

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "redeemUrl": "string",
  "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b"
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	SelectedVoucher

Redeem Voucher Code

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "multiVoucherGuid": "5e13f9a0-9962-4641-93c0-0c2cfa11ef10",
  "multiRedeem": true,
  "address": {
    "email": "string",
    "postalAddress": {
      "deliverTo": "string",
      "street": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "phone": {
      "countryCode": 0,
      "number": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/VoucherService/RedeemCodeFromMultiVoucher", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/VoucherService/RedeemCodeFromMultiVoucher

Body parameter

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "multiVoucherGuid": "5e13f9a0-9962-4641-93c0-0c2cfa11ef10",
  "multiRedeem": true,
  "address": {
    "email": "string",
    "postalAddress": {
      "deliverTo": "string",
      "street": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "phone": {
      "countryCode": 0,
      "number": "string"
    }
  }
}

Parameters

Name	In	Type	Required	Description
body	body	RedeemCodeWithMultiVoucherInputDto	false	none

Example responses

200 Response

{"code":"string","voucherTypeId":0,"voucherProviderId":0,"state":0,"amount":0,"isSandBox":true,"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","extensionData":"string","id":0}

{
  "code": "string",
  "voucherTypeId": 0,
  "voucherProviderId": 0,
  "state": 0,
  "amount": 0,
  "isSandBox": true,
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "extensionData": "string",
  "id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	VoucherCode

Get Voucher Informations

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherInfo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/VoucherService/GetVoucherInfo

Parameters

Name	In	Type	Required	Description
guid	query	string(uuid)	false	none
id	query	integer(int32)	false	none

Example responses

200 Response

{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","totalAmount":0,"billable":true,"status":0,"voucherRequestStatus":0,"fullName":"string","email":"string","campaignId":0,"vouchers":[{"amount":0,"code":"string","creationTime":"string","guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","id":0,"lastModificationTime":"string","status":0,"amzProducts":[{"name":"string","imageUrl":"string","asin":"string","offerId":"string","unitPrice":0,"currencyCode":"string"}],"giftCardNormalizedData":{"code":"string","voucherLink":"string","expiryDate":"string","pin":"string","amzProduct":[{"name":null,"imageUrl":null,"asin":null,"offerId":null,"unitPrice":null,"currencyCode":null}]},"voucherType":{"title":"string","countryCode":"string","countryName":"string","countryId":0,"description":"string","amounts":"string","currency":"string","currencyId":0,"logo":"string","cardImage":"string","notes":"string","category":"string","validity":"string","cumulable":"string","spendMultipleTimes":"string","ideaShopping":"string","multipurpose":"string","singleService":"string","whereToRedeem":"string","info":"string","termsAndConditions":"string","stockVouchers":true,"voucherProviderTypes":[{"voucherProviderId":null,"voucherProvider":null,"voucherTypeId":null,"voucherType":null,"creatorUserId":null,"creationTime":null,"lastModifierUserId":null,"lastModificationTime":null,"id":null}],"voucherTypeCategoryId":0,"currencyFK":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{},"id":0},"voucherTypeCategory":{"name":"string","id":0},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","id":0}}]}

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "totalAmount": 0,
  "billable": true,
  "status": 0,
  "voucherRequestStatus": 0,
  "fullName": "string",
  "email": "string",
  "campaignId": 0,
  "vouchers": [
    {
      "amount": 0,
      "code": "string",
      "creationTime": "string",
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "id": 0,
      "lastModificationTime": "string",
      "status": 0,
      "amzProducts": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ],
      "giftCardNormalizedData": {
        "code": "string",
        "voucherLink": "string",
        "expiryDate": "string",
        "pin": "string",
        "amzProduct": [
          {
            "name": null,
            "imageUrl": null,
            "asin": null,
            "offerId": null,
            "unitPrice": null,
            "currencyCode": null
          }
        ]
      },
      "voucherType": {
        "title": "string",
        "countryCode": "string",
        "countryName": "string",
        "countryId": 0,
        "description": "string",
        "amounts": "string",
        "currency": "string",
        "currencyId": 0,
        "logo": "string",
        "cardImage": "string",
        "notes": "string",
        "category": "string",
        "validity": "string",
        "cumulable": "string",
        "spendMultipleTimes": "string",
        "ideaShopping": "string",
        "multipurpose": "string",
        "singleService": "string",
        "whereToRedeem": "string",
        "info": "string",
        "termsAndConditions": "string",
        "stockVouchers": true,
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "voucherTypeCategoryId": 0,
        "currencyFK": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "country": {
          "name": "string",
          "code": "string",
          "currencyId": 0,
          "currency": {},
          "id": 0
        },
        "voucherTypeCategory": {
          "name": "string",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	VoucherDto

Trigger Single Request

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json

const inputBody = '{
  "requestId": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/VoucherService/TriggerSingleRequest", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/VoucherService/TriggerSingleRequest

Body parameter

{
  "requestId": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TriggerSingleRequestDto	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get Vouchers Requests

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVoucherRequests", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/VoucherService/GetVoucherRequests

Parameters

Name	In	Type	Required	Description
bulkProcessId	query	integer(int32)	false	none
campaignId	query	integer(int32)	false	none
Sorting	query	string	false	none
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"status":0,"sendingMethod":0,"email":"string","phone":"string","fullName":"string","voucherId":0,"voucherGuid":"79bf5cd0-f72a-4724-a3cb-49f58d54ba5b","bulkProcessId":0,"campaignId":0,"creationTime":"2019-08-24T14:15:22Z","lastModificationTime":"2019-08-24T14:15:22Z","multiVoucherData":[{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","voucherTypeId":0,"code":"string","status":0,"amount":0,"id":0}],"organizationUnitId":0,"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "status": 0,
      "sendingMethod": 0,
      "email": "string",
      "phone": "string",
      "fullName": "string",
      "voucherId": 0,
      "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b",
      "bulkProcessId": 0,
      "campaignId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "multiVoucherData": [
        {
          "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
          "voucherTypeId": 0,
          "code": "string",
          "status": 0,
          "amount": 0,
          "id": 0
        }
      ],
      "organizationUnitId": 0,
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	VoucherRequestDtoPagedResultDto

Get generated Vouchers list

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/VoucherService/GetVouchers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/VoucherService/GetVouchers

Parameters

Name	In	Type	Required	Description
CampaignId	query	integer(int32)	false	none
StartDate	query	string(date-time)	false	none
EndDate	query	string(date-time)	false	none

Example responses

200 Response

[{"guid":"ee6a7af7-650d-499b-8e32-58a52ffdb7bc","campaignId":0,"code":"string","status":0,"isSandBox":true,"expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","campaign":{"name":"string","currencyId":0,"countryId":0,"templateId":0,"templateConfigurationId":0,"landingConfigurationId":0,"campaignBudget":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","tenantId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{"name":"string","symbol":"string","code":"string","id":0},"id":0},"extensionData":"string","organizationUnitId":0,"id":0},"tenantId":0,"extensionData":"string","organizationUnitId":0,"id":0}]

[
  {
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "campaignId": 0,
    "code": "string",
    "status": 0,
    "isSandBox": true,
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "campaign": {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "campaignBudget": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "id": 0
      },
      "extensionData": "string",
      "organizationUnitId": 0,
      "id": 0
    },
    "tenantId": 0,
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Voucher]	false	none	none
» guid	string(uuid)	true	none	none
» campaignId	integer(int32)	true	none	none
» code	string¦null	false	none	none
» status	VoucherStatus(int32)	true	none	none
» isSandBox	boolean	true	none	none
» expirationDate	string(date-time)¦null	false	none	none
» creatorUserId	integer(int64)¦null	false	none	none
» creationTime	string(date-time)	false	none	none
» lastModifierUserId	integer(int64)¦null	false	none	none
» lastModificationTime	string(date-time)¦null	false	none	none
» campaign	Campaign	false	none	none
»» name	string	true	none	none
»» currencyId	integer(int32)	true	none	none
»» countryId	integer(int32)	false	none	none
»» templateId	integer(int32)¦null	false	none	none
»» templateConfigurationId	integer(int32)¦null	false	none	none
»» landingConfigurationId	integer(int32)	false	none	none
»» campaignBudget	number(double)	true	none	none
»» startDate	string(date-time)	true	none	none
»» endDate	string(date-time)¦null	false	none	none
»» expirationDate	string(date-time)¦null	false	none	none
»» creatorUserId	integer(int64)¦null	false	none	none
»» creationTime	string(date-time)	false	none	none
»» lastModifierUserId	integer(int64)¦null	false	none	none
»» lastModificationTime	string(date-time)¦null	false	none	none
»» tenantId	integer(int32)	false	none	none
»» currency	Currency	false	none	none
»»» name	string	true	none	none
»»» symbol	string¦null	false	none	none
»»» code	string¦null	false	none	none
»»» id	integer(int32)	false	none	none
»» country	Country	false	none	none
»»» name	string	true	none	none
»»» code	string¦null	false	none	none
»»» currencyId	integer(int32)	false	none	none
»»» currency	Currency	false	none	none
»»» id	integer(int32)	false	none	none
»» extensionData	string¦null	false	none	none
»» organizationUnitId	integer(int64)¦null	false	none	none
»» id	integer(int32)	false	none	none
» tenantId	integer(int32)	false	none	none
» extensionData	string¦null	false	none	none
» organizationUnitId	integer(int64)¦null	false	none	none
» id	integer(int32)	false	none	none

Enumerated Values

Property	Value
status	0
status	1
status	2
status	3
status	4
status	5

Search Amazon Products

Code samples

# You can also use wget
curl -X POST https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

POST https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts HTTP/1.1
Host: atenea.api.dative.cloud
Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "keywords": "string",
  "productRegion": "string",
  "locale": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.post('https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://atenea.api.dative.cloud/api/services/app/VoucherService/SearchAWSProducts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/services/app/VoucherService/SearchAWSProducts

Body parameter

{
  "keywords": "string",
  "productRegion": "string",
  "locale": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SearchAWSProductsRequestDto	false	none

Example responses

200 Response

[{"name":"string","imageUrl":"string","asin":"string","offerId":"string","unitPrice":0,"currencyCode":"string"}]

[
  {
    "name": "string",
    "imageUrl": "string",
    "asin": "string",
    "offerId": "string",
    "unitPrice": 0,
    "currencyCode": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AmazonDirectOrderProduct]	false	none	none
» name	string¦null	false	none	none
» imageUrl	string¦null	false	none	none
» asin	string¦null	false	none	none
» offerId	string¦null	false	none	none
» unitPrice	number(double)	false	none	none
» currencyCode	string¦null	false	none	none

VoucherTypeTenant

Get all voucher types available in account

Code samples

# You can also use wget
curl -X GET https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll \
  -H 'Accept: text/plain' \
  -H 'Authorization: API_KEY'

GET https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll HTTP/1.1
Host: atenea.api.dative.cloud
Accept: text/plain


const headers = {
  'Accept':'text/plain',
  'Authorization':'API_KEY'
};

fetch('https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'API_KEY'
}

r = requests.get('https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll', 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());
 }

 // ...

URL obj = new URL("https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://atenea.api.dative.cloud/api/services/app/VoucherTypeTenant/GetAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/services/app/VoucherTypeTenant/GetAll

Parameters

Name	In	Type	Required	Description
isActive	query	integer(int32)	false	none
Keyword	query	string	false	none
CountryId	query	integer(int32)	false	none
CategoryId	query	integer(int32)	false	none
Sorting	query	string	false	none
SkipCount	query	integer(int32)	false	none
MaxResultCount	query	integer(int32)	false	none

Example responses

200 Response

{"totalCount":0,"items":[{"voucherTypeId":0,"active":true,"tenantId":0,"voucherType":{"title":"string","countryCode":"string","countryName":"string","countryId":0,"description":"string","amounts":"string","currency":"string","currencyId":0,"logo":"string","cardImage":"string","notes":"string","category":"string","validity":"string","cumulable":"string","spendMultipleTimes":"string","ideaShopping":"string","multipurpose":"string","singleService":"string","whereToRedeem":"string","info":"string","termsAndConditions":"string","stockVouchers":true,"voucherProviderTypes":[{"voucherProviderId":null,"voucherProvider":null,"voucherTypeId":null,"voucherType":null,"creatorUserId":null,"creationTime":null,"lastModifierUserId":null,"lastModificationTime":null,"id":null}],"voucherTypeCategoryId":0,"currencyFK":{"name":"string","symbol":"string","code":"string","id":0},"country":{"name":"string","code":"string","currencyId":0,"currency":{},"id":0},"voucherTypeCategory":{"name":"string","id":0},"creatorUserId":0,"creationTime":"2019-08-24T14:15:22Z","lastModifierUserId":0,"lastModificationTime":"2019-08-24T14:15:22Z","id":0},"id":0}]}

{
  "totalCount": 0,
  "items": [
    {
      "voucherTypeId": 0,
      "active": true,
      "tenantId": 0,
      "voucherType": {
        "title": "string",
        "countryCode": "string",
        "countryName": "string",
        "countryId": 0,
        "description": "string",
        "amounts": "string",
        "currency": "string",
        "currencyId": 0,
        "logo": "string",
        "cardImage": "string",
        "notes": "string",
        "category": "string",
        "validity": "string",
        "cumulable": "string",
        "spendMultipleTimes": "string",
        "ideaShopping": "string",
        "multipurpose": "string",
        "singleService": "string",
        "whereToRedeem": "string",
        "info": "string",
        "termsAndConditions": "string",
        "stockVouchers": true,
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "voucherTypeCategoryId": 0,
        "currencyFK": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "country": {
          "name": "string",
          "code": "string",
          "currencyId": 0,
          "currency": {},
          "id": 0
        },
        "voucherTypeCategory": {
          "name": "string",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      },
      "id": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	VoucherTypeTenantDtoPagedResultDto

Schemas

IsTenantAvailableInput

{
  "tenancyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
tenancyName	string	true	none	none

TenantAvailabilityState

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	1
anonymous	2
anonymous	3

IsTenantAvailableOutput

{
  "state": 1,
  "tenantId": 0
}

Properties

Name	Type	Required	Restrictions	Description
state	TenantAvailabilityState	false	none	none
tenantId	integer(int32)¦null	false	none	none

AccountConfigDto

{
  "contactName": "string",
  "contactSurName": "string",
  "contactEmail": "string",
  "transactionPrefix": "string",
  "extensionData": "string",
  "tenantId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
contactName	string¦null	false	none	none
contactSurName	string¦null	false	none	none
contactEmail	string¦null	false	none	none
transactionPrefix	string¦null	false	none	none
extensionData	string¦null	false	none	none
tenantId	integer(int32)	false	none	none
id	integer(int32)	false	none	none

VoucherProvider

{
  "name": "string",
  "voucherProviderTypes": [
    {
      "voucherProviderId": 0,
      "voucherProvider": {
        "name": "string",
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      },
      "voucherTypeId": 0,
      "voucherType": {
        "title": "string",
        "countryCode": "string",
        "countryName": "string",
        "countryId": 0,
        "description": "string",
        "amounts": "string",
        "currency": "string",
        "currencyId": 0,
        "logo": "string",
        "cardImage": "string",
        "notes": "string",
        "category": "string",
        "validity": "string",
        "cumulable": "string",
        "spendMultipleTimes": "string",
        "ideaShopping": "string",
        "multipurpose": "string",
        "singleService": "string",
        "whereToRedeem": "string",
        "info": "string",
        "termsAndConditions": "string",
        "stockVouchers": true,
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "voucherTypeCategoryId": 0,
        "currencyFK": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "country": {
          "name": "string",
          "code": "string",
          "currencyId": 0,
          "currency": {},
          "id": 0
        },
        "voucherTypeCategory": {
          "name": "string",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      },
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ],
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
voucherProviderTypes	[VoucherProviderType]¦null	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
id	integer(int32)	false	none	none

VoucherProviderType

{
  "voucherProviderId": 0,
  "voucherProvider": {
    "name": "string",
    "voucherProviderTypes": [
      {
        "voucherProviderId": 0,
        "voucherProvider": {
          "name": "string",
          "voucherProviderTypes": [
            null
          ],
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "voucherTypeId": 0,
        "voucherType": {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            null
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {},
          "country": {},
          "voucherTypeCategory": {},
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    ],
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "id": 0
  },
  "voucherTypeId": 0,
  "voucherType": {
    "title": "string",
    "countryCode": "string",
    "countryName": "string",
    "countryId": 0,
    "description": "string",
    "amounts": "string",
    "currency": "string",
    "currencyId": 0,
    "logo": "string",
    "cardImage": "string",
    "notes": "string",
    "category": "string",
    "validity": "string",
    "cumulable": "string",
    "spendMultipleTimes": "string",
    "ideaShopping": "string",
    "multipurpose": "string",
    "singleService": "string",
    "whereToRedeem": "string",
    "info": "string",
    "termsAndConditions": "string",
    "stockVouchers": true,
    "voucherProviderTypes": [
      {
        "voucherProviderId": 0,
        "voucherProvider": {
          "name": "string",
          "voucherProviderTypes": [
            null
          ],
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "voucherTypeId": 0,
        "voucherType": {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            null
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {},
          "country": {},
          "voucherTypeCategory": {},
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    ],
    "voucherTypeCategoryId": 0,
    "currencyFK": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "voucherTypeCategory": {
      "name": "string",
      "id": 0
    },
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "id": 0
  },
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
voucherProviderId	integer(int32)	false	none	none
voucherProvider	VoucherProvider	false	none	none
voucherTypeId	integer(int32)	false	none	none
voucherType	VoucherType	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
id	integer(int32)	false	none	none

Currency

{
  "name": "string",
  "symbol": "string",
  "code": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
symbol	string¦null	false	none	none
code	string¦null	false	none	none
id	integer(int32)	false	none	none

Country

{
  "name": "string",
  "code": "string",
  "currencyId": 0,
  "currency": {
    "name": "string",
    "symbol": "string",
    "code": "string",
    "id": 0
  },
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
code	string¦null	false	none	none
currencyId	integer(int32)	false	none	none
currency	Currency	false	none	none
id	integer(int32)	false	none	none

VoucherTypeCategory

{
  "name": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
id	integer(int32)	false	none	none

VoucherType

{
  "title": "string",
  "countryCode": "string",
  "countryName": "string",
  "countryId": 0,
  "description": "string",
  "amounts": "string",
  "currency": "string",
  "currencyId": 0,
  "logo": "string",
  "cardImage": "string",
  "notes": "string",
  "category": "string",
  "validity": "string",
  "cumulable": "string",
  "spendMultipleTimes": "string",
  "ideaShopping": "string",
  "multipurpose": "string",
  "singleService": "string",
  "whereToRedeem": "string",
  "info": "string",
  "termsAndConditions": "string",
  "stockVouchers": true,
  "voucherProviderTypes": [
    {
      "voucherProviderId": 0,
      "voucherProvider": {
        "name": "string",
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      },
      "voucherTypeId": 0,
      "voucherType": {
        "title": "string",
        "countryCode": "string",
        "countryName": "string",
        "countryId": 0,
        "description": "string",
        "amounts": "string",
        "currency": "string",
        "currencyId": 0,
        "logo": "string",
        "cardImage": "string",
        "notes": "string",
        "category": "string",
        "validity": "string",
        "cumulable": "string",
        "spendMultipleTimes": "string",
        "ideaShopping": "string",
        "multipurpose": "string",
        "singleService": "string",
        "whereToRedeem": "string",
        "info": "string",
        "termsAndConditions": "string",
        "stockVouchers": true,
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "voucherTypeCategoryId": 0,
        "currencyFK": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "country": {
          "name": "string",
          "code": "string",
          "currencyId": 0,
          "currency": {},
          "id": 0
        },
        "voucherTypeCategory": {
          "name": "string",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      },
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ],
  "voucherTypeCategoryId": 0,
  "currencyFK": {
    "name": "string",
    "symbol": "string",
    "code": "string",
    "id": 0
  },
  "country": {
    "name": "string",
    "code": "string",
    "currencyId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "id": 0
  },
  "voucherTypeCategory": {
    "name": "string",
    "id": 0
  },
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	none
countryCode	string¦null	false	none	none
countryName	string¦null	false	none	none
countryId	integer(int32)	false	none	none
description	string¦null	false	none	none
amounts	string¦null	false	none	none
currency	string¦null	false	none	none
currencyId	integer(int32)	false	none	none
logo	string¦null	false	none	none
cardImage	string¦null	false	none	none
notes	string¦null	false	none	none
category	string¦null	false	none	none
validity	string¦null	false	none	none
cumulable	string¦null	false	none	none
spendMultipleTimes	string¦null	false	none	none
ideaShopping	string¦null	false	none	none
multipurpose	string¦null	false	none	none
singleService	string¦null	false	none	none
whereToRedeem	string¦null	false	none	none
info	string¦null	false	none	none
termsAndConditions	string¦null	false	none	none
stockVouchers	boolean	false	none	none
voucherProviderTypes	[VoucherProviderType]¦null	false	none	none
voucherTypeCategoryId	integer(int32)	false	none	none
currencyFK	Currency	false	none	none
country	Country	false	none	none
voucherTypeCategory	VoucherTypeCategory	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
id	integer(int32)	false	none	none

ActiveVoucherWithBudgetDto

{
  "voucherType": {
    "title": "string",
    "countryCode": "string",
    "countryName": "string",
    "countryId": 0,
    "description": "string",
    "amounts": "string",
    "currency": "string",
    "currencyId": 0,
    "logo": "string",
    "cardImage": "string",
    "notes": "string",
    "category": "string",
    "validity": "string",
    "cumulable": "string",
    "spendMultipleTimes": "string",
    "ideaShopping": "string",
    "multipurpose": "string",
    "singleService": "string",
    "whereToRedeem": "string",
    "info": "string",
    "termsAndConditions": "string",
    "stockVouchers": true,
    "voucherProviderTypes": [
      {
        "voucherProviderId": 0,
        "voucherProvider": {
          "name": "string",
          "voucherProviderTypes": [
            null
          ],
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "voucherTypeId": 0,
        "voucherType": {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            null
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {},
          "country": {},
          "voucherTypeCategory": {},
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    ],
    "voucherTypeCategoryId": 0,
    "currencyFK": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "voucherTypeCategory": {
      "name": "string",
      "id": 0
    },
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "id": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
voucherType	VoucherType	false	none	none

AccountConfigDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "contactName": "string",
      "contactSurName": "string",
      "contactEmail": "string",
      "transactionPrefix": "string",
      "extensionData": "string",
      "tenantId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[AccountConfigDto]¦null	false	none	none

VoucherMetrics

{
  "vouchersGenerated": 0,
  "redeemVouchers": 0,
  "refundedVouchers": 0,
  "vouchersGeneratedTotalAmount": 0,
  "refundedVouchersTotalAmount": 0,
  "redeemVouchersTotalAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
vouchersGenerated	integer(int32)	false	none	none
redeemVouchers	integer(int32)	false	none	none
refundedVouchers	integer(int32)	false	none	none
vouchersGeneratedTotalAmount	number(double)	false	none	none
refundedVouchersTotalAmount	number(double)	false	none	none
redeemVouchersTotalAmount	number(double)	false	none	none

VoucherActivityByDateDto

{
  "date": "2019-08-24T14:15:22Z",
  "voucherMetrics": {
    "vouchersGenerated": 0,
    "redeemVouchers": 0,
    "refundedVouchers": 0,
    "vouchersGeneratedTotalAmount": 0,
    "refundedVouchersTotalAmount": 0,
    "redeemVouchersTotalAmount": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	none
voucherMetrics	VoucherMetrics	false	none	none

VoucherActivityTransactionsDto

{
  "name": "string",
  "quantity": 0,
  "value": 0,
  "blockedAmount": 0,
  "blocked": 0,
  "redeemedAmount": 0,
  "redeemed": 0,
  "refundAmount": 0,
  "refund": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
quantity	integer(int32)	false	none	none
value	number(double)	false	none	none
blockedAmount	number(double)	false	none	none
blocked	integer(int32)	false	none	none
redeemedAmount	number(double)	false	none	none
redeemed	integer(int32)	false	none	none
refundAmount	number(double)	false	none	none
refund	integer(int32)	false	none	none

AccountGeneralMetricsDto

{
  "totalBalance": 0,
  "bugdgetAllocatedInCampaigns": 0,
  "vouchersGenerated": 0,
  "redeemVouchers": 0,
  "refundedVouchers": 0,
  "budgetSpent": 0,
  "refundedVouchersTotalAmount": 0,
  "redeemVouchersTotalAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
totalBalance	number(double)	false	none	none
bugdgetAllocatedInCampaigns	number(double)	false	none	none
vouchersGenerated	integer(int32)	false	none	none
redeemVouchers	integer(int32)	false	none	none
refundedVouchers	integer(int32)	false	none	none
budgetSpent	number(double)	false	none	none
refundedVouchersTotalAmount	number(double)	false	none	none
redeemVouchersTotalAmount	number(double)	false	none	none

AmazonExternalAccountDto

{
  "name": "string",
  "identity": "string",
  "sharedSecret": "string",
  "email": "string",
  "region": "string",
  "country": "string",
  "url": "string",
  "isActive": true,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
identity	string¦null	false	none	none
sharedSecret	string¦null	false	none	none
email	string¦null	false	none	none
region	string¦null	false	none	none
country	string¦null	false	none	none
url	string¦null	false	none	none
isActive	boolean	false	none	none
id	integer(int32)	false	none	none

AmazonExternalAccountDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "identity": "string",
      "sharedSecret": "string",
      "email": "string",
      "region": "string",
      "country": "string",
      "url": "string",
      "isActive": true,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[AmazonExternalAccountDto]¦null	false	none	none

AmilonMailTemplateDto

{
  "name": "string",
  "mjml": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
mjml	string	true	none	none
id	integer(int32)	false	none	none

AmilonMailTemplateDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "mjml": "string",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[AmilonMailTemplateDto]¦null	false	none	none

ProductModel

{
  "productCode": "string",
  "currency": "string",
  "productType": "string",
  "merchantCode": "string",
  "merchantCountry": "string",
  "merchantCountryISOAlpha3": "string",
  "merchantName": "string",
  "merchantImageUrl": "string",
  "merchantShortDescription": "string",
  "merchantLongDescription": "string",
  "name": "string",
  "price": 0,
  "imageUrl": "string",
  "active": true,
  "visible": true,
  "art100": true
}

Properties

Name	Type	Required	Restrictions	Description
productCode	string¦null	false	none	none
currency	string¦null	false	none	none
productType	string¦null	false	none	none
merchantCode	string¦null	false	none	none
merchantCountry	string¦null	false	none	none
merchantCountryISOAlpha3	string¦null	false	none	none
merchantName	string¦null	false	none	none
merchantImageUrl	string¦null	false	none	none
merchantShortDescription	string¦null	false	none	none
merchantLongDescription	string¦null	false	none	none
name	string¦null	false	none	none
price	number(double)¦null	false	none	none
imageUrl	string¦null	false	none	none
active	boolean¦null	false	none	none
visible	boolean¦null	false	none	none
art100	boolean¦null	false	none	none

MiniumVouchersResponseDto

{
  "minimumVouchers": [
    {
      "productCode": "string",
      "currency": "string",
      "productType": "string",
      "merchantCode": "string",
      "merchantCountry": "string",
      "merchantCountryISOAlpha3": "string",
      "merchantName": "string",
      "merchantImageUrl": "string",
      "merchantShortDescription": "string",
      "merchantLongDescription": "string",
      "name": "string",
      "price": 0,
      "imageUrl": "string",
      "active": true,
      "visible": true,
      "art100": true
    }
  ],
  "success": true
}

Properties

Name	Type	Required	Restrictions	Description
minimumVouchers	[ProductModel]¦null	false	none	none
success	boolean	false	none	none

ContractInfoApiResponse

{
  "contractId": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "currentAmount": 0,
  "previousAmount": 0,
  "lastUpdate": "2019-08-24T14:15:22Z",
  "currencyIsoCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
contractId	string¦null	false	none	none
startDate	string(date-time)¦null	false	none	none
endDate	string(date-time)¦null	false	none	none
currentAmount	number(double)¦null	false	none	none
previousAmount	number(double)¦null	false	none	none
lastUpdate	string(date-time)¦null	false	none	none
currencyIsoCode	string¦null	false	none	none

RetailerInfoApiResponse

{
  "retailerId": "string",
  "name": "string",
  "country": "string",
  "countryISOAlpha3": "string",
  "region": "string",
  "county": "string",
  "city": "string",
  "address": "string",
  "zipCode": "string",
  "phone": "string",
  "email": "string",
  "shortDescription": "string",
  "longDescription": "string",
  "codeValidityMonths": 0,
  "imageUrl": "string",
  "retailerShopShowDetails": true,
  "retailerShopDetailsText": "string"
}

Properties

Name	Type	Required	Restrictions	Description
retailerId	string¦null	false	none	none
name	string¦null	false	none	none
country	string¦null	false	none	none
countryISOAlpha3	string¦null	false	none	none
region	string¦null	false	none	none
county	string¦null	false	none	none
city	string¦null	false	none	none
address	string¦null	false	none	none
zipCode	string¦null	false	none	none
phone	string¦null	false	none	none
email	string¦null	false	none	none
shortDescription	string¦null	false	none	none
longDescription	string¦null	false	none	none
codeValidityMonths	integer(int32)¦null	false	none	none
imageUrl	string¦null	false	none	none
retailerShopShowDetails	boolean¦null	false	none	none
retailerShopDetailsText	string¦null	false	none	none

VoucherApiResponse

{
  "voucherLink": "string",
  "validityStartDate": "2019-08-24T14:15:22Z",
  "validityEndDate": "2019-08-24T14:15:22Z",
  "productId": "string",
  "cardCode": "string",
  "pin": "string",
  "retailerId": "string",
  "retailerName": "string",
  "retailerCountry": "string",
  "retailerCountryISOAlpha3": "string",
  "name": "string",
  "surname": "string",
  "email": "string",
  "dedication": "string",
  "orderFrom": "string",
  "orderTo": "string",
  "amount": 0,
  "deleted": true
}

Properties

Name	Type	Required	Restrictions	Description
voucherLink	string¦null	false	none	none
validityStartDate	string(date-time)¦null	false	none	none
validityEndDate	string(date-time)¦null	false	none	none
productId	string¦null	false	none	none
cardCode	string¦null	false	none	none
pin	string¦null	false	none	none
retailerId	string¦null	false	none	none
retailerName	string¦null	false	none	none
retailerCountry	string¦null	false	none	none
retailerCountryISOAlpha3	string¦null	false	none	none
name	string¦null	false	none	none
surname	string¦null	false	none	none
email	string¦null	false	none	none
dedication	string¦null	false	none	none
orderFrom	string¦null	false	none	none
orderTo	string¦null	false	none	none
amount	number(double)¦null	false	none	none
deleted	boolean¦null	false	none	none

OrderInfoApiResponse

{
  "vouchers": [
    {
      "voucherLink": "string",
      "validityStartDate": "2019-08-24T14:15:22Z",
      "validityEndDate": "2019-08-24T14:15:22Z",
      "productId": "string",
      "cardCode": "string",
      "pin": "string",
      "retailerId": "string",
      "retailerName": "string",
      "retailerCountry": "string",
      "retailerCountryISOAlpha3": "string",
      "name": "string",
      "surname": "string",
      "email": "string",
      "dedication": "string",
      "orderFrom": "string",
      "orderTo": "string",
      "amount": 0,
      "deleted": true
    }
  ],
  "externalOrderId": "string",
  "orderDate": "2019-08-24T14:15:22Z",
  "grossAmount": 0,
  "netAmount": 0,
  "totalRequestedCodes": 0,
  "orderStatus": "string",
  "purchaseOrder": "string"
}

Properties

Name	Type	Required	Restrictions	Description
vouchers	[VoucherApiResponse]¦null	false	none	none
externalOrderId	string¦null	false	none	none
orderDate	string(date-time)¦null	false	none	none
grossAmount	number(double)¦null	false	none	none
netAmount	number(double)¦null	false	none	none
totalRequestedCodes	integer(int32)¦null	false	none	none
orderStatus	string¦null	false	none	none
purchaseOrder	string¦null	false	none	none

GetAmilonOrdersInputDto

{
  "orderIds": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
orderIds	[string]¦null	false	none	none

PDFResponse

{
  "codex": "string",
  "voucherLink": "string",
  "pin": "string",
  "expiryDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
codex	string¦null	false	none	none
voucherLink	string¦null	false	none	none
pin	string¦null	false	none	none
expiryDate	string¦null	false	none	none

AuthorizedJwtTokenDto

{
  "name": "string",
  "isActive": true,
  "token": "string",
  "expirationDate": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
isActive	boolean	true	none	none
token	string	true	none	none
expirationDate	string(date-time)	true	none	none
id	integer(int32)	false	none	none

AuthorizedJwtTokenDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "isActive": true,
      "token": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[AuthorizedJwtTokenDto]¦null	false	none	none

BalanceDto

{
  "accountIban": "string",
  "currencyId": 0,
  "amount": 0,
  "tenantId": 0,
  "bankTransanctionConceptRef": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
accountIban	string¦null	false	none	none
currencyId	integer(int32)	false	none	none
amount	number(double)¦null	false	none	none
tenantId	integer(int32)	false	none	none
bankTransanctionConceptRef	string¦null	false	none	none
id	integer(int32)	false	none	none

UpdateBalanceDto

{
  "accountIban": "string",
  "amount": 0,
  "bankTransanctionConceptRef": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
accountIban	string¦null	false	none	none
amount	number(double)¦null	false	none	none
bankTransanctionConceptRef	string¦null	false	none	none
id	integer(int32)	false	none	none

GetBalancesSingleDto

{
  "currencyId": 0,
  "balance": 0
}

Properties

Name	Type	Required	Restrictions	Description
currencyId	integer(int32)	false	none	none
balance	number(double)	false	none	none

GetBalancesDto

{
  "balances": [
    {
      "currencyId": 0,
      "balance": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
balances	[GetBalancesSingleDto]¦null	false	none	none

BalanceDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "accountIban": "string",
      "currencyId": 0,
      "amount": 0,
      "tenantId": 0,
      "bankTransanctionConceptRef": "string",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[BalanceDto]¦null	false	none	none

TransactionStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

BankTransactionDto

{
  "date": "2019-08-24T14:15:22Z",
  "amount": 0,
  "transactionUniqueIdentifier": "string",
  "iban": "string",
  "currencyId": 0,
  "status": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	none
amount	number(double)	false	none	none
transactionUniqueIdentifier	string¦null	false	none	none
iban	string¦null	false	none	none
currencyId	integer(int32)	false	none	none
status	TransactionStatus	false	none	none
id	integer(int32)	false	none	none

BankTransactionConfirmationDto

{
  "bankTransactionId": 0,
  "tenantId": 0
}

Properties

Name	Type	Required	Restrictions	Description
bankTransactionId	integer(int32)	false	none	none
tenantId	integer(int32)	false	none	none

BankTransaction

{
  "date": "2019-08-24T14:15:22Z",
  "amount": 0,
  "transactionUniqueIdentifier": "string",
  "iban": "string",
  "currencyId": 0,
  "status": 0,
  "tenantId": 0,
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	none
amount	number(double)	false	none	none
transactionUniqueIdentifier	string¦null	false	none	none
iban	string¦null	false	none	none
currencyId	integer(int32)	false	none	none
status	TransactionStatus	false	none	none
tenantId	integer(int32)	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
id	integer(int32)	false	none	none

BankTransactionDataDto

{
  "uniqueTransactionIdentifier": "string",
  "iban": "string"
}

Properties

Name	Type	Required	Restrictions	Description
uniqueTransactionIdentifier	string¦null	false	none	none
iban	string¦null	false	none	none

BankTransactionDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "date": "2019-08-24T14:15:22Z",
      "amount": 0,
      "transactionUniqueIdentifier": "string",
      "iban": "string",
      "currencyId": 0,
      "status": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[BankTransactionDto]¦null	false	none	none

AmazonDirectOrderProduct

{
  "name": "string",
  "imageUrl": "string",
  "asin": "string",
  "offerId": "string",
  "unitPrice": 0,
  "currencyCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
imageUrl	string¦null	false	none	none
asin	string¦null	false	none	none
offerId	string¦null	false	none	none
unitPrice	number(double)	false	none	none
currencyCode	string¦null	false	none	none

SelectedVoucherInputDto

{
  "voucherTypeId": 0,
  "amount": 0,
  "amzProduct": [
    {
      "name": "string",
      "imageUrl": "string",
      "asin": "string",
      "offerId": "string",
      "unitPrice": 0,
      "currencyCode": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
voucherTypeId	integer(int32)	false	none	none
amount	number(double)	false	none	none
amzProduct	[AmazonDirectOrderProduct]¦null	false	none	none

BulkDownloadRequest

{
  "quantity": 0,
  "vouchersGenerated": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
quantity	integer(int32)	false	none	none
vouchersGenerated	integer(int32)	false	none	none
selectedVouchers	[SelectedVoucherInputDto]¦null	false	none	none

BulkDownloadUrlRequestDto

{
  "name": "string",
  "description": "string",
  "campaignId": 0,
  "bulkDownloadRequests": [
    {
      "quantity": 0,
      "vouchersGenerated": 0,
      "selectedVouchers": [
        {
          "voucherTypeId": 0,
          "amount": 0,
          "amzProduct": [
            {}
          ]
        }
      ]
    }
  ],
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
campaignId	integer(int32)	true	none	none
bulkDownloadRequests	[BulkDownloadRequest]¦null	false	none	none
id	integer(int32)	false	none	none

BulkDownloadProcessStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

BulkDownloadUrlProcessDto

{
  "name": "string",
  "description": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "status": 0,
  "quantity": 0,
  "campaignId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
creationTime	string(date-time)	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
status	BulkDownloadProcessStatus	false	none	none
quantity	integer(int32)	true	none	none
campaignId	integer(int32)	true	none	none
id	integer(int32)	false	none	none

Campaign

{
  "name": "string",
  "currencyId": 0,
  "countryId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "campaignBudget": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "tenantId": 0,
  "currency": {
    "name": "string",
    "symbol": "string",
    "code": "string",
    "id": 0
  },
  "country": {
    "name": "string",
    "code": "string",
    "currencyId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "id": 0
  },
  "extensionData": "string",
  "organizationUnitId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
currencyId	integer(int32)	true	none	none
countryId	integer(int32)	false	none	none
templateId	integer(int32)¦null	false	none	none
templateConfigurationId	integer(int32)¦null	false	none	none
landingConfigurationId	integer(int32)	false	none	none
campaignBudget	number(double)	true	none	none
startDate	string(date-time)	true	none	none
endDate	string(date-time)¦null	false	none	none
expirationDate	string(date-time)¦null	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
tenantId	integer(int32)	false	none	none
currency	Currency	false	none	none
country	Country	false	none	none
extensionData	string¦null	false	none	none
organizationUnitId	integer(int64)¦null	false	none	none
id	integer(int32)	false	none	none

BulkDownloadUrlProcess

{
  "name": "string",
  "description": "string",
  "status": 0,
  "campaignId": 0,
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "tenantId": 0,
  "extensionData": "string",
  "vouchersGenerated": 0,
  "quantity": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
status	BulkDownloadProcessStatus	false	none	none
campaignId	integer(int32)	true	none	none
campaign	Campaign	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
tenantId	integer(int32)	false	none	none
extensionData	string¦null	false	none	none
vouchersGenerated	integer(int32)	false	none	none
quantity	integer(int32)	false	none	none
id	integer(int32)	false	none	none

DownloadVoucherUrlRequestStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

SelectedVoucher

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "redeemUrl": "string",
  "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b"
}

Properties

Name	Type	Required	Restrictions	Description
guid	string(uuid)¦null	false	none	none
redeemUrl	string¦null	false	none	none
voucherGuid	string(uuid)	false	none	none

VoucherDetailStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

VoucherDetailResponse

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "voucherId": 0,
  "voucherTypeId": 0,
  "code": "string",
  "voucherCodeId": 0,
  "status": 0,
  "amount": 0,
  "extensionData": "string"
}

Properties

Name	Type	Required	Restrictions	Description
guid	string(uuid)	true	none	none
voucherId	integer(int32)	true	none	none
voucherTypeId	integer(int32)	true	none	none
code	string¦null	false	none	none
voucherCodeId	integer(int32)	true	none	none
status	VoucherDetailStatus	true	none	none
amount	number(double)	false	none	none
extensionData	string¦null	false	none	none

DownloadVoucherUrlResponseDto

{
  "status": 0,
  "voucherId": 0,
  "multiVoucher": [
    {
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "redeemUrl": "string",
      "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b"
    }
  ],
  "multiVoucherDetails": [
    {
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "voucherId": 0,
      "voucherTypeId": 0,
      "code": "string",
      "voucherCodeId": 0,
      "status": 0,
      "amount": 0,
      "extensionData": "string"
    }
  ],
  "bulkProcessId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b",
  "campaignId": 0,
  "voucherUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
status	DownloadVoucherUrlRequestStatus	true	none	none
voucherId	integer(int32)	true	none	none
multiVoucher	[SelectedVoucher]¦null	false	none	none
multiVoucherDetails	[VoucherDetailResponse]¦null	false	none	none
bulkProcessId	integer(int32)¦null	false	none	none
creationTime	string(date-time)	false	none	none
voucherGuid	string(uuid)	false	none	none
campaignId	integer(int32)	false	none	none
voucherUrl	string¦null	false	none	none

BulkDownloadUrlProcessDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "description": "string",
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "status": 0,
      "quantity": 0,
      "campaignId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[BulkDownloadUrlProcessDto]¦null	false	none	none

BulkProcessStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

BulkProcessDto

{
  "name": "string",
  "description": "string",
  "status": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "totalAmount": 0,
  "campaignId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
status	BulkProcessStatus	false	none	none
creationTime	string(date-time)	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
totalAmount	number(double)	false	none	none
campaignId	integer(int32)	true	none	none
id	integer(int32)	false	none	none

SendingMethodType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

SingleRequestStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

SingleRequestMultiVoucherDto

{
  "tenantId": 0,
  "email": "string",
  "phone": "string",
  "sendingMethod": 0,
  "fullName": "string",
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ],
  "status": 0
}

Properties

Name	Type	Required	Restrictions	Description
tenantId	integer(int32)¦null	false	none	none
email	string¦null	false	none	none
phone	string¦null	false	none	none
sendingMethod	SendingMethodType	false	none	none
fullName	string	true	none	none
campaignId	integer(int32)	true	none	none
selectedVouchers	[SelectedVoucherInputDto]¦null	false	none	none
status	SingleRequestStatus	false	none	none

BulkRequestMultiVoucherDto

{
  "name": "string",
  "description": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "requests": [
    {
      "tenantId": 0,
      "email": "string",
      "phone": "string",
      "sendingMethod": 0,
      "fullName": "string",
      "campaignId": 0,
      "selectedVouchers": [
        {
          "voucherTypeId": 0,
          "amount": 0,
          "amzProduct": [
            {}
          ]
        }
      ],
      "status": 0
    }
  ],
  "campaignId": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
creationTime	string(date-time)	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
requests	[SingleRequestMultiVoucherDto]	true	none	none
campaignId	integer(int32)	true	none	none

BulkProcess

{
  "name": "string",
  "description": "string",
  "status": 0,
  "campaignId": 0,
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "tenantId": 0,
  "extensionData": "string",
  "quantity": 0,
  "vouchersGenerated": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
status	BulkProcessStatus	true	none	none
campaignId	integer(int32)	true	none	none
campaign	Campaign	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
tenantId	integer(int32)	false	none	none
extensionData	string¦null	false	none	none
quantity	integer(int32)	false	none	none
vouchersGenerated	integer(int32)	false	none	none
id	integer(int32)	false	none	none

TriggerBulkRequesttDto

{
  "bulkRequestId": 0
}

Properties

Name	Type	Required	Restrictions	Description
bulkRequestId	integer(int32)	true	none	none

BulkProcessDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "description": "string",
      "status": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "totalAmount": 0,
      "campaignId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[BulkProcessDto]¦null	false	none	none

VoucherRequestStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

RequestStatusQuantityDto

{
  "status": 0,
  "quantity": 0
}

Properties

Name	Type	Required	Restrictions	Description
status	VoucherRequestStatus	false	none	none
quantity	integer(int32)	false	none	none

VoucherDetailDto

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "voucherTypeId": 0,
  "code": "string",
  "status": 0,
  "amount": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
guid	string(uuid)	false	none	none
voucherTypeId	integer(int32)	false	none	none
code	string¦null	false	none	none
status	VoucherDetailStatus	false	none	none
amount	number(double)	false	none	none
id	integer(int32)	false	none	none

VoucherRequestDto

{
  "status": 0,
  "sendingMethod": 0,
  "email": "string",
  "phone": "string",
  "fullName": "string",
  "voucherId": 0,
  "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b",
  "bulkProcessId": 0,
  "campaignId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "multiVoucherData": [
    {
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "voucherTypeId": 0,
      "code": "string",
      "status": 0,
      "amount": 0,
      "id": 0
    }
  ],
  "organizationUnitId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
status	VoucherRequestStatus	false	none	none
sendingMethod	SendingMethodType	false	none	none
email	string¦null	false	none	none
phone	string¦null	false	none	none
fullName	string¦null	false	none	none
voucherId	integer(int32)	false	none	none
voucherGuid	string(uuid)	false	none	none
bulkProcessId	integer(int32)¦null	false	none	none
campaignId	integer(int32)	false	none	none
creationTime	string(date-time)	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
multiVoucherData	[VoucherDetailDto]¦null	false	none	none
organizationUnitId	integer(int64)¦null	false	none	none
id	integer(int32)	false	none	none

BulkProcessDetailsDto

{
  "requestStatuses": [
    {
      "status": 0,
      "quantity": 0
    }
  ],
  "totalValue": 0,
  "requests": [
    {
      "status": 0,
      "sendingMethod": 0,
      "email": "string",
      "phone": "string",
      "fullName": "string",
      "voucherId": 0,
      "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b",
      "bulkProcessId": 0,
      "campaignId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "multiVoucherData": [
        {
          "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
          "voucherTypeId": 0,
          "code": "string",
          "status": 0,
          "amount": 0,
          "id": 0
        }
      ],
      "organizationUnitId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
requestStatuses	[RequestStatusQuantityDto]¦null	false	none	none
totalValue	number(double)	false	none	none
requests	[VoucherRequestDto]¦null	false	none	none

ActiveVoucherTypes

{
  "voucherTypeId": 0
}

Properties

Name	Type	Required	Restrictions	Description
voucherTypeId	integer(int32)	false	none	none

CampaignMetricsDto

{
  "vouchersByCampaign": 0,
  "redeemVouchersInCampaign": 0,
  "refundedVouchersInCampaign": 0,
  "budgetSpent": 0,
  "refundedVouchersTotalAmount": 0,
  "redeemVouchersTotalAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
vouchersByCampaign	integer(int32)	false	none	none
redeemVouchersInCampaign	integer(int32)	false	none	none
refundedVouchersInCampaign	integer(int32)	false	none	none
budgetSpent	number(double)	false	none	none
refundedVouchersTotalAmount	number(double)	false	none	none
redeemVouchersTotalAmount	number(double)	false	none	none

CreateCampaignResponseDto

{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "campaignMetrics": {
    "vouchersByCampaign": 0,
    "redeemVouchersInCampaign": 0,
    "refundedVouchersInCampaign": 0,
    "budgetSpent": 0,
    "refundedVouchersTotalAmount": 0,
    "redeemVouchersTotalAmount": 0
  },
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
countryId	integer(int32)	false	none	none
currencyId	integer(int32)	false	none	none
templateId	integer(int32)¦null	false	none	none
templateConfigurationId	integer(int32)¦null	false	none	none
landingConfigurationId	integer(int32)	false	none	none
activeVoucherTypes	[ActiveVoucherTypes]¦null	false	none	none
campaignBudget	number(double)	false	none	none
organizationUnitId	integer(int64)¦null	false	none	none
startDate	string(date-time)	false	none	none
endDate	string(date-time)¦null	false	none	none
expirationDate	string(date-time)¦null	false	none	none
campaignMetrics	CampaignMetricsDto	false	none	none
id	integer(int32)	false	none	none

CampaignDto

{
  "name": "string",
  "currencyId": 0,
  "countryId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "activeVoucherTypesDetails": [
    {
      "title": "string",
      "countryCode": "string",
      "countryName": "string",
      "countryId": 0,
      "description": "string",
      "amounts": "string",
      "currency": "string",
      "currencyId": 0,
      "logo": "string",
      "cardImage": "string",
      "notes": "string",
      "category": "string",
      "validity": "string",
      "cumulable": "string",
      "spendMultipleTimes": "string",
      "ideaShopping": "string",
      "multipurpose": "string",
      "singleService": "string",
      "whereToRedeem": "string",
      "info": "string",
      "termsAndConditions": "string",
      "stockVouchers": true,
      "voucherProviderTypes": [
        {
          "voucherProviderId": 0,
          "voucherProvider": {
            "name": null,
            "voucherProviderTypes": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          },
          "voucherTypeId": 0,
          "voucherType": {
            "title": null,
            "countryCode": null,
            "countryName": null,
            "countryId": null,
            "description": null,
            "amounts": null,
            "currency": null,
            "currencyId": null,
            "logo": null,
            "cardImage": null,
            "notes": null,
            "category": null,
            "validity": null,
            "cumulable": null,
            "spendMultipleTimes": null,
            "ideaShopping": null,
            "multipurpose": null,
            "singleService": null,
            "whereToRedeem": null,
            "info": null,
            "termsAndConditions": null,
            "stockVouchers": null,
            "voucherProviderTypes": null,
            "voucherTypeCategoryId": null,
            "currencyFK": null,
            "country": null,
            "voucherTypeCategory": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          },
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        }
      ],
      "voucherTypeCategoryId": 0,
      "currencyFK": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "id": 0
      },
      "voucherTypeCategory": {
        "name": "string",
        "id": 0
      },
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "currentCampaignBudget": 0,
  "campaignMetrics": {
    "vouchersByCampaign": 0,
    "redeemVouchersInCampaign": 0,
    "refundedVouchersInCampaign": 0,
    "budgetSpent": 0,
    "refundedVouchersTotalAmount": 0,
    "redeemVouchersTotalAmount": 0
  },
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
currencyId	integer(int32)	false	none	none
countryId	integer(int32)¦null	false	none	none
templateId	integer(int32)¦null	false	none	none
templateConfigurationId	integer(int32)¦null	false	none	none
landingConfigurationId	integer(int32)	false	none	none
activeVoucherTypes	[ActiveVoucherTypes]¦null	false	none	none
activeVoucherTypesDetails	[VoucherType]¦null	false	none	none
campaignBudget	number(double)	false	none	none
organizationUnitId	integer(int64)¦null	false	none	none
startDate	string(date-time)	true	none	none
endDate	string(date-time)¦null	false	none	none
expirationDate	string(date-time)¦null	false	none	none
currentCampaignBudget	number(double)	false	none	none
campaignMetrics	CampaignMetricsDto	false	none	none
id	integer(int32)	false	none	none

CreateCampaignDto

{
  "name": "string",
  "countryId": 0,
  "currencyId": 0,
  "templateId": 0,
  "templateConfigurationId": 0,
  "landingConfigurationId": 0,
  "activeVoucherTypes": [
    {
      "voucherTypeId": 0
    }
  ],
  "campaignBudget": 0,
  "organizationUnitId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
countryId	integer(int32)	false	none	none
currencyId	integer(int32)	false	none	none
templateId	integer(int32)¦null	false	none	none
templateConfigurationId	integer(int32)¦null	false	none	none
landingConfigurationId	integer(int32)	false	none	none
activeVoucherTypes	[ActiveVoucherTypes]¦null	false	none	none
campaignBudget	number(double)	false	none	none
organizationUnitId	integer(int64)	false	none	none
startDate	string(date-time)	true	none	none
endDate	string(date-time)¦null	false	none	none
expirationDate	string(date-time)¦null	false	none	none
id	integer(int32)	false	none	none

CampaignDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "activeVoucherTypes": [
        {
          "voucherTypeId": 0
        }
      ],
      "activeVoucherTypesDetails": [
        {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            {}
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {
            "name": null,
            "symbol": null,
            "code": null,
            "id": null
          },
          "country": {
            "name": null,
            "code": null,
            "currencyId": null,
            "currency": null,
            "id": null
          },
          "voucherTypeCategory": {
            "name": null,
            "id": null
          },
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        }
      ],
      "campaignBudget": 0,
      "organizationUnitId": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "currentCampaignBudget": 0,
      "campaignMetrics": {
        "vouchersByCampaign": 0,
        "redeemVouchersInCampaign": 0,
        "refundedVouchersInCampaign": 0,
        "budgetSpent": 0,
        "refundedVouchersTotalAmount": 0,
        "redeemVouchersTotalAmount": 0
      },
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[CampaignDto]¦null	false	none	none

CampaignBalanceDto

{
  "campaignId": 0,
  "currencyId": 0,
  "amount": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
campaignId	integer(int32)	false	none	none
currencyId	integer(int32)	false	none	none
amount	number(double)	false	none	none
id	integer(int32)	false	none	none

GetCampaignBalancesSingleDto

{
  "campaignId": 0,
  "currencyId": 0,
  "balance": 0
}

Properties

Name	Type	Required	Restrictions	Description
campaignId	integer(int32)	false	none	none
currencyId	integer(int32)	false	none	none
balance	number(double)	false	none	none

GetCampaignBalancesDto

{
  "balances": [
    {
      "campaignId": 0,
      "currencyId": 0,
      "balance": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
balances	[GetCampaignBalancesSingleDto]¦null	false	none	none

CampaignBalanceDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "campaignId": 0,
      "currencyId": 0,
      "amount": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[CampaignBalanceDto]¦null	false	none	none

ChangeUiThemeInput

{
  "theme": "string"
}

Properties

Name	Type	Required	Restrictions	Description
theme	string	true	none	none

CountryDto

{
  "name": "string",
  "code": "string",
  "currencyId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
code	string¦null	false	none	none
currencyId	integer(int32)	false	none	none
id	integer(int32)	false	none	none

CountryDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[CountryDto]¦null	false	none	none

CountryTenantDto

{
  "countryId": 0,
  "tenantId": 0,
  "country": {
    "name": "string",
    "code": "string",
    "currencyId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "id": 0
  },
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
countryId	integer(int32)	false	none	none
tenantId	integer(int32)	false	none	none
country	Country	false	none	none
id	integer(int32)	false	none	none

CountryTenantDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "countryId": 0,
      "tenantId": 0,
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "id": 0
      },
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[CountryTenantDto]¦null	false	none	none

CountryTenantInputDto

{
  "countryId": 0,
  "tenantId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
countryId	integer(int32)	false	none	none
tenantId	integer(int32)	false	none	none
id	integer(int32)	false	none	none

CurrencyDto

{
  "name": "string",
  "symbol": "string",
  "code": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
symbol	string¦null	false	none	none
code	string¦null	false	none	none
id	integer(int32)	false	none	none

CurrencyDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[CurrencyDto]¦null	false	none	none

CurrencyTenantDto

{
  "currencyId": 0,
  "tenantId": 0,
  "currency": {
    "name": "string",
    "symbol": "string",
    "code": "string",
    "id": 0
  },
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
currencyId	integer(int32)	false	none	none
tenantId	integer(int32)	false	none	none
currency	Currency	false	none	none
id	integer(int32)	false	none	none

CurrencyTenantDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "currencyId": 0,
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[CurrencyTenantDto]¦null	false	none	none

CurrencyTenantInputDto

{
  "currencyId": 0,
  "tenantId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
currencyId	integer(int32)	false	none	none
tenantId	integer(int32)	false	none	none
id	integer(int32)	false	none	none

DemoLandingConfigDto

{
  "name": "string",
  "voucherTypeId": 0,
  "amount": 0,
  "campaignId": 0,
  "emailTemplateId": 0,
  "emailTemplateConfigurationId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
voucherTypeId	integer(int32)	true	none	none
amount	number(double)	true	none	none
campaignId	integer(int32)	true	none	none
emailTemplateId	integer(int32)	true	none	none
emailTemplateConfigurationId	integer(int32)	true	none	none
id	integer(int32)	false	none	none

DemoLandingConfigDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "voucherTypeId": 0,
      "amount": 0,
      "campaignId": 0,
      "emailTemplateId": 0,
      "emailTemplateConfigurationId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[DemoLandingConfigDto]¦null	false	none	none

QuestionType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1

FaqDto

{
  "question": "string",
  "answer": "string",
  "type": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
question	string¦null	false	none	none
answer	string¦null	false	none	none
type	QuestionType	false	none	none
id	integer(int32)	false	none	none

FaqDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "question": "string",
      "answer": "string",
      "type": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[FaqDto]¦null	false	none	none

LandingConfigurationDto

{
  "name": "string",
  "backgroundImg": "string",
  "backgroundColor": "string",
  "btn": "string",
  "logoImg": "string",
  "logoStyle": "string",
  "redeemTitle": "string",
  "sendVoucherTitle": "string",
  "default": true,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
backgroundImg	string¦null	false	none	none
backgroundColor	string¦null	false	none	none
btn	string¦null	false	none	none
logoImg	string¦null	false	none	none
logoStyle	string¦null	false	none	none
redeemTitle	string¦null	false	none	none
sendVoucherTitle	string¦null	false	none	none
default	boolean	false	none	none
id	integer(int32)	false	none	none

LandingConfigurationDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "backgroundImg": "string",
      "backgroundColor": "string",
      "btn": "string",
      "logoImg": "string",
      "logoStyle": "string",
      "redeemTitle": "string",
      "sendVoucherTitle": "string",
      "default": true,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[LandingConfigurationDto]¦null	false	none	none

MjmlInputDto

{
  "mjml": "string"
}

Properties

Name	Type	Required	Restrictions	Description
mjml	string¦null	false	none	none

CreateRoleDto

{
  "name": "string",
  "displayName": "string",
  "normalizedName": "string",
  "description": "string",
  "grantedPermissions": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
displayName	string	true	none	none
normalizedName	string¦null	false	none	none
description	string¦null	false	none	none
grantedPermissions	[string]¦null	false	none	none

RoleDto

{
  "name": "string",
  "displayName": "string",
  "normalizedName": "string",
  "description": "string",
  "grantedPermissions": [
    "string"
  ],
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
displayName	string	true	none	none
normalizedName	string¦null	false	none	none
description	string¦null	false	none	none
grantedPermissions	[string]¦null	false	none	none
id	integer(int32)	false	none	none

RoleListDto

{
  "name": "string",
  "displayName": "string",
  "isStatic": true,
  "isDefault": true,
  "creationTime": "2019-08-24T14:15:22Z",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
displayName	string¦null	false	none	none
isStatic	boolean	false	none	none
isDefault	boolean	false	none	none
creationTime	string(date-time)	false	none	none
id	integer(int32)	false	none	none

RoleListDtoListResultDto

{
  "items": [
    {
      "name": "string",
      "displayName": "string",
      "isStatic": true,
      "isDefault": true,
      "creationTime": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[RoleListDto]¦null	false	none	none

PermissionDto

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
displayName	string¦null	false	none	none
description	string¦null	false	none	none
id	integer(int64)	false	none	none

PermissionDtoListResultDto

{
  "items": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[PermissionDto]¦null	false	none	none

RoleEditDto

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "isStatic": true,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
displayName	string	true	none	none
description	string¦null	false	none	none
isStatic	boolean	false	none	none
id	integer(int32)	false	none	none

FlatPermissionDto

{
  "name": "string",
  "displayName": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
displayName	string¦null	false	none	none
description	string¦null	false	none	none

GetRoleForEditOutput

{
  "role": {
    "name": "string",
    "displayName": "string",
    "description": "string",
    "isStatic": true,
    "id": 0
  },
  "permissions": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string"
    }
  ],
  "grantedPermissionNames": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
role	RoleEditDto	false	none	none
permissions	[FlatPermissionDto]¦null	false	none	none
grantedPermissionNames	[string]¦null	false	none	none

RoleDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "displayName": "string",
      "normalizedName": "string",
      "description": "string",
      "grantedPermissions": [
        "string"
      ],
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[RoleDto]¦null	false	none	none

ApplicationInfoDto

{
  "version": "string",
  "releaseDate": "2019-08-24T14:15:22Z",
  "features": {
    "property1": true,
    "property2": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
version	string¦null	false	none	none
releaseDate	string(date-time)	false	none	none
features	object¦null	false	none	none
» additionalProperties	boolean	false	none	none

UserLoginInfoDto

{
  "name": "string",
  "surname": "string",
  "userName": "string",
  "emailAddress": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
surname	string¦null	false	none	none
userName	string¦null	false	none	none
emailAddress	string¦null	false	none	none
id	integer(int64)	false	none	none

TenantLoginInfoDto

{
  "tenancyName": "string",
  "name": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
tenancyName	string¦null	false	none	none
name	string¦null	false	none	none
id	integer(int32)	false	none	none

GetCurrentLoginInformationsOutput

{
  "application": {
    "version": "string",
    "releaseDate": "2019-08-24T14:15:22Z",
    "features": {
      "property1": true,
      "property2": true
    }
  },
  "user": {
    "name": "string",
    "surname": "string",
    "userName": "string",
    "emailAddress": "string",
    "id": 0
  },
  "tenant": {
    "tenancyName": "string",
    "name": "string",
    "id": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
application	ApplicationInfoDto	false	none	none
user	UserLoginInfoDto	false	none	none
tenant	TenantLoginInfoDto	false	none	none

StoredFileDto

{
  "publicUrl": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
publicUrl	string¦null	false	none	none
id	integer(int32)	false	none	none

UploadFileDto

{
  "base64Content": "string",
  "contentType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
base64Content	string	true	none	none
contentType	string	true	none	none

TemplateDto

{
  "name": "string",
  "mjml": "string",
  "default": true,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
mjml	string	true	none	none
default	boolean	false	none	none
id	integer(int32)	false	none	none

TemplateDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "mjml": "string",
      "default": true,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[TemplateDto]¦null	false	none	none

TemplateConfigurationDto

{
  "name": "string",
  "subject": "string",
  "properties": "string",
  "default": true,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
subject	string	true	none	none
properties	string	true	none	none
default	boolean	false	none	none
id	integer(int32)	false	none	none

TemplateConfigurationDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "subject": "string",
      "properties": "string",
      "default": true,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[TemplateConfigurationDto]¦null	false	none	none

CreateTenantDto

{
  "tenancyName": "string",
  "name": "string",
  "adminEmailAddress": "string",
  "connectionString": "string",
  "isActive": true
}

Properties

Name	Type	Required	Restrictions	Description
tenancyName	string	true	none	none
name	string	true	none	none
adminEmailAddress	string	true	none	none
connectionString	string¦null	false	none	none
isActive	boolean	false	none	none

TenantDto

{
  "tenancyName": "string",
  "name": "string",
  "isActive": true,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
tenancyName	string	true	none	none
name	string	true	none	none
isActive	boolean	false	none	none
id	integer(int32)	false	none	none

CreateUserDto

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userName	string	true	none	none
name	string	true	none	none
surname	string	true	none	none
emailAddress	string(email)	true	none	none
isActive	boolean	false	none	none
roleNames	[string]¦null	false	none	none
organizationUnitId	[integer]¦null	false	none	none
password	string	true	none	none

NewAccountInput

{
  "companyName": "string",
  "adminEmailAddress": "string",
  "adminUser": "string",
  "adminPassword": "string",
  "user": {
    "userName": "string",
    "name": "string",
    "surname": "string",
    "emailAddress": "user@example.com",
    "isActive": true,
    "roleNames": [
      "string"
    ],
    "organizationUnitId": [
      0
    ],
    "password": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
companyName	string¦null	false	none	none
adminEmailAddress	string¦null	false	none	none
adminUser	string¦null	false	none	none
adminPassword	string¦null	false	none	none
user	CreateUserDto	false	none	none

TenantDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "tenancyName": "string",
      "name": "string",
      "isActive": true,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[TenantDto]¦null	false	none	none

AuthenticateModel

{
  "userNameOrEmailAddress": "string",
  "password": "string",
  "rememberClient": true
}

Properties

Name	Type	Required	Restrictions	Description
userNameOrEmailAddress	string	true	none	none
password	string	true	none	none
rememberClient	boolean	false	none	none

AuthenticateResultModel

{
  "accessToken": "string",
  "encryptedAccessToken": "string",
  "expireInSeconds": 0,
  "userId": 0
}

Properties

Name	Type	Required	Restrictions	Description
accessToken	string¦null	false	none	none
encryptedAccessToken	string¦null	false	none	none
expireInSeconds	integer(int32)	false	none	none
userId	integer(int64)	false	none	none

JwtValidTokenInput

{
  "name": "string",
  "isActive": true,
  "expirationDays": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
isActive	boolean	false	none	none
expirationDays	integer(int32)¦null	false	none	none

ExternalLoginProviderInfoModel

{
  "name": "string",
  "clientId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
clientId	string¦null	false	none	none

ExternalAuthenticateModel

{
  "authProvider": "string",
  "providerKey": "string",
  "providerAccessCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
authProvider	string	true	none	none
providerKey	string	true	none	none
providerAccessCode	string	true	none	none

ExternalAuthenticateResultModel

{
  "accessToken": "string",
  "encryptedAccessToken": "string",
  "expireInSeconds": 0,
  "waitingForActivation": true
}

Properties

Name	Type	Required	Restrictions	Description
accessToken	string¦null	false	none	none
encryptedAccessToken	string¦null	false	none	none
expireInSeconds	integer(int32)	false	none	none
waitingForActivation	boolean	false	none	none

OrganizationUnitDto

{
  "displayName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
displayName	string¦null	false	none	none

OrganizationUnit

{
  "tenantId": 0,
  "parent": {
    "tenantId": 0,
    "parent": {
      "tenantId": 0,
      "parent": {
        "tenantId": 0,
        "parent": {
          "tenantId": null,
          "parent": null,
          "parentId": null,
          "code": null,
          "displayName": null,
          "children": null,
          "isDeleted": null,
          "deleterUserId": null,
          "deletionTime": null,
          "lastModificationTime": null,
          "lastModifierUserId": null,
          "creationTime": null,
          "creatorUserId": null,
          "id": null
        },
        "parentId": 0,
        "code": "string",
        "displayName": "string",
        "children": [
          {}
        ],
        "isDeleted": true,
        "deleterUserId": 0,
        "deletionTime": "2019-08-24T14:15:22Z",
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "creatorUserId": 0,
        "id": 0
      },
      "parentId": 0,
      "code": "string",
      "displayName": "string",
      "children": [
        {
          "tenantId": 0,
          "parent": {},
          "parentId": 0,
          "code": "string",
          "displayName": "string",
          "children": [
            null
          ],
          "isDeleted": true,
          "deleterUserId": 0,
          "deletionTime": "2019-08-24T14:15:22Z",
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "creatorUserId": 0,
          "id": 0
        }
      ],
      "isDeleted": true,
      "deleterUserId": 0,
      "deletionTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "id": 0
    },
    "parentId": 0,
    "code": "string",
    "displayName": "string",
    "children": [
      {
        "tenantId": 0,
        "parent": {
          "tenantId": 0,
          "parent": {},
          "parentId": 0,
          "code": "string",
          "displayName": "string",
          "children": [
            null
          ],
          "isDeleted": true,
          "deleterUserId": 0,
          "deletionTime": "2019-08-24T14:15:22Z",
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "creatorUserId": 0,
          "id": 0
        },
        "parentId": 0,
        "code": "string",
        "displayName": "string",
        "children": [
          {
            "tenantId": null,
            "parent": null,
            "parentId": null,
            "code": null,
            "displayName": null,
            "children": null,
            "isDeleted": null,
            "deleterUserId": null,
            "deletionTime": null,
            "lastModificationTime": null,
            "lastModifierUserId": null,
            "creationTime": null,
            "creatorUserId": null,
            "id": null
          }
        ],
        "isDeleted": true,
        "deleterUserId": 0,
        "deletionTime": "2019-08-24T14:15:22Z",
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "creatorUserId": 0,
        "id": 0
      }
    ],
    "isDeleted": true,
    "deleterUserId": 0,
    "deletionTime": "2019-08-24T14:15:22Z",
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "id": 0
  },
  "parentId": 0,
  "code": "string",
  "displayName": "string",
  "children": [
    {
      "tenantId": 0,
      "parent": {
        "tenantId": 0,
        "parent": {
          "tenantId": 0,
          "parent": {},
          "parentId": 0,
          "code": "string",
          "displayName": "string",
          "children": [
            null
          ],
          "isDeleted": true,
          "deleterUserId": 0,
          "deletionTime": "2019-08-24T14:15:22Z",
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "creatorUserId": 0,
          "id": 0
        },
        "parentId": 0,
        "code": "string",
        "displayName": "string",
        "children": [
          {
            "tenantId": null,
            "parent": null,
            "parentId": null,
            "code": null,
            "displayName": null,
            "children": null,
            "isDeleted": null,
            "deleterUserId": null,
            "deletionTime": null,
            "lastModificationTime": null,
            "lastModifierUserId": null,
            "creationTime": null,
            "creatorUserId": null,
            "id": null
          }
        ],
        "isDeleted": true,
        "deleterUserId": 0,
        "deletionTime": "2019-08-24T14:15:22Z",
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "creatorUserId": 0,
        "id": 0
      },
      "parentId": 0,
      "code": "string",
      "displayName": "string",
      "children": [
        {
          "tenantId": 0,
          "parent": {
            "tenantId": null,
            "parent": null,
            "parentId": null,
            "code": null,
            "displayName": null,
            "children": null,
            "isDeleted": null,
            "deleterUserId": null,
            "deletionTime": null,
            "lastModificationTime": null,
            "lastModifierUserId": null,
            "creationTime": null,
            "creatorUserId": null,
            "id": null
          },
          "parentId": 0,
          "code": "string",
          "displayName": "string",
          "children": [
            {}
          ],
          "isDeleted": true,
          "deleterUserId": 0,
          "deletionTime": "2019-08-24T14:15:22Z",
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "creatorUserId": 0,
          "id": 0
        }
      ],
      "isDeleted": true,
      "deleterUserId": 0,
      "deletionTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "id": 0
    }
  ],
  "isDeleted": true,
  "deleterUserId": 0,
  "deletionTime": "2019-08-24T14:15:22Z",
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "creatorUserId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
tenantId	integer(int32)¦null	false	none	none
parent	OrganizationUnit	false	none	none
parentId	integer(int64)¦null	false	none	none
code	string	true	none	none
displayName	string	true	none	none
children	[OrganizationUnit]¦null	false	none	none
isDeleted	boolean	false	none	none
deleterUserId	integer(int64)¦null	false	none	none
deletionTime	string(date-time)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
id	integer(int64)	false	none	none

UserDto

{
  "userName": "string",
  "name": "string",
  "surname": "string",
  "emailAddress": "user@example.com",
  "isActive": true,
  "fullName": "string",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "creationTime": "2019-08-24T14:15:22Z",
  "roleNames": [
    "string"
  ],
  "organizationUnitId": [
    0
  ],
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
userName	string	true	none	none
name	string	true	none	none
surname	string	true	none	none
emailAddress	string(email)	true	none	none
isActive	boolean	false	none	none
fullName	string¦null	false	none	none
lastLoginTime	string(date-time)¦null	false	none	none
creationTime	string(date-time)	false	none	none
roleNames	[string]¦null	false	none	none
organizationUnitId	[integer]¦null	false	none	none
id	integer(int64)	false	none	none

Int64EntityDto

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none

RoleDtoListResultDto

{
  "items": [
    {
      "name": "string",
      "displayName": "string",
      "normalizedName": "string",
      "description": "string",
      "grantedPermissions": [
        "string"
      ],
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[RoleDto]¦null	false	none	none

ChangeUserLanguageDto

{
  "languageName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
languageName	string	true	none	none

UserDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "userName": "string",
      "name": "string",
      "surname": "string",
      "emailAddress": "user@example.com",
      "isActive": true,
      "fullName": "string",
      "lastLoginTime": "2019-08-24T14:15:22Z",
      "creationTime": "2019-08-24T14:15:22Z",
      "roleNames": [
        "string"
      ],
      "organizationUnitId": [
        0
      ],
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[UserDto]¦null	false	none	none

ChangePasswordDto

{
  "currentPassword": "string",
  "newPassword": "string"
}

Properties

Name	Type	Required	Restrictions	Description
currentPassword	string	true	none	none
newPassword	string	true	none	none

ResetPasswordDto

{
  "adminPassword": "string",
  "userId": 0,
  "newPassword": "string"
}

Properties

Name	Type	Required	Restrictions	Description
adminPassword	string	true	none	none
userId	integer(int64)	true	none	none
newPassword	string	true	none	none

VoucherCodeState

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3

VoucherLinkedCodeDto

{
  "code": "string",
  "voucherTypeId": 0,
  "voucherProviderId": 0,
  "amount": 0,
  "state": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
code	string	true	none	none
voucherTypeId	integer(int32)	true	none	none
voucherProviderId	integer(int32)	true	none	none
amount	number(double)	false	none	none
state	VoucherCodeState	true	none	none
id	integer(int32)	false	none	none

VoucherLinkedCodeDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "code": "string",
      "voucherTypeId": 0,
      "voucherProviderId": 0,
      "amount": 0,
      "state": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherLinkedCodeDto]¦null	false	none	none

VoucherDetailDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "voucherTypeId": 0,
      "code": "string",
      "status": 0,
      "amount": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherDetailDto]¦null	false	none	none

VoucherProviderDto

{
  "name": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
id	integer(int32)	false	none	none

VoucherProviderDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherProviderDto]¦null	false	none	none

VoucherProviderTypeDto

{
  "voucherProviderId": 0,
  "voucherTypeId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
voucherProviderId	integer(int32)	true	none	none
voucherTypeId	integer(int32)	true	none	none
id	integer(int32)	false	none	none

VoucherProviderTypeDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "voucherProviderId": 0,
      "voucherTypeId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherProviderTypeDto]¦null	false	none	none

LastMinuteRequestDto

{
  "productCode": "string",
  "amount": "string"
}

Properties

Name	Type	Required	Restrictions	Description
productCode	string¦null	false	none	none
amount	string¦null	false	none	none

MeriteCreateGiftCardDto

{
  "campaignId": "string",
  "denomination": 0,
  "quantity": 0
}

Properties

Name	Type	Required	Restrictions	Description
campaignId	string¦null	false	none	none
denomination	number(double)	false	none	none
quantity	integer(int32)	false	none	none

DemoLandingInput

{
  "configName": "string",
  "email": "string",
  "phone": "string",
  "fullName": "string",
  "sendingMethod": 0
}

Properties

Name	Type	Required	Restrictions	Description
configName	string¦null	false	none	none
email	string¦null	false	none	none
phone	string¦null	false	none	none
fullName	string¦null	false	none	none
sendingMethod	SendingMethodType	false	none	none

SingleRequestMultiVoucherInputDto

{
  "email": "string",
  "phone": "string",
  "sendingMethod": 0,
  "fullName": "string",
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
email	string¦null	false	none	none
phone	string¦null	false	none	none
sendingMethod	SendingMethodType	false	none	none
fullName	string	true	none	none
campaignId	integer(int32)	true	none	none
selectedVouchers	[SelectedVoucherInputDto]¦null	false	none	none

VoucherStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

Voucher

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "campaignId": 0,
  "code": "string",
  "status": 0,
  "isSandBox": true,
  "expirationDate": "2019-08-24T14:15:22Z",
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "tenantId": 0,
  "extensionData": "string",
  "organizationUnitId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
guid	string(uuid)	true	none	none
campaignId	integer(int32)	true	none	none
code	string¦null	false	none	none
status	VoucherStatus	true	none	none
isSandBox	boolean	true	none	none
expirationDate	string(date-time)¦null	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
campaign	Campaign	false	none	none
tenantId	integer(int32)	false	none	none
extensionData	string¦null	false	none	none
organizationUnitId	integer(int64)¦null	false	none	none
id	integer(int32)	false	none	none

VoucherRequest

{
  "status": 0,
  "sendingMethod": 0,
  "email": "string",
  "phone": "string",
  "fullName": "string",
  "voucherId": 0,
  "campaignId": 0,
  "bulkProcessId": 0,
  "tenantId": 0,
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "campaign": {
    "name": "string",
    "currencyId": 0,
    "countryId": 0,
    "templateId": 0,
    "templateConfigurationId": 0,
    "landingConfigurationId": 0,
    "campaignBudget": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "currency": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "voucher": {
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "campaignId": 0,
    "code": "string",
    "status": 0,
    "isSandBox": true,
    "expirationDate": "2019-08-24T14:15:22Z",
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "campaign": {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "campaignBudget": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": null,
          "symbol": null,
          "code": null,
          "id": null
        },
        "id": 0
      },
      "extensionData": "string",
      "organizationUnitId": 0,
      "id": 0
    },
    "tenantId": 0,
    "extensionData": "string",
    "organizationUnitId": 0,
    "id": 0
  },
  "bulkProcess": {
    "name": "string",
    "description": "string",
    "status": 0,
    "campaignId": 0,
    "campaign": {
      "name": "string",
      "currencyId": 0,
      "countryId": 0,
      "templateId": 0,
      "templateConfigurationId": 0,
      "landingConfigurationId": 0,
      "campaignBudget": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "creatorUserId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModifierUserId": 0,
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "tenantId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "country": {
        "name": "string",
        "code": "string",
        "currencyId": 0,
        "currency": {
          "name": null,
          "symbol": null,
          "code": null,
          "id": null
        },
        "id": 0
      },
      "extensionData": "string",
      "organizationUnitId": 0,
      "id": 0
    },
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "tenantId": 0,
    "extensionData": "string",
    "quantity": 0,
    "vouchersGenerated": 0,
    "id": 0
  },
  "organizationUnitId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
status	VoucherRequestStatus	true	none	none
sendingMethod	SendingMethodType	true	none	none
email	string¦null	false	none	none
phone	string¦null	false	none	none
fullName	string	true	none	none
voucherId	integer(int32)	true	none	none
campaignId	integer(int32)	true	none	none
bulkProcessId	integer(int32)¦null	false	none	none
tenantId	integer(int32)	false	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
campaign	Campaign	false	none	none
voucher	Voucher	false	none	none
bulkProcess	BulkProcess	false	none	none
organizationUnitId	integer(int64)¦null	false	none	none
id	integer(int32)	false	none	none

MultiVoucherUrlDto

{
  "campaignId": 0,
  "selectedVouchers": [
    {
      "voucherTypeId": 0,
      "amount": 0,
      "amzProduct": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
campaignId	integer(int32)	true	none	none
selectedVouchers	[SelectedVoucherInputDto]¦null	false	none	none

PostalAddress

{
  "deliverTo": "string",
  "street": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "country": "string"
}

Properties

Name	Type	Required	Restrictions	Description
deliverTo	string¦null	false	none	none
street	string¦null	false	none	none
city	string¦null	false	none	none
state	string¦null	false	none	none
postalCode	string¦null	false	none	none
country	string¦null	false	none	none

Phone

{
  "countryCode": 0,
  "number": "string"
}

Properties

Name	Type	Required	Restrictions	Description
countryCode	integer(int32)	false	none	none
number	string¦null	false	none	none

Address

{
  "email": "string",
  "postalAddress": {
    "deliverTo": "string",
    "street": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  },
  "phone": {
    "countryCode": 0,
    "number": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
email	string¦null	false	none	none
postalAddress	PostalAddress	false	none	none
phone	Phone	false	none	none

RedeemCodeWithMultiVoucherInputDto

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "multiVoucherGuid": "5e13f9a0-9962-4641-93c0-0c2cfa11ef10",
  "multiRedeem": true,
  "address": {
    "email": "string",
    "postalAddress": {
      "deliverTo": "string",
      "street": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "phone": {
      "countryCode": 0,
      "number": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
guid	string(uuid)	false	none	none
multiVoucherGuid	string(uuid)	false	none	none
multiRedeem	boolean	false	none	none
address	Address	false	none	none

VoucherCode

{
  "code": "string",
  "voucherTypeId": 0,
  "voucherProviderId": 0,
  "state": 0,
  "amount": 0,
  "isSandBox": true,
  "creatorUserId": 0,
  "creationTime": "2019-08-24T14:15:22Z",
  "lastModifierUserId": 0,
  "lastModificationTime": "2019-08-24T14:15:22Z",
  "extensionData": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
code	string	true	none	none
voucherTypeId	integer(int32)	true	none	none
voucherProviderId	integer(int32)	true	none	none
state	VoucherCodeState	true	none	none
amount	number(double)	false	none	none
isSandBox	boolean	true	none	none
creatorUserId	integer(int64)¦null	false	none	none
creationTime	string(date-time)	false	none	none
lastModifierUserId	integer(int64)¦null	false	none	none
lastModificationTime	string(date-time)¦null	false	none	none
extensionData	string¦null	false	none	none
id	integer(int32)	false	none	none

GiftCardNormalizedData

{
  "code": "string",
  "voucherLink": "string",
  "expiryDate": "string",
  "pin": "string",
  "amzProduct": [
    {
      "name": "string",
      "imageUrl": "string",
      "asin": "string",
      "offerId": "string",
      "unitPrice": 0,
      "currencyCode": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
code	string¦null	false	none	none
voucherLink	string¦null	false	none	none
expiryDate	string¦null	false	none	none
pin	string¦null	false	none	none
amzProduct	[AmazonDirectOrderProduct]¦null	false	none	none

VoucherDetailResponseDto

{
  "amount": 0,
  "code": "string",
  "creationTime": "string",
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "id": 0,
  "lastModificationTime": "string",
  "status": 0,
  "amzProducts": [
    {
      "name": "string",
      "imageUrl": "string",
      "asin": "string",
      "offerId": "string",
      "unitPrice": 0,
      "currencyCode": "string"
    }
  ],
  "giftCardNormalizedData": {
    "code": "string",
    "voucherLink": "string",
    "expiryDate": "string",
    "pin": "string",
    "amzProduct": [
      {
        "name": "string",
        "imageUrl": "string",
        "asin": "string",
        "offerId": "string",
        "unitPrice": 0,
        "currencyCode": "string"
      }
    ]
  },
  "voucherType": {
    "title": "string",
    "countryCode": "string",
    "countryName": "string",
    "countryId": 0,
    "description": "string",
    "amounts": "string",
    "currency": "string",
    "currencyId": 0,
    "logo": "string",
    "cardImage": "string",
    "notes": "string",
    "category": "string",
    "validity": "string",
    "cumulable": "string",
    "spendMultipleTimes": "string",
    "ideaShopping": "string",
    "multipurpose": "string",
    "singleService": "string",
    "whereToRedeem": "string",
    "info": "string",
    "termsAndConditions": "string",
    "stockVouchers": true,
    "voucherProviderTypes": [
      {
        "voucherProviderId": 0,
        "voucherProvider": {
          "name": "string",
          "voucherProviderTypes": [
            null
          ],
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "voucherTypeId": 0,
        "voucherType": {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            null
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {},
          "country": {},
          "voucherTypeCategory": {},
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    ],
    "voucherTypeCategoryId": 0,
    "currencyFK": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "voucherTypeCategory": {
      "name": "string",
      "id": 0
    },
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "id": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
amount	number(double)	false	none	none
code	string¦null	false	none	none
creationTime	string¦null	false	none	none
guid	string(uuid)	false	none	none
id	integer(int32)	false	none	none
lastModificationTime	string¦null	false	none	none
status	VoucherDetailStatus	false	none	none
amzProducts	[AmazonDirectOrderProduct]¦null	false	none	none
giftCardNormalizedData	GiftCardNormalizedData	false	none	none
voucherType	VoucherType	false	none	none

VoucherDto

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "totalAmount": 0,
  "billable": true,
  "status": 0,
  "voucherRequestStatus": 0,
  "fullName": "string",
  "email": "string",
  "campaignId": 0,
  "vouchers": [
    {
      "amount": 0,
      "code": "string",
      "creationTime": "string",
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "id": 0,
      "lastModificationTime": "string",
      "status": 0,
      "amzProducts": [
        {
          "name": "string",
          "imageUrl": "string",
          "asin": "string",
          "offerId": "string",
          "unitPrice": 0,
          "currencyCode": "string"
        }
      ],
      "giftCardNormalizedData": {
        "code": "string",
        "voucherLink": "string",
        "expiryDate": "string",
        "pin": "string",
        "amzProduct": [
          {
            "name": null,
            "imageUrl": null,
            "asin": null,
            "offerId": null,
            "unitPrice": null,
            "currencyCode": null
          }
        ]
      },
      "voucherType": {
        "title": "string",
        "countryCode": "string",
        "countryName": "string",
        "countryId": 0,
        "description": "string",
        "amounts": "string",
        "currency": "string",
        "currencyId": 0,
        "logo": "string",
        "cardImage": "string",
        "notes": "string",
        "category": "string",
        "validity": "string",
        "cumulable": "string",
        "spendMultipleTimes": "string",
        "ideaShopping": "string",
        "multipurpose": "string",
        "singleService": "string",
        "whereToRedeem": "string",
        "info": "string",
        "termsAndConditions": "string",
        "stockVouchers": true,
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "voucherTypeCategoryId": 0,
        "currencyFK": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "country": {
          "name": "string",
          "code": "string",
          "currencyId": 0,
          "currency": {},
          "id": 0
        },
        "voucherTypeCategory": {
          "name": "string",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
guid	string(uuid)	false	none	none
totalAmount	number(double)	false	none	none
billable	boolean	false	none	none
status	VoucherStatus	false	none	none
voucherRequestStatus	VoucherRequestStatus	false	none	none
fullName	string¦null	false	none	none
email	string¦null	false	none	none
campaignId	integer(int32)	false	none	none
vouchers	[VoucherDetailResponseDto]¦null	false	none	none

TriggerSingleRequestDto

{
  "requestId": 0
}

Properties

Name	Type	Required	Restrictions	Description
requestId	integer(int32)	true	none	none

VoucherRequestDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "status": 0,
      "sendingMethod": 0,
      "email": "string",
      "phone": "string",
      "fullName": "string",
      "voucherId": 0,
      "voucherGuid": "79bf5cd0-f72a-4724-a3cb-49f58d54ba5b",
      "bulkProcessId": 0,
      "campaignId": 0,
      "creationTime": "2019-08-24T14:15:22Z",
      "lastModificationTime": "2019-08-24T14:15:22Z",
      "multiVoucherData": [
        {
          "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
          "voucherTypeId": 0,
          "code": "string",
          "status": 0,
          "amount": 0,
          "id": 0
        }
      ],
      "organizationUnitId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherRequestDto]¦null	false	none	none

RewardFriendDto

{
  "email": "user@example.com",
  "fullName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
email	string(email)	true	none	none
fullName	string	true	none	none

SendMailInputDto

{
  "fullName": "string",
  "email": "string",
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc"
}

Properties

Name	Type	Required	Restrictions	Description
fullName	string¦null	false	none	none
email	string¦null	false	none	none
guid	string(uuid)	false	none	none

SearchAWSProductsRequestDto

{
  "keywords": "string",
  "productRegion": "string",
  "locale": "string"
}

Properties

Name	Type	Required	Restrictions	Description
keywords	string¦null	false	none	none
productRegion	string¦null	false	none	none
locale	string¦null	false	none	none

VoucherTypeDto

{
  "title": "string",
  "countryCode": "string",
  "countryName": "string",
  "description": "string",
  "amounts": "string",
  "currency": "string",
  "logo": "string",
  "cardImage": "string",
  "notes": "string",
  "category": "string",
  "validity": "string",
  "cumulable": "string",
  "spendMultipleTimes": "string",
  "ideaShopping": "string",
  "multipurpose": "string",
  "singleService": "string",
  "whereToRedeem": "string",
  "info": "string",
  "termsAndConditions": "string",
  "stockVouchers": true,
  "isActiveInAccount": true,
  "countryId": 0,
  "currencyId": 0,
  "voucherTypeCategoryId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	none
countryCode	string¦null	false	none	none
countryName	string¦null	false	none	none
description	string¦null	false	none	none
amounts	string¦null	false	none	none
currency	string¦null	false	none	none
logo	string¦null	false	none	none
cardImage	string¦null	false	none	none
notes	string¦null	false	none	none
category	string¦null	false	none	none
validity	string¦null	false	none	none
cumulable	string¦null	false	none	none
spendMultipleTimes	string¦null	false	none	none
ideaShopping	string¦null	false	none	none
multipurpose	string¦null	false	none	none
singleService	string¦null	false	none	none
whereToRedeem	string¦null	false	none	none
info	string¦null	false	none	none
termsAndConditions	string¦null	false	none	none
stockVouchers	boolean	false	none	none
isActiveInAccount	boolean	false	none	none
countryId	integer(int32)	false	none	none
currencyId	integer(int32)	false	none	none
voucherTypeCategoryId	integer(int32)	false	none	none
id	integer(int32)	false	none	none

ProviderCountryDto

{
  "code": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	string¦null	false	none	none
name	string¦null	false	none	none

ProviderCategoryDto

{
  "category": "string"
}

Properties

Name	Type	Required	Restrictions	Description
category	string¦null	false	none	none

VoucherTypeDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "title": "string",
      "countryCode": "string",
      "countryName": "string",
      "description": "string",
      "amounts": "string",
      "currency": "string",
      "logo": "string",
      "cardImage": "string",
      "notes": "string",
      "category": "string",
      "validity": "string",
      "cumulable": "string",
      "spendMultipleTimes": "string",
      "ideaShopping": "string",
      "multipurpose": "string",
      "singleService": "string",
      "whereToRedeem": "string",
      "info": "string",
      "termsAndConditions": "string",
      "stockVouchers": true,
      "isActiveInAccount": true,
      "countryId": 0,
      "currencyId": 0,
      "voucherTypeCategoryId": 0,
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherTypeDto]¦null	false	none	none

VoucherTypeCategoryInputDto

{
  "name": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
id	integer(int32)	false	none	none

VoucherTypeCategoryDto

{
  "name": "string",
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
id	integer(int32)	false	none	none

VoucherTypeCategoryDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "name": "string",
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherTypeCategoryDto]¦null	false	none	none

VoucherTypeTenantDto

{
  "voucherTypeId": 0,
  "active": true,
  "tenantId": 0,
  "voucherType": {
    "title": "string",
    "countryCode": "string",
    "countryName": "string",
    "countryId": 0,
    "description": "string",
    "amounts": "string",
    "currency": "string",
    "currencyId": 0,
    "logo": "string",
    "cardImage": "string",
    "notes": "string",
    "category": "string",
    "validity": "string",
    "cumulable": "string",
    "spendMultipleTimes": "string",
    "ideaShopping": "string",
    "multipurpose": "string",
    "singleService": "string",
    "whereToRedeem": "string",
    "info": "string",
    "termsAndConditions": "string",
    "stockVouchers": true,
    "voucherProviderTypes": [
      {
        "voucherProviderId": 0,
        "voucherProvider": {
          "name": "string",
          "voucherProviderTypes": [
            null
          ],
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "voucherTypeId": 0,
        "voucherType": {
          "title": "string",
          "countryCode": "string",
          "countryName": "string",
          "countryId": 0,
          "description": "string",
          "amounts": "string",
          "currency": "string",
          "currencyId": 0,
          "logo": "string",
          "cardImage": "string",
          "notes": "string",
          "category": "string",
          "validity": "string",
          "cumulable": "string",
          "spendMultipleTimes": "string",
          "ideaShopping": "string",
          "multipurpose": "string",
          "singleService": "string",
          "whereToRedeem": "string",
          "info": "string",
          "termsAndConditions": "string",
          "stockVouchers": true,
          "voucherProviderTypes": [
            null
          ],
          "voucherTypeCategoryId": 0,
          "currencyFK": {},
          "country": {},
          "voucherTypeCategory": {},
          "creatorUserId": 0,
          "creationTime": "2019-08-24T14:15:22Z",
          "lastModifierUserId": 0,
          "lastModificationTime": "2019-08-24T14:15:22Z",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      }
    ],
    "voucherTypeCategoryId": 0,
    "currencyFK": {
      "name": "string",
      "symbol": "string",
      "code": "string",
      "id": 0
    },
    "country": {
      "name": "string",
      "code": "string",
      "currencyId": 0,
      "currency": {
        "name": "string",
        "symbol": "string",
        "code": "string",
        "id": 0
      },
      "id": 0
    },
    "voucherTypeCategory": {
      "name": "string",
      "id": 0
    },
    "creatorUserId": 0,
    "creationTime": "2019-08-24T14:15:22Z",
    "lastModifierUserId": 0,
    "lastModificationTime": "2019-08-24T14:15:22Z",
    "id": 0
  },
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
voucherTypeId	integer(int32)	false	none	none
active	boolean	false	none	none
tenantId	integer(int32)	false	none	none
voucherType	VoucherType	false	none	none
id	integer(int32)	false	none	none

VoucherTypeTenantDtoPagedResultDto

{
  "totalCount": 0,
  "items": [
    {
      "voucherTypeId": 0,
      "active": true,
      "tenantId": 0,
      "voucherType": {
        "title": "string",
        "countryCode": "string",
        "countryName": "string",
        "countryId": 0,
        "description": "string",
        "amounts": "string",
        "currency": "string",
        "currencyId": 0,
        "logo": "string",
        "cardImage": "string",
        "notes": "string",
        "category": "string",
        "validity": "string",
        "cumulable": "string",
        "spendMultipleTimes": "string",
        "ideaShopping": "string",
        "multipurpose": "string",
        "singleService": "string",
        "whereToRedeem": "string",
        "info": "string",
        "termsAndConditions": "string",
        "stockVouchers": true,
        "voucherProviderTypes": [
          {
            "voucherProviderId": null,
            "voucherProvider": null,
            "voucherTypeId": null,
            "voucherType": null,
            "creatorUserId": null,
            "creationTime": null,
            "lastModifierUserId": null,
            "lastModificationTime": null,
            "id": null
          }
        ],
        "voucherTypeCategoryId": 0,
        "currencyFK": {
          "name": "string",
          "symbol": "string",
          "code": "string",
          "id": 0
        },
        "country": {
          "name": "string",
          "code": "string",
          "currencyId": 0,
          "currency": {},
          "id": 0
        },
        "voucherTypeCategory": {
          "name": "string",
          "id": 0
        },
        "creatorUserId": 0,
        "creationTime": "2019-08-24T14:15:22Z",
        "lastModifierUserId": 0,
        "lastModificationTime": "2019-08-24T14:15:22Z",
        "id": 0
      },
      "id": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalCount	integer(int32)	false	none	none
items	[VoucherTypeTenantDto]¦null	false	none	none

VoucherTypeTenantInputDto

{
  "voucherTypeId": 0,
  "active": true,
  "tenantId": 0,
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
voucherTypeId	integer(int32)	false	none	none
active	boolean	false	none	none
tenantId	integer(int32)	false	none	none
id	integer(int32)	false	none	none