Graduway Open API

API and SDK Documentation

Version: 1.0.0

Graduway Data API 1.0.0 - Graduway API for data management

Overview

The Graduway data API allows network admin to access, update, create or delete data both on the Graduway platform and on their own, ensuring both platforms are kept up to date and in-sync. The API is built on REST principles, ensuring that it is well structured and predictable, and will return a JSON file for clients to consume.

Authentication

In order to access the service the admin will have to use a public API key, which will be randomly generated by Graduway for each account. The key will be available to the admin in the admin interface on the Graduway platform. The public key will be used to request a private key from the API, with which the admin can access user data. The private key must be included in all subsequent calls and expires every 30 minutes.

Responses

The Graduway Data API returns standard HTTP status codes as part of the response to all API requests.

200 - OK	The request was successful
201 - Created	A new resource was created
400 - Bad Request	The request failed due to a syntax error, or is missing a required parameter
401 - Unauthorized	No valid API key was provided
404 - Not Found	The requested resource does not exist
409 - Conflict	This item already exists

Token

getToken

Get a private authentication key

Pass the public authentication key in order to receive a private key which must be used in all subsequent calls. The priuvate key is valid for 30 minutes.

/token

Usage and SDK Samples

curl -X POST\
-H "X-API-KEY: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://bg.your_api_domain_goes_here/api/v1/token"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: GraduwayApiAuthentication
        ApiKeyAuth GraduwayApiAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("GraduwayApiAuthentication");
        GraduwayApiAuthentication.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //GraduwayApiAuthentication.setApiKeyPrefix("Token");

        TokenApi apiInstance = new TokenApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String contentType = contentType_example; // String | 
        String body = ; // String | public api key
        try {
            'String' result = apiInstance.getToken(platformId, platformName, contentType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#getToken");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.TokenApi;

public class TokenApiExample {

    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String contentType = contentType_example; // String | 
        String body = ; // String | public api key
        try {
            'String' result = apiInstance.getToken(platformId, platformName, contentType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#getToken");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: GraduwayApiAuthentication)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
Integer *platformId = 56; // 
String *platformName = platformName_example; // 
String *contentType = contentType_example; // 
String *body = ; // public api key (optional)

TokenApi *apiInstance = [[TokenApi alloc] init];

// Get a private authentication key
[apiInstance getTokenWith:platformId
    platformName:platformName
    contentType:contentType
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GraduwayOpenApi = require('graduway_open_api');
var defaultClient = GraduwayOpenApi.ApiClient.instance;

// Configure API key authorization: GraduwayApiAuthentication
var GraduwayApiAuthentication = defaultClient.authentications['GraduwayApiAuthentication'];
GraduwayApiAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//GraduwayApiAuthentication.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new GraduwayOpenApi.TokenApi()
var platformId = 56; // {{Integer}} 
var platformName = platformName_example; // {{String}} 
var contentType = contentType_example; // {{String}} 
var opts = { 
  'body':  // {{String}} public api key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getToken(platformIdplatformNamecontentType, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTokenExample
    {
        public void main()
        {

            // Configure API key authorization: GraduwayApiAuthentication
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");

            var apiInstance = new TokenApi();
            var platformId = 56;  // Integer | 
            var platformName = platformName_example;  // String | 
            var contentType = contentType_example;  // String | 
            var body = new String(); // String | public api key (optional) 

            try
            {
                // Get a private authentication key
                'String' result = apiInstance.getToken(platformId, platformName, contentType, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TokenApi.getToken: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: GraduwayApiAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\ApiTokenApi();
$platformId = 56; // Integer | 
$platformName = platformName_example; // String | 
$contentType = contentType_example; // String | 
$body = ; // String | public api key

try {
    $result = $api_instance->getToken($platformId, $platformName, $contentType, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->getToken: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TokenApi;

# Configure API key authorization: GraduwayApiAuthentication
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TokenApi->new();
my $platformId = 56; # Integer | 
my $platformName = platformName_example; # String | 
my $contentType = contentType_example; # String | 
my $body = WWW::SwaggerClient::Object::String->new(); # String | public api key

eval { 
    my $result = $api_instance->getToken(platformId => $platformId, platformName => $platformName, contentType => $contentType, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TokenApi->getToken: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: GraduwayApiAuthentication
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TokenApi()
platformId = 56 # Integer | 
platformName = platformName_example # String | 
contentType = contentType_example # String | 
body =  # String | public api key (optional)

try: 
    # Get a private authentication key
    api_response = api_instance.get_token(platformId, platformName, contentType, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TokenApi->getToken: %s\n" % e)

Parameters

Header parameters

Name	Description
platform_id*	Integer (int32) Required
platform_name*	String Required
Content-Type*	String Required

Body parameters

Name	Description
body

Responses

Status: 200 - private api key

Schema

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

Users

addPrepopulated

You can add a new prepopulated user to the prepopulated list, or update an existing user by passing in and ID that already exists.

/users-prepopulated

Usage and SDK Samples

curl -X POST\
-H "X-API-KEY: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://bg.your_api_domain_goes_here/api/v1/users-prepopulated"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: GraduwayApiAuthentication
        ApiKeyAuth GraduwayApiAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("GraduwayApiAuthentication");
        GraduwayApiAuthentication.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //GraduwayApiAuthentication.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        array[UserPrepopulated] body = ; // array[UserPrepopulated] | New user data
        try {
            array[ApiResponse] result = apiInstance.addPrepopulated(platformId, platformName, xApiKey, contentType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#addPrepopulated");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        array[UserPrepopulated] body = ; // array[UserPrepopulated] | New user data
        try {
            array[ApiResponse] result = apiInstance.addPrepopulated(platformId, platformName, xApiKey, contentType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#addPrepopulated");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: GraduwayApiAuthentication)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
Integer *platformId = 56; // 
String *platformName = platformName_example; // 
String *xApiKey = xApiKey_example; // 
String *contentType = contentType_example; // 
array[UserPrepopulated] *body = ; // New user data (optional)

UsersApi *apiInstance = [[UsersApi alloc] init];

// You can add a new prepopulated user to the prepopulated list, or update an existing user by passing in and ID that already exists.
[apiInstance addPrepopulatedWith:platformId
    platformName:platformName
    xApiKey:xApiKey
    contentType:contentType
    body:body
              completionHandler: ^(array[ApiResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GraduwayOpenApi = require('graduway_open_api');
var defaultClient = GraduwayOpenApi.ApiClient.instance;

// Configure API key authorization: GraduwayApiAuthentication
var GraduwayApiAuthentication = defaultClient.authentications['GraduwayApiAuthentication'];
GraduwayApiAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//GraduwayApiAuthentication.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new GraduwayOpenApi.UsersApi()
var platformId = 56; // {{Integer}} 
var platformName = platformName_example; // {{String}} 
var xApiKey = xApiKey_example; // {{String}} 
var contentType = contentType_example; // {{String}} 
var opts = { 
  'body':  // {{array[UserPrepopulated]}} New user data
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPrepopulated(platformIdplatformNamexApiKeycontentType, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addPrepopulatedExample
    {
        public void main()
        {

            // Configure API key authorization: GraduwayApiAuthentication
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");

            var apiInstance = new UsersApi();
            var platformId = 56;  // Integer | 
            var platformName = platformName_example;  // String | 
            var xApiKey = xApiKey_example;  // String | 
            var contentType = contentType_example;  // String | 
            var body = new array[UserPrepopulated](); // array[UserPrepopulated] | New user data (optional) 

            try
            {
                // You can add a new prepopulated user to the prepopulated list, or update an existing user by passing in and ID that already exists.
                array[ApiResponse] result = apiInstance.addPrepopulated(platformId, platformName, xApiKey, contentType, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.addPrepopulated: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: GraduwayApiAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$platformId = 56; // Integer | 
$platformName = platformName_example; // String | 
$xApiKey = xApiKey_example; // String | 
$contentType = contentType_example; // String | 
$body = ; // array[UserPrepopulated] | New user data

try {
    $result = $api_instance->addPrepopulated($platformId, $platformName, $xApiKey, $contentType, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->addPrepopulated: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: GraduwayApiAuthentication
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $platformId = 56; # Integer | 
my $platformName = platformName_example; # String | 
my $xApiKey = xApiKey_example; # String | 
my $contentType = contentType_example; # String | 
my $body = [WWW::SwaggerClient::Object::array[UserPrepopulated]->new()]; # array[UserPrepopulated] | New user data

eval { 
    my $result = $api_instance->addPrepopulated(platformId => $platformId, platformName => $platformName, xApiKey => $xApiKey, contentType => $contentType, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->addPrepopulated: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: GraduwayApiAuthentication
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
platformId = 56 # Integer | 
platformName = platformName_example # String | 
xApiKey = xApiKey_example # String | 
contentType = contentType_example # String | 
body =  # array[UserPrepopulated] | New user data (optional)

try: 
    # You can add a new prepopulated user to the prepopulated list, or update an existing user by passing in and ID that already exists.
    api_response = api_instance.add_prepopulated(platformId, platformName, xApiKey, contentType, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->addPrepopulated: %s\n" % e)

Parameters

Header parameters

Name	Description
platform_id*	Integer (int32) Required
platform_name*	String Required
x-api-key*	String Required
Content-Type*	String Required

Body parameters

Name	Description
body

Responses

Name	Type	Format	Description
Location	String

Status: 400 - invalid input object invalid

Status: 401 - Unauthorized

Status: 409 - an existing item already exists

searchPrepopulatedUsers

Exports profile data of prepopulated users

By passing in options, you can search for available data in the system

/users-prepopulated

Usage and SDK Samples

curl -X GET\
-H "X-API-KEY: [[apiKey]]"\
-H "Accept: application/json"\
"https://bg.your_api_domain_goes_here/api/v1/users-prepopulated?user_id=&unique_id=&skip=&limit="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: GraduwayApiAuthentication
        ApiKeyAuth GraduwayApiAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("GraduwayApiAuthentication");
        GraduwayApiAuthentication.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //GraduwayApiAuthentication.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        Integer userId = 56; // Integer | User Id generated by our system
        String uniqueId = uniqueId_example; // String | unique user Id
        Integer skip = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        try {
            array[UserPrepopulatedApiResponse] result = apiInstance.searchPrepopulatedUsers(platformId, platformName, xApiKey, contentType, userId, uniqueId, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#searchPrepopulatedUsers");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        Integer userId = 56; // Integer | User Id generated by our system
        String uniqueId = uniqueId_example; // String | unique user Id
        Integer skip = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        try {
            array[UserPrepopulatedApiResponse] result = apiInstance.searchPrepopulatedUsers(platformId, platformName, xApiKey, contentType, userId, uniqueId, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#searchPrepopulatedUsers");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: GraduwayApiAuthentication)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
Integer *platformId = 56; // 
String *platformName = platformName_example; // 
String *xApiKey = xApiKey_example; // 
String *contentType = contentType_example; // 
Integer *userId = 56; // User Id generated by our system (optional)
String *uniqueId = uniqueId_example; // unique user Id (optional)
Integer *skip = 56; // number of records to skip for pagination (optional)
Integer *limit = 56; // maximum number of records to return (optional)

UsersApi *apiInstance = [[UsersApi alloc] init];

// Exports profile data of prepopulated users
[apiInstance searchPrepopulatedUsersWith:platformId
    platformName:platformName
    xApiKey:xApiKey
    contentType:contentType
    userId:userId
    uniqueId:uniqueId
    skip:skip
    limit:limit
              completionHandler: ^(array[UserPrepopulatedApiResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GraduwayOpenApi = require('graduway_open_api');
var defaultClient = GraduwayOpenApi.ApiClient.instance;

// Configure API key authorization: GraduwayApiAuthentication
var GraduwayApiAuthentication = defaultClient.authentications['GraduwayApiAuthentication'];
GraduwayApiAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//GraduwayApiAuthentication.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new GraduwayOpenApi.UsersApi()
var platformId = 56; // {{Integer}} 
var platformName = platformName_example; // {{String}} 
var xApiKey = xApiKey_example; // {{String}} 
var contentType = contentType_example; // {{String}} 
var opts = { 
  'userId': 56, // {{Integer}} User Id generated by our system
  'uniqueId': uniqueId_example, // {{String}} unique user Id
  'skip': 56, // {{Integer}} number of records to skip for pagination
  'limit': 56 // {{Integer}} maximum number of records to return
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchPrepopulatedUsers(platformId, platformName, xApiKey, contentType, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchPrepopulatedUsersExample
    {
        public void main()
        {

            // Configure API key authorization: GraduwayApiAuthentication
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");

            var apiInstance = new UsersApi();
            var platformId = 56;  // Integer | 
            var platformName = platformName_example;  // String | 
            var xApiKey = xApiKey_example;  // String | 
            var contentType = contentType_example;  // String | 
            var userId = 56;  // Integer | User Id generated by our system (optional) 
            var uniqueId = uniqueId_example;  // String | unique user Id (optional) 
            var skip = 56;  // Integer | number of records to skip for pagination (optional) 
            var limit = 56;  // Integer | maximum number of records to return (optional) 

            try
            {
                // Exports profile data of prepopulated users
                array[UserPrepopulatedApiResponse] result = apiInstance.searchPrepopulatedUsers(platformId, platformName, xApiKey, contentType, userId, uniqueId, skip, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.searchPrepopulatedUsers: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: GraduwayApiAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$platformId = 56; // Integer | 
$platformName = platformName_example; // String | 
$xApiKey = xApiKey_example; // String | 
$contentType = contentType_example; // String | 
$userId = 56; // Integer | User Id generated by our system
$uniqueId = uniqueId_example; // String | unique user Id
$skip = 56; // Integer | number of records to skip for pagination
$limit = 56; // Integer | maximum number of records to return

try {
    $result = $api_instance->searchPrepopulatedUsers($platformId, $platformName, $xApiKey, $contentType, $userId, $uniqueId, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->searchPrepopulatedUsers: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: GraduwayApiAuthentication
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $platformId = 56; # Integer | 
my $platformName = platformName_example; # String | 
my $xApiKey = xApiKey_example; # String | 
my $contentType = contentType_example; # String | 
my $userId = 56; # Integer | User Id generated by our system
my $uniqueId = uniqueId_example; # String | unique user Id
my $skip = 56; # Integer | number of records to skip for pagination
my $limit = 56; # Integer | maximum number of records to return

eval { 
    my $result = $api_instance->searchPrepopulatedUsers(platformId => $platformId, platformName => $platformName, xApiKey => $xApiKey, contentType => $contentType, userId => $userId, uniqueId => $uniqueId, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->searchPrepopulatedUsers: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: GraduwayApiAuthentication
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
platformId = 56 # Integer | 
platformName = platformName_example # String | 
xApiKey = xApiKey_example # String | 
contentType = contentType_example # String | 
userId = 56 # Integer | User Id generated by our system (optional)
uniqueId = uniqueId_example # String | unique user Id (optional)
skip = 56 # Integer | number of records to skip for pagination (optional)
limit = 56 # Integer | maximum number of records to return (optional)

try: 
    # Exports profile data of prepopulated users
    api_response = api_instance.search_prepopulated_users(platformId, platformName, xApiKey, contentType, userId=userId, uniqueId=uniqueId, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->searchPrepopulatedUsers: %s\n" % e)

Parameters

Header parameters

Name	Description
platform_id*	Integer (int32) Required
platform_name*	String Required
x-api-key*	String Required
Content-Type*	String Required

Query parameters

Name	Description
user_id	Integer (int32) User Id generated by our system
unique_id	String unique user Id
skip	Integer (int32) number of records to skip for pagination
limit	Integer (int32) maximum number of records to return

Responses

Status: 200 - search results matching criteria

Schema

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

searchRegisteredUsers

Exports profile data of registered users

By passing in the appropriate options, you can search for available data in the system and receive a JSON file with user data.

/users

Usage and SDK Samples

curl -X GET\
-H "X-API-KEY: [[apiKey]]"\
-H "Accept: application/json"\
"https://bg.your_api_domain_goes_here/api/v1/users?user_id=&unique_id=&email=&features=&skip=&limit=&registered_from=&registered_to=&updated_from=&updated_to=&last_logged_in_from=&last_logged_in_to="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: GraduwayApiAuthentication
        ApiKeyAuth GraduwayApiAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("GraduwayApiAuthentication");
        GraduwayApiAuthentication.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //GraduwayApiAuthentication.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        Integer userId = 56; // Integer | User Id generated by our system
        String uniqueId = uniqueId_example; // String | unique user Id
        String email = email_example; // String | user's email address
        String features = features_example; // String | use features=company_unique_id to include company_unique_id in the response
        Integer skip = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        Date registeredFrom = 2013-10-20T19:20:30+01:00; // Date | users who registered from a specific date
        Date registeredTo = 2013-10-20T19:20:30+01:00; // Date | users who registered until a specific date
        Date updatedFrom = 2013-10-20T19:20:30+01:00; // Date | users who updated their profile from a specific date
        Date updatedTo = 2013-10-20T19:20:30+01:00; // Date | users who updated their profile until a specific date
        Date lastLoggedInFrom = 2013-10-20T19:20:30+01:00; // Date | users who logged in from a specific date
        Date lastLoggedInTo = 2013-10-20T19:20:30+01:00; // Date | users who logged in until a specific date
        try {
            UserResponse result = apiInstance.searchRegisteredUsers(platformId, platformName, xApiKey, contentType, userId, uniqueId, email, features, skip, limit, registeredFrom, registeredTo, updatedFrom, updatedTo, lastLoggedInFrom, lastLoggedInTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#searchRegisteredUsers");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        Integer userId = 56; // Integer | User Id generated by our system
        String uniqueId = uniqueId_example; // String | unique user Id
        String email = email_example; // String | user's email address
        String features = features_example; // String | use features=company_unique_id to include company_unique_id in the response
        Integer skip = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        Date registeredFrom = 2013-10-20T19:20:30+01:00; // Date | users who registered from a specific date
        Date registeredTo = 2013-10-20T19:20:30+01:00; // Date | users who registered until a specific date
        Date updatedFrom = 2013-10-20T19:20:30+01:00; // Date | users who updated their profile from a specific date
        Date updatedTo = 2013-10-20T19:20:30+01:00; // Date | users who updated their profile until a specific date
        Date lastLoggedInFrom = 2013-10-20T19:20:30+01:00; // Date | users who logged in from a specific date
        Date lastLoggedInTo = 2013-10-20T19:20:30+01:00; // Date | users who logged in until a specific date
        try {
            UserResponse result = apiInstance.searchRegisteredUsers(platformId, platformName, xApiKey, contentType, userId, uniqueId, email, features, skip, limit, registeredFrom, registeredTo, updatedFrom, updatedTo, lastLoggedInFrom, lastLoggedInTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#searchRegisteredUsers");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: GraduwayApiAuthentication)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
Integer *platformId = 56; // 
String *platformName = platformName_example; // 
String *xApiKey = xApiKey_example; // 
String *contentType = contentType_example; // 
Integer *userId = 56; // User Id generated by our system (optional)
String *uniqueId = uniqueId_example; // unique user Id (optional)
String *email = email_example; // user's email address (optional)
String *features = features_example; // use features=company_unique_id to include company_unique_id in the response (optional)
Integer *skip = 56; // number of records to skip for pagination (optional)
Integer *limit = 56; // maximum number of records to return (optional)
Date *registeredFrom = 2013-10-20T19:20:30+01:00; // users who registered from a specific date (optional)
Date *registeredTo = 2013-10-20T19:20:30+01:00; // users who registered until a specific date (optional)
Date *updatedFrom = 2013-10-20T19:20:30+01:00; // users who updated their profile from a specific date (optional)
Date *updatedTo = 2013-10-20T19:20:30+01:00; // users who updated their profile until a specific date (optional)
Date *lastLoggedInFrom = 2013-10-20T19:20:30+01:00; // users who logged in from a specific date (optional)
Date *lastLoggedInTo = 2013-10-20T19:20:30+01:00; // users who logged in until a specific date (optional)

UsersApi *apiInstance = [[UsersApi alloc] init];

// Exports profile data of registered users
[apiInstance searchRegisteredUsersWith:platformId
    platformName:platformName
    xApiKey:xApiKey
    contentType:contentType
    userId:userId
    uniqueId:uniqueId
    email:email
    features:features
    skip:skip
    limit:limit
    registeredFrom:registeredFrom
    registeredTo:registeredTo
    updatedFrom:updatedFrom
    updatedTo:updatedTo
    lastLoggedInFrom:lastLoggedInFrom
    lastLoggedInTo:lastLoggedInTo
              completionHandler: ^(UserResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GraduwayOpenApi = require('graduway_open_api');
var defaultClient = GraduwayOpenApi.ApiClient.instance;

// Configure API key authorization: GraduwayApiAuthentication
var GraduwayApiAuthentication = defaultClient.authentications['GraduwayApiAuthentication'];
GraduwayApiAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//GraduwayApiAuthentication.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new GraduwayOpenApi.UsersApi()
var platformId = 56; // {{Integer}} 
var platformName = platformName_example; // {{String}} 
var xApiKey = xApiKey_example; // {{String}} 
var contentType = contentType_example; // {{String}} 
var opts = { 
  'userId': 56, // {{Integer}} User Id generated by our system
  'uniqueId': uniqueId_example, // {{String}} unique user Id
  'email': email_example, // {{String}} user's email address
  'features': features_example, // {{String}} use features=company_unique_id to include company_unique_id in the response
  'skip': 56, // {{Integer}} number of records to skip for pagination
  'limit': 56, // {{Integer}} maximum number of records to return
  'registeredFrom': 2013-10-20T19:20:30+01:00, // {{Date}} users who registered from a specific date
  'registeredTo': 2013-10-20T19:20:30+01:00, // {{Date}} users who registered until a specific date
  'updatedFrom': 2013-10-20T19:20:30+01:00, // {{Date}} users who updated their profile from a specific date
  'updatedTo': 2013-10-20T19:20:30+01:00, // {{Date}} users who updated their profile until a specific date
  'lastLoggedInFrom': 2013-10-20T19:20:30+01:00, // {{Date}} users who logged in from a specific date
  'lastLoggedInTo': 2013-10-20T19:20:30+01:00 // {{Date}} users who logged in until a specific date
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRegisteredUsers(platformId, platformName, xApiKey, contentType, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchRegisteredUsersExample
    {
        public void main()
        {

            // Configure API key authorization: GraduwayApiAuthentication
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");

            var apiInstance = new UsersApi();
            var platformId = 56;  // Integer | 
            var platformName = platformName_example;  // String | 
            var xApiKey = xApiKey_example;  // String | 
            var contentType = contentType_example;  // String | 
            var userId = 56;  // Integer | User Id generated by our system (optional) 
            var uniqueId = uniqueId_example;  // String | unique user Id (optional) 
            var email = email_example;  // String | user's email address (optional) 
            var features = features_example;  // String | use features=company_unique_id to include company_unique_id in the response (optional) 
            var skip = 56;  // Integer | number of records to skip for pagination (optional) 
            var limit = 56;  // Integer | maximum number of records to return (optional) 
            var registeredFrom = 2013-10-20T19:20:30+01:00;  // Date | users who registered from a specific date (optional) 
            var registeredTo = 2013-10-20T19:20:30+01:00;  // Date | users who registered until a specific date (optional) 
            var updatedFrom = 2013-10-20T19:20:30+01:00;  // Date | users who updated their profile from a specific date (optional) 
            var updatedTo = 2013-10-20T19:20:30+01:00;  // Date | users who updated their profile until a specific date (optional) 
            var lastLoggedInFrom = 2013-10-20T19:20:30+01:00;  // Date | users who logged in from a specific date (optional) 
            var lastLoggedInTo = 2013-10-20T19:20:30+01:00;  // Date | users who logged in until a specific date (optional) 

            try
            {
                // Exports profile data of registered users
                UserResponse result = apiInstance.searchRegisteredUsers(platformId, platformName, xApiKey, contentType, userId, uniqueId, email, features, skip, limit, registeredFrom, registeredTo, updatedFrom, updatedTo, lastLoggedInFrom, lastLoggedInTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.searchRegisteredUsers: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: GraduwayApiAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$platformId = 56; // Integer | 
$platformName = platformName_example; // String | 
$xApiKey = xApiKey_example; // String | 
$contentType = contentType_example; // String | 
$userId = 56; // Integer | User Id generated by our system
$uniqueId = uniqueId_example; // String | unique user Id
$email = email_example; // String | user's email address
$features = features_example; // String | use features=company_unique_id to include company_unique_id in the response
$skip = 56; // Integer | number of records to skip for pagination
$limit = 56; // Integer | maximum number of records to return
$registeredFrom = 2013-10-20T19:20:30+01:00; // Date | users who registered from a specific date
$registeredTo = 2013-10-20T19:20:30+01:00; // Date | users who registered until a specific date
$updatedFrom = 2013-10-20T19:20:30+01:00; // Date | users who updated their profile from a specific date
$updatedTo = 2013-10-20T19:20:30+01:00; // Date | users who updated their profile until a specific date
$lastLoggedInFrom = 2013-10-20T19:20:30+01:00; // Date | users who logged in from a specific date
$lastLoggedInTo = 2013-10-20T19:20:30+01:00; // Date | users who logged in until a specific date

try {
    $result = $api_instance->searchRegisteredUsers($platformId, $platformName, $xApiKey, $contentType, $userId, $uniqueId, $email, $features, $skip, $limit, $registeredFrom, $registeredTo, $updatedFrom, $updatedTo, $lastLoggedInFrom, $lastLoggedInTo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->searchRegisteredUsers: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: GraduwayApiAuthentication
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $platformId = 56; # Integer | 
my $platformName = platformName_example; # String | 
my $xApiKey = xApiKey_example; # String | 
my $contentType = contentType_example; # String | 
my $userId = 56; # Integer | User Id generated by our system
my $uniqueId = uniqueId_example; # String | unique user Id
my $email = email_example; # String | user's email address
my $features = features_example; # String | use features=company_unique_id to include company_unique_id in the response
my $skip = 56; # Integer | number of records to skip for pagination
my $limit = 56; # Integer | maximum number of records to return
my $registeredFrom = 2013-10-20T19:20:30+01:00; # Date | users who registered from a specific date
my $registeredTo = 2013-10-20T19:20:30+01:00; # Date | users who registered until a specific date
my $updatedFrom = 2013-10-20T19:20:30+01:00; # Date | users who updated their profile from a specific date
my $updatedTo = 2013-10-20T19:20:30+01:00; # Date | users who updated their profile until a specific date
my $lastLoggedInFrom = 2013-10-20T19:20:30+01:00; # Date | users who logged in from a specific date
my $lastLoggedInTo = 2013-10-20T19:20:30+01:00; # Date | users who logged in until a specific date

eval { 
    my $result = $api_instance->searchRegisteredUsers(platformId => $platformId, platformName => $platformName, xApiKey => $xApiKey, contentType => $contentType, userId => $userId, uniqueId => $uniqueId, email => $email, features => $features, skip => $skip, limit => $limit, registeredFrom => $registeredFrom, registeredTo => $registeredTo, updatedFrom => $updatedFrom, updatedTo => $updatedTo, lastLoggedInFrom => $lastLoggedInFrom, lastLoggedInTo => $lastLoggedInTo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->searchRegisteredUsers: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: GraduwayApiAuthentication
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
platformId = 56 # Integer | 
platformName = platformName_example # String | 
xApiKey = xApiKey_example # String | 
contentType = contentType_example # String | 
userId = 56 # Integer | User Id generated by our system (optional)
uniqueId = uniqueId_example # String | unique user Id (optional)
email = email_example # String | user's email address (optional)
features = features_example # String | use features=company_unique_id to include company_unique_id in the response (optional)
skip = 56 # Integer | number of records to skip for pagination (optional)
limit = 56 # Integer | maximum number of records to return (optional)
registeredFrom = 2013-10-20T19:20:30+01:00 # Date | users who registered from a specific date (optional)
registeredTo = 2013-10-20T19:20:30+01:00 # Date | users who registered until a specific date (optional)
updatedFrom = 2013-10-20T19:20:30+01:00 # Date | users who updated their profile from a specific date (optional)
updatedTo = 2013-10-20T19:20:30+01:00 # Date | users who updated their profile until a specific date (optional)
lastLoggedInFrom = 2013-10-20T19:20:30+01:00 # Date | users who logged in from a specific date (optional)
lastLoggedInTo = 2013-10-20T19:20:30+01:00 # Date | users who logged in until a specific date (optional)

try: 
    # Exports profile data of registered users
    api_response = api_instance.search_registered_users(platformId, platformName, xApiKey, contentType, userId=userId, uniqueId=uniqueId, email=email, features=features, skip=skip, limit=limit, registeredFrom=registeredFrom, registeredTo=registeredTo, updatedFrom=updatedFrom, updatedTo=updatedTo, lastLoggedInFrom=lastLoggedInFrom, lastLoggedInTo=lastLoggedInTo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->searchRegisteredUsers: %s\n" % e)

Parameters

Header parameters

Name	Description
platform_id*	Integer (int32) Required
platform_name*	String Required
x-api-key*	String Required
Content-Type*	String Required

Query parameters

Name	Description
user_id	Integer (int32) User Id generated by our system
unique_id	String unique user Id
email	String user's email address
features	String use features=company_unique_id to include company_unique_id in the response
skip	Integer (int32) number of records to skip for pagination
limit	Integer (int32) maximum number of records to return
registered_from	Date (date-time) users who registered from a specific date
registered_to	Date (date-time) users who registered until a specific date
updated_from	Date (date-time) users who updated their profile from a specific date
updated_to	Date (date-time) users who updated their profile until a specific date
last_logged_in_from	Date (date-time) users who logged in from a specific date
last_logged_in_to	Date (date-time) users who logged in until a specific date

Responses

Status: 200 - search results matching criteria

Schema

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

updateRegisteredUser

Updates profile data of a registered user

You can update existing user data on the platform by passing in fields with new information.

/users

Usage and SDK Samples

curl -X PATCH\
-H "X-API-KEY: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://bg.your_api_domain_goes_here/api/v1/users"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: GraduwayApiAuthentication
        ApiKeyAuth GraduwayApiAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("GraduwayApiAuthentication");
        GraduwayApiAuthentication.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //GraduwayApiAuthentication.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        User body = ; // User | 
        try {
            inline_response_200 result = apiInstance.updateRegisteredUser(platformId, platformName, xApiKey, contentType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateRegisteredUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        User body = ; // User | 
        try {
            inline_response_200 result = apiInstance.updateRegisteredUser(platformId, platformName, xApiKey, contentType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateRegisteredUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: GraduwayApiAuthentication)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
Integer *platformId = 56; // 
String *platformName = platformName_example; // 
String *xApiKey = xApiKey_example; // 
String *contentType = contentType_example; // 
User *body = ; //  (optional)

UsersApi *apiInstance = [[UsersApi alloc] init];

// Updates profile data of a registered user
[apiInstance updateRegisteredUserWith:platformId
    platformName:platformName
    xApiKey:xApiKey
    contentType:contentType
    body:body
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GraduwayOpenApi = require('graduway_open_api');
var defaultClient = GraduwayOpenApi.ApiClient.instance;

// Configure API key authorization: GraduwayApiAuthentication
var GraduwayApiAuthentication = defaultClient.authentications['GraduwayApiAuthentication'];
GraduwayApiAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//GraduwayApiAuthentication.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new GraduwayOpenApi.UsersApi()
var platformId = 56; // {{Integer}} 
var platformName = platformName_example; // {{String}} 
var xApiKey = xApiKey_example; // {{String}} 
var contentType = contentType_example; // {{String}} 
var opts = { 
  'body':  // {{User}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRegisteredUser(platformIdplatformNamexApiKeycontentType, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRegisteredUserExample
    {
        public void main()
        {

            // Configure API key authorization: GraduwayApiAuthentication
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");

            var apiInstance = new UsersApi();
            var platformId = 56;  // Integer | 
            var platformName = platformName_example;  // String | 
            var xApiKey = xApiKey_example;  // String | 
            var contentType = contentType_example;  // String | 
            var body = new User(); // User |  (optional) 

            try
            {
                // Updates profile data of a registered user
                inline_response_200 result = apiInstance.updateRegisteredUser(platformId, platformName, xApiKey, contentType, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateRegisteredUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: GraduwayApiAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersApi();
$platformId = 56; // Integer | 
$platformName = platformName_example; // String | 
$xApiKey = xApiKey_example; // String | 
$contentType = contentType_example; // String | 
$body = ; // User | 

try {
    $result = $api_instance->updateRegisteredUser($platformId, $platformName, $xApiKey, $contentType, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateRegisteredUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: GraduwayApiAuthentication
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $platformId = 56; # Integer | 
my $platformName = platformName_example; # String | 
my $xApiKey = xApiKey_example; # String | 
my $contentType = contentType_example; # String | 
my $body = WWW::SwaggerClient::Object::User->new(); # User | 

eval { 
    my $result = $api_instance->updateRegisteredUser(platformId => $platformId, platformName => $platformName, xApiKey => $xApiKey, contentType => $contentType, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->updateRegisteredUser: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: GraduwayApiAuthentication
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
platformId = 56 # Integer | 
platformName = platformName_example # String | 
xApiKey = xApiKey_example # String | 
contentType = contentType_example # String | 
body =  # User |  (optional)

try: 
    # Updates profile data of a registered user
    api_response = api_instance.update_registered_user(platformId, platformName, xApiKey, contentType, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->updateRegisteredUser: %s\n" % e)

Parameters

Header parameters

Name	Description
platform_id*	Integer (int32) Required
platform_name*	String Required
x-api-key*	String Required
Content-Type*	String Required

Body parameters

Name	Description
body

Responses

Status: 200 - Updated data

Schema

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

UsersuserId

deleteRegisteredUser

Deletes a registered user from the platform

You can delete specific registered users from the platform.

/users

Usage and SDK Samples

curl -X DELETE\
-H "X-API-KEY: [[apiKey]]"\
"https://bg.your_api_domain_goes_here/api/v1/users?user_id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersuserIdApi;

import java.io.File;
import java.util.*;

public class UsersuserIdApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: GraduwayApiAuthentication
        ApiKeyAuth GraduwayApiAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("GraduwayApiAuthentication");
        GraduwayApiAuthentication.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //GraduwayApiAuthentication.setApiKeyPrefix("Token");

        UsersuserIdApi apiInstance = new UsersuserIdApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        Integer userId = 56; // Integer | User Id generated by our system
        try {
            apiInstance.deleteRegisteredUser(platformId, platformName, xApiKey, contentType, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersuserIdApi#deleteRegisteredUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersuserIdApi;

public class UsersuserIdApiExample {

    public static void main(String[] args) {
        UsersuserIdApi apiInstance = new UsersuserIdApi();
        Integer platformId = 56; // Integer | 
        String platformName = platformName_example; // String | 
        String xApiKey = xApiKey_example; // String | 
        String contentType = contentType_example; // String | 
        Integer userId = 56; // Integer | User Id generated by our system
        try {
            apiInstance.deleteRegisteredUser(platformId, platformName, xApiKey, contentType, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersuserIdApi#deleteRegisteredUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: GraduwayApiAuthentication)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
Integer *platformId = 56; // 
String *platformName = platformName_example; // 
String *xApiKey = xApiKey_example; // 
String *contentType = contentType_example; // 
Integer *userId = 56; // User Id generated by our system

UsersuserIdApi *apiInstance = [[UsersuserIdApi alloc] init];

// Deletes a registered user from the platform
[apiInstance deleteRegisteredUserWith:platformId
    platformName:platformName
    xApiKey:xApiKey
    contentType:contentType
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GraduwayOpenApi = require('graduway_open_api');
var defaultClient = GraduwayOpenApi.ApiClient.instance;

// Configure API key authorization: GraduwayApiAuthentication
var GraduwayApiAuthentication = defaultClient.authentications['GraduwayApiAuthentication'];
GraduwayApiAuthentication.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//GraduwayApiAuthentication.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new GraduwayOpenApi.UsersuserIdApi()
var platformId = 56; // {{Integer}} 
var platformName = platformName_example; // {{String}} 
var xApiKey = xApiKey_example; // {{String}} 
var contentType = contentType_example; // {{String}} 
var userId = 56; // {{Integer}} User Id generated by our system

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRegisteredUser(platformId, platformName, xApiKey, contentType, userId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRegisteredUserExample
    {
        public void main()
        {

            // Configure API key authorization: GraduwayApiAuthentication
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");

            var apiInstance = new UsersuserIdApi();
            var platformId = 56;  // Integer | 
            var platformName = platformName_example;  // String | 
            var xApiKey = xApiKey_example;  // String | 
            var contentType = contentType_example;  // String | 
            var userId = 56;  // Integer | User Id generated by our system

            try
            {
                // Deletes a registered user from the platform
                apiInstance.deleteRegisteredUser(platformId, platformName, xApiKey, contentType, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersuserIdApi.deleteRegisteredUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: GraduwayApiAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\ApiUsersuserIdApi();
$platformId = 56; // Integer | 
$platformName = platformName_example; // String | 
$xApiKey = xApiKey_example; // String | 
$contentType = contentType_example; // String | 
$userId = 56; // Integer | User Id generated by our system

try {
    $api_instance->deleteRegisteredUser($platformId, $platformName, $xApiKey, $contentType, $userId);
} catch (Exception $e) {
    echo 'Exception when calling UsersuserIdApi->deleteRegisteredUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersuserIdApi;

# Configure API key authorization: GraduwayApiAuthentication
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersuserIdApi->new();
my $platformId = 56; # Integer | 
my $platformName = platformName_example; # String | 
my $xApiKey = xApiKey_example; # String | 
my $contentType = contentType_example; # String | 
my $userId = 56; # Integer | User Id generated by our system

eval { 
    $api_instance->deleteRegisteredUser(platformId => $platformId, platformName => $platformName, xApiKey => $xApiKey, contentType => $contentType, userId => $userId);
};
if ($@) {
    warn "Exception when calling UsersuserIdApi->deleteRegisteredUser: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: GraduwayApiAuthentication
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersuserIdApi()
platformId = 56 # Integer | 
platformName = platformName_example # String | 
xApiKey = xApiKey_example # String | 
contentType = contentType_example # String | 
userId = 56 # Integer | User Id generated by our system

try: 
    # Deletes a registered user from the platform
    api_instance.delete_registered_user(platformId, platformName, xApiKey, contentType, userId)
except ApiException as e:
    print("Exception when calling UsersuserIdApi->deleteRegisteredUser: %s\n" % e)

Parameters

Header parameters

Name	Description
platform_id*	Integer (int32) Required
platform_name*	String Required
x-api-key*	String Required
Content-Type*	String Required

Query parameters

Name	Description
user_id*	Integer (int32) User Id generated by our system Required

Graduway Open API

API and SDK Documentation

Graduway Data API 1.0.0 - Graduway API for data management

Overview

Authentication

Responses

Token

getToken

Usage and SDK Samples

Parameters

Responses

Status: 200 - private api key

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

Users

addPrepopulated

Usage and SDK Samples

Parameters

Responses

Status: 201 - item created

Status: 400 - invalid input object invalid

Status: 401 - Unauthorized

Status: 409 - an existing item already exists

searchPrepopulatedUsers

Usage and SDK Samples

Parameters

Responses

Status: 200 - search results matching criteria

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

searchRegisteredUsers

Usage and SDK Samples

Parameters

Responses

Status: 200 - search results matching criteria

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

updateRegisteredUser

Usage and SDK Samples

Parameters

Responses

Status: 200 - Updated data

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists

UsersuserId

deleteRegisteredUser

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad input parameter

Status: 401 - Unauthorized

Status: 404 - no such endpoint exists