Babel Obfuscator & Licensing Documentation

GET`/v1/api-keys`GET /v1/api-keys

Code samples

cURL


# You can also use wget
curl -X GET /v1/api-keys \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/api-keys',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/api-keys";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/api-keys

Gets the API keys based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","apiKeys":[{"id":0,"name":"string","key":"string","clientSecret":"string","createdDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","ownerId":"string","revoked":true,"permissions":0,"description":"string"}],"totalApiKeysCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "apiKeys": [
    {
      "id": 0,
      "name": "string",
      "key": "string",
      "clientSecret": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "revoked": true,
      "permissions": 0,
      "description": "string"
    }
  ],
  "totalApiKeysCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetApiKeysResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/api-keys`POST /v1/api-keys

Code samples

cURL


# You can also use wget
curl -X POST /v1/api-keys \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "apiKey": {
    "id": 0,
    "name": "string",
    "key": "string",
    "clientSecret": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "revoked": true,
    "permissions": 0,
    "description": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/api-keys',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/api-keys";
      
      string json = @"{
  ""apiKey"": {
    ""id"": 0,
    ""name"": ""string"",
    ""key"": ""string"",
    ""clientSecret"": ""string"",
    ""createdDate"": ""2019-08-24T14:15:22Z"",
    ""expireDate"": ""2019-08-24T14:15:22Z"",
    ""ownerId"": ""string"",
    ""revoked"": true,
    ""permissions"": 0,
    ""description"": ""string""
  }
}";
      Management.InsertApiKeyRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertApiKeyRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertApiKeyRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/api-keys

Inserts a new API key.

Body parameter


{
  "apiKey": {
    "id": 0,
    "name": "string",
    "key": "string",
    "clientSecret": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "revoked": true,
    "permissions": 0,
    "description": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertApiKeyRequest	false	The request containing the API key to insert.

Example responses

200 Response


{"apiKeyId":0,"success":true,"code":0,"message":"string","apiKey":"string"}


{
  "apiKeyId": 0,
  "success": true,
  "code": 0,
  "message": "string",
  "apiKey": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertApiKeyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/api-keys`PUT /v1/api-keys

Code samples

cURL


# You can also use wget
curl -X PUT /v1/api-keys \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "apiKey": {
    "id": 0,
    "name": "string",
    "key": "string",
    "clientSecret": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "revoked": true,
    "permissions": 0,
    "description": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/api-keys',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/api-keys";
 
      
      string json = @"{
  ""apiKey"": {
    ""id"": 0,
    ""name"": ""string"",
    ""key"": ""string"",
    ""clientSecret"": ""string"",
    ""createdDate"": ""2019-08-24T14:15:22Z"",
    ""expireDate"": ""2019-08-24T14:15:22Z"",
    ""ownerId"": ""string"",
    ""revoked"": true,
    ""permissions"": 0,
    ""description"": ""string""
  }
}";
      Management.UpdateApiKeyRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateApiKeyRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateApiKeyRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/api-keys

Updates the API key with the specified ID.

Body parameter


{
  "apiKey": {
    "id": 0,
    "name": "string",
    "key": "string",
    "clientSecret": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "revoked": true,
    "permissions": 0,
    "description": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateApiKeyRequest	false	The request containing the API key to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateApiKeyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/api-keys/{apiKeyId}`DELETE /v1/api-keys/{apiKeyId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/api-keys/{apiKeyId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/api-keys/{apiKeyId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/api-keys/{apiKeyId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/api-keys/\{apiKeyId\}

Deletes the API key with the specified ID.

Parameters

Name	In	Type	Required	Description
apiKeyId	path	integer(int32)	true	The ID of the API key to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteApiKeyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/users`GET /v1/users

Code samples

cURL


# You can also use wget
curl -X GET /v1/users \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/users";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/users

Gets the users based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
roles	query	string	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","users":[{"id":"string","userName":"string","email":"string","phoneNumber":"string","title":"string","firstName":"string","lastName":"string","department":"string","birthDate":"2019-08-24T14:15:22Z","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","lastDismissMessages":"2019-08-24T14:15:22Z","lastLogIn":"2019-08-24T14:15:22Z","rank":0,"image":"string","address":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mobile":"string","notes":"string","customerId":0,"roles":["string"],"apiKeys":[{"id":0,"name":"string","key":"string","clientSecret":"string","createdDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","ownerId":"string","revoked":true,"permissions":0,"description":"string"}],"settings":[{"id":0,"category":"string","group":"string","name":"string","value":"string","type":"string","description":"string","readOnly":true,"userId":"string"}]}],"totalUsersCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "users": [
    {
      "id": "string",
      "userName": "string",
      "email": "string",
      "phoneNumber": "string",
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "department": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "lastDismissMessages": "2019-08-24T14:15:22Z",
      "lastLogIn": "2019-08-24T14:15:22Z",
      "rank": 0,
      "image": "string",
      "address": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mobile": "string",
      "notes": "string",
      "customerId": 0,
      "roles": [
        "string"
      ],
      "apiKeys": [
        {
          "id": 0,
          "name": "string",
          "key": "string",
          "clientSecret": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "expireDate": "2019-08-24T14:15:22Z",
          "ownerId": "string",
          "revoked": true,
          "permissions": 0,
          "description": "string"
        }
      ],
      "settings": [
        {
          "id": 0,
          "category": "string",
          "group": "string",
          "name": "string",
          "value": "string",
          "type": "string",
          "description": "string",
          "readOnly": true,
          "userId": "string"
        }
      ]
    }
  ],
  "totalUsersCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetUsersResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/users`POST /v1/users

Code samples

cURL


# You can also use wget
curl -X POST /v1/users \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/users";
      
      string json = @"{
  ""user"": {
    ""id"": ""string"",
    ""userName"": ""string"",
    ""email"": ""string"",
    ""phoneNumber"": ""string"",
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""department"": ""string"",
    ""birthDate"": ""2019-08-24T14:15:22Z"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""lastDismissMessages"": ""2019-08-24T14:15:22Z"",
    ""lastLogIn"": ""2019-08-24T14:15:22Z"",
    ""rank"": 0,
    ""image"": ""string"",
    ""address"": ""string"",
    ""postalCode"": ""string"",
    ""region"": ""string"",
    ""city"": ""string"",
    ""country"": ""string"",
    ""countryCode"": ""string"",
    ""mobile"": ""string"",
    ""notes"": ""string"",
    ""customerId"": 0,
    ""roles"": [
      ""string""
    ],
    ""apiKeys"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""key"": ""string"",
        ""clientSecret"": ""string"",
        ""createdDate"": ""2019-08-24T14:15:22Z"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""ownerId"": ""string"",
        ""revoked"": true,
        ""permissions"": 0,
        ""description"": ""string""
      }
    ],
    ""settings"": [
      {
        ""id"": 0,
        ""category"": ""string"",
        ""group"": ""string"",
        ""name"": ""string"",
        ""value"": ""string"",
        ""type"": ""string"",
        ""description"": ""string"",
        ""readOnly"": true,
        ""userId"": ""string""
      }
    ]
  },
  ""password"": ""string""
}";
      Management.InsertUserRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertUserRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertUserRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/users

Inserts a new user.

Body parameter


{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertUserRequest	false	The request containing the user to insert.

Example responses

200 Response


{"userId":"string","success":true,"code":0,"message":"string"}


{
  "userId": "string",
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertUserResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/users`PUT /v1/users

Code samples

cURL


# You can also use wget
curl -X PUT /v1/users \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "currentPassword": "string",
  "newPassword": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/users";
 
      
      string json = @"{
  ""user"": {
    ""id"": ""string"",
    ""userName"": ""string"",
    ""email"": ""string"",
    ""phoneNumber"": ""string"",
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""department"": ""string"",
    ""birthDate"": ""2019-08-24T14:15:22Z"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""lastDismissMessages"": ""2019-08-24T14:15:22Z"",
    ""lastLogIn"": ""2019-08-24T14:15:22Z"",
    ""rank"": 0,
    ""image"": ""string"",
    ""address"": ""string"",
    ""postalCode"": ""string"",
    ""region"": ""string"",
    ""city"": ""string"",
    ""country"": ""string"",
    ""countryCode"": ""string"",
    ""mobile"": ""string"",
    ""notes"": ""string"",
    ""customerId"": 0,
    ""roles"": [
      ""string""
    ],
    ""apiKeys"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""key"": ""string"",
        ""clientSecret"": ""string"",
        ""createdDate"": ""2019-08-24T14:15:22Z"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""ownerId"": ""string"",
        ""revoked"": true,
        ""permissions"": 0,
        ""description"": ""string""
      }
    ],
    ""settings"": [
      {
        ""id"": 0,
        ""category"": ""string"",
        ""group"": ""string"",
        ""name"": ""string"",
        ""value"": ""string"",
        ""type"": ""string"",
        ""description"": ""string"",
        ""readOnly"": true,
        ""userId"": ""string""
      }
    ]
  },
  ""currentPassword"": ""string"",
  ""newPassword"": ""string""
}";
      Management.UpdateUserRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateUserRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateUserRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/users

Updates a user.

Body parameter


{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "currentPassword": "string",
  "newPassword": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateUserRequest	false	The request containing the user to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateUserResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/users/{userId}`DELETE /v1/users/{userId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/users/{userId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/users/\{userId\}

Deletes a user.

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The ID of the user to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteUserResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/users/{userId}/settings`GET /v1/users/{userId}/settings

Code samples

cURL


# You can also use wget
curl -X GET /v1/users/{userId}/settings \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/users/{userId}/settings";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/users/\{userId\}/settings

Retrieves the user settings based on the provided request.

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","settings":[{"id":0,"category":"string","group":"string","name":"string","value":"string","type":"string","description":"string","readOnly":true,"userId":"string"}],"totalSettingsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "settings": [
    {
      "id": 0,
      "category": "string",
      "group": "string",
      "name": "string",
      "value": "string",
      "type": "string",
      "description": "string",
      "readOnly": true,
      "userId": "string"
    }
  ],
  "totalSettingsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetUserSettingsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/users/{userId}/settings`POST /v1/users/{userId}/settings

Code samples

cURL


# You can also use wget
curl -X POST /v1/users/{userId}/settings \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/users/{userId}/settings";
      
      string json = @"{
  ""setting"": {
    ""id"": 0,
    ""category"": ""string"",
    ""group"": ""string"",
    ""name"": ""string"",
    ""value"": ""string"",
    ""type"": ""string"",
    ""description"": ""string"",
    ""readOnly"": true,
    ""userId"": ""string""
  }
}";
      Management.InsertUserSettingRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertUserSettingRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertUserSettingRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/users/\{userId\}/settings

Inserts new user settings based on the provided request.

Body parameter


{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
body	body	Management.InsertUserSettingRequest	false	The request containing the user settings to insert.

Example responses

200 Response


{"settingId":0,"success":true,"code":0,"message":"string"}


{
  "settingId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertUserSettingResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/users/{userId}/settings`PUT /v1/users/{userId}/settings

Code samples

cURL


# You can also use wget
curl -X PUT /v1/users/{userId}/settings \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}/settings";
 
      
      string json = @"{
  ""setting"": {
    ""id"": 0,
    ""category"": ""string"",
    ""group"": ""string"",
    ""name"": ""string"",
    ""value"": ""string"",
    ""type"": ""string"",
    ""description"": ""string"",
    ""readOnly"": true,
    ""userId"": ""string""
  }
}";
      Management.UpdateUserSettingRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateUserSettingRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateUserSettingRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/users/\{userId\}/settings

Updates user settings based on the provided request.

Body parameter


{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
body	body	Management.UpdateUserSettingRequest	false	The request containing the user settings to update.

Example responses

200 Response


{"settingsId":0,"success":true,"code":0,"message":"string"}


{
  "settingsId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateUserSettingResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/users/{userId}/settings/{settingId}`DELETE /v1/users/{userId}/settings/{settingId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/users/{userId}/settings/{settingId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings/{settingId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}/settings/{settingId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/users/\{userId\}/settings/\{settingId\}

Deletes user settings based on the provided request.

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
settingId	path	integer(int32)	true	The setting ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteUserSettingResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/roles`GET /v1/roles

Code samples

cURL


# You can also use wget
curl -X GET /v1/roles \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/roles',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/roles";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/roles

Retrieves roles based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","roles":[{"id":"string","name":"string","description":"string"}],"totalRolesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "totalRolesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetRolesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/users/{userId}/roles`GET /v1/users/{userId}/roles

Code samples

cURL


# You can also use wget
curl -X GET /v1/users/{userId}/roles \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/roles',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/users/{userId}/roles";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/users/\{userId\}/roles

Retrieves the roles of a specific user based on the provided request.

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","roles":[{"id":"string","name":"string","description":"string"}],"totalRolesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "totalRolesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetUserRolesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/users/{userId}/roles`POST /v1/users/{userId}/roles

Code samples

cURL


# You can also use wget
curl -X POST /v1/users/{userId}/roles \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "roles": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/users/{userId}/roles";
      
      string json = @"{
  ""roles"": ""string""
}";
      Management.AddUserToRoleRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.AddUserToRoleRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.AddUserToRoleRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/users/\{userId\}/roles

Adds a user to the specified roles.

Body parameter


{
  "roles": "string"
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
body	body	Management.AddUserToRoleRequest	false	The request containing the user ID and the roles to add.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.AddUserToRoleResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/users/{userId}/roles`DELETE /v1/users/{userId}/roles

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/users/{userId}/roles \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "roles": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/roles',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}/roles";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/users/\{userId\}/roles

Removes a user from the specified roles.

Body parameter


{
  "roles": "string"
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
body	body	Management.RemoveUserFromRoleRequest	false	The request containing the user ID and the roles to remove.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.RemoveUserFromRoleResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/assemblies`GET /v1/assemblies

Code samples

cURL


# You can also use wget
curl -X GET /v1/assemblies \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/assemblies',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/assemblies";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/assemblies

Retrieves the assemblies based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"totalAssembliesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "assemblies": [
    {
      "id": 0,
      "name": "string",
      "version": "string",
      "culture": "string",
      "publicKeyToken": "string",
      "mappingFileId": 0,
      "debugSymbolsKey": "string"
    }
  ],
  "totalAssembliesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetAssembliesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/assemblies`POST /v1/assemblies

Code samples

cURL


# You can also use wget
curl -X POST /v1/assemblies \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/assemblies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/assemblies";
      
      string json = @"{
  ""assembly"": {
    ""id"": 0,
    ""name"": ""string"",
    ""version"": ""string"",
    ""culture"": ""string"",
    ""publicKeyToken"": ""string"",
    ""mappingFileId"": 0,
    ""debugSymbolsKey"": ""string""
  }
}";
      Management.InsertAssemblyRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertAssemblyRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertAssemblyRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/assemblies

Inserts a new assembly based on the provided request parameters.

Body parameter


{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertAssemblyRequest	false	The request containing the assembly to insert.

Example responses

200 Response


{"assemblyId":0,"success":true,"code":0,"message":"string"}


{
  "assemblyId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertAssemblyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/assemblies`PUT /v1/assemblies

Code samples

cURL


# You can also use wget
curl -X PUT /v1/assemblies \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/assemblies',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/assemblies";
 
      
      string json = @"{
  ""assembly"": {
    ""id"": 0,
    ""name"": ""string"",
    ""version"": ""string"",
    ""culture"": ""string"",
    ""publicKeyToken"": ""string"",
    ""mappingFileId"": 0,
    ""debugSymbolsKey"": ""string""
  }
}";
      Management.UpdateAssemblyRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateAssemblyRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateAssemblyRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/assemblies

Updates an existing assembly based on the provided request parameters.

Body parameter


{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateAssemblyRequest	false	The request containing the assembly to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateAssemblyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/assemblies/{assemblyId}`DELETE /v1/assemblies/{assemblyId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/assemblies/{assemblyId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/assemblies/{assemblyId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/assemblies/{assemblyId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/assemblies/\{assemblyId\}

Deletes an existing assembly based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
assemblyId	path	integer(int32)	true	The ID of the assembly to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteAssemblyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/licenses`GET /v1/licenses

Code samples

cURL


# You can also use wget
curl -X GET /v1/licenses \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/licenses";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/licenses

Retrieves licenses based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenses":[{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicensesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenses": [
    {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicensesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLicensesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/licenses`POST /v1/licenses

Code samples

cURL


# You can also use wget
curl -X POST /v1/licenses \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "license": {
    "id": 0,
    "licenseId": "string",
    "licenseType": "string",
    "format": 0,
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "issueDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "supportExpireDate": "2019-08-24T14:15:22Z",
    "revoked": true,
    "trace": true,
    "licenseKey": "string",
    "maxAllowedSites": 0,
    "userKey": "string",
    "licensingMode": 0,
    "licenseeName": "string",
    "licenseeCompany": "string",
    "licenseeEmail": "string",
    "hash": "string",
    "meta": "string",
    "templateId": 0,
    "signatureKeysId": 0,
    "customerId": 0,
    "orderId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    },
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "template": {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    },
    "licensee": {
      "name": "string",
      "company": "string",
      "contactInfo": "string",
      "url": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/licenses";
      
      string json = @"{
  ""license"": {
    ""id"": 0,
    ""licenseId"": ""string"",
    ""licenseType"": ""string"",
    ""format"": 0,
    ""description"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""issueDate"": ""2019-08-24T14:15:22Z"",
    ""expireDate"": ""2019-08-24T14:15:22Z"",
    ""supportExpireDate"": ""2019-08-24T14:15:22Z"",
    ""revoked"": true,
    ""trace"": true,
    ""licenseKey"": ""string"",
    ""maxAllowedSites"": 0,
    ""userKey"": ""string"",
    ""licensingMode"": 0,
    ""licenseeName"": ""string"",
    ""licenseeCompany"": ""string"",
    ""licenseeEmail"": ""string"",
    ""hash"": ""string"",
    ""meta"": ""string"",
    ""templateId"": 0,
    ""signatureKeysId"": 0,
    ""customerId"": 0,
    ""orderId"": 0,
    ""product"": {
      ""id"": ""string"",
      ""name"": ""string"",
      ""version"": ""string"",
      ""copyright"": ""string"",
      ""url"": ""string"",
      ""description"": ""string""
    },
    ""order"": {
      ""id"": 0,
      ""orderNumber"": ""string"",
      ""status"": ""string"",
      ""processedBy"": ""string"",
      ""purchaseOrder"": ""string"",
      ""total"": 0.1,
      ""currency"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""invoiceNumber"": ""string"",
      ""paymentType"": ""string"",
      ""paymentNumber"": ""string"",
      ""paymentStatus"": ""string"",
      ""paymentDate"": ""2019-08-24T14:15:22Z"",
      ""description"": ""string"",
      ""customerId"": 0,
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""resellerId"": 0
    },
    ""customer"": {
      ""id"": 0,
      ""title"": ""string"",
      ""firstName"": ""string"",
      ""lastName"": ""string"",
      ""company"": ""string"",
      ""code"": ""string"",
      ""vatCode"": ""string"",
      ""invoiceCode"": ""string"",
      ""rating"": 0,
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""address"": ""string"",
      ""address1"": ""string"",
      ""address2"": ""string"",
      ""postalCode"": ""string"",
      ""region"": ""string"",
      ""city"": ""string"",
      ""country"": ""string"",
      ""countryCode"": ""string"",
      ""mapCoordinates"": ""string"",
      ""mapZoomLevel"": 0.1,
      ""email"": ""string"",
      ""phone"": ""string"",
      ""mobile"": ""string"",
      ""fax"": ""string"",
      ""website"": ""string"",
      ""notes"": ""string"",
      ""isReseller"": true,
      ""image"": ""string"",
      ""meta"": ""string"",
      ""contacts"": [
        {
          ""id"": 0,
          ""title"": ""string"",
          ""firstName"": ""string"",
          ""lastName"": ""string"",
          ""email"": ""string"",
          ""phone"": ""string"",
          ""mobile"": ""string"",
          ""fax"": ""string"",
          ""details"": ""string"",
          ""notify"": true,
          ""customerId"": 0,
          ""meta"": ""string""
        }
      ]
    },
    ""template"": {
      ""id"": 0,
      ""name"": ""string"",
      ""code"": ""string"",
      ""licenseType"": ""string"",
      ""format"": 0,
      ""licensingMode"": 0,
      ""licenseFileName"": ""string"",
      ""issueDate"": true,
      ""expireDays"": 0,
      ""supportDays"": 0,
      ""generateKeyInfo"": true,
      ""userKey"": ""string"",
      ""description"": ""string"",
      ""template"": ""string"",
      ""productId"": 0,
      ""signatureKeysId"": 0,
      ""releaseId"": 0,
      ""product"": {
        ""id"": ""string"",
        ""name"": ""string"",
        ""version"": ""string"",
        ""copyright"": ""string"",
        ""url"": ""string"",
        ""description"": ""string""
      },
      ""components"": [
        ""string""
      ],
      ""assemblies"": [
        {
          ""id"": 0,
          ""name"": ""string"",
          ""version"": ""string"",
          ""culture"": ""string"",
          ""publicKeyToken"": ""string"",
          ""mappingFileId"": 0,
          ""debugSymbolsKey"": ""string""
        }
      ],
      ""fields"": [
        {
          ""name"": ""string"",
          ""value"": ""string""
        }
      ],
      ""features"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""description"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""key"": ""string"",
          ""data"": ""string""
        }
      ],
      ""restrictions"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""properties"": {
            ""property1"": ""string"",
            ""property2"": ""string""
          },
          ""customXmlContent"": ""string""
        }
      ]
    },
    ""licensee"": {
      ""name"": ""string"",
      ""company"": ""string"",
      ""contactInfo"": ""string"",
      ""url"": ""string""
    },
    ""components"": [
      ""string""
    ],
    ""assemblies"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""version"": ""string"",
        ""culture"": ""string"",
        ""publicKeyToken"": ""string"",
        ""mappingFileId"": 0,
        ""debugSymbolsKey"": ""string""
      }
    ],
    ""fields"": [
      {
        ""name"": ""string"",
        ""value"": ""string""
      }
    ],
    ""features"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""description"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""key"": ""string"",
        ""data"": ""string""
      }
    ],
    ""restrictions"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""properties"": {
          ""property1"": ""string"",
          ""property2"": ""string""
        },
        ""customXmlContent"": ""string""
      }
    ]
  }
}";
      Management.InsertLicenseRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertLicenseRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertLicenseRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/licenses

Inserts a new license based on the provided request parameters.

Body parameter


{
  "license": {
    "id": 0,
    "licenseId": "string",
    "licenseType": "string",
    "format": 0,
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "issueDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "supportExpireDate": "2019-08-24T14:15:22Z",
    "revoked": true,
    "trace": true,
    "licenseKey": "string",
    "maxAllowedSites": 0,
    "userKey": "string",
    "licensingMode": 0,
    "licenseeName": "string",
    "licenseeCompany": "string",
    "licenseeEmail": "string",
    "hash": "string",
    "meta": "string",
    "templateId": 0,
    "signatureKeysId": 0,
    "customerId": 0,
    "orderId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    },
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "template": {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    },
    "licensee": {
      "name": "string",
      "company": "string",
      "contactInfo": "string",
      "url": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertLicenseRequest	false	The request containing the parameters for inserting a license.

Example responses

200 Response


{"licenseId":0,"success":true,"code":0,"message":"string","licenseKeyId":"string","userKey":"string","licenseKey":"string"}


{
  "licenseId": 0,
  "success": true,
  "code": 0,
  "message": "string",
  "licenseKeyId": "string",
  "userKey": "string",
  "licenseKey": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertLicenseResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/licenses`PUT /v1/licenses

Code samples

cURL


# You can also use wget
curl -X PUT /v1/licenses \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "license": {
    "id": 0,
    "licenseId": "string",
    "licenseType": "string",
    "format": 0,
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "issueDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "supportExpireDate": "2019-08-24T14:15:22Z",
    "revoked": true,
    "trace": true,
    "licenseKey": "string",
    "maxAllowedSites": 0,
    "userKey": "string",
    "licensingMode": 0,
    "licenseeName": "string",
    "licenseeCompany": "string",
    "licenseeEmail": "string",
    "hash": "string",
    "meta": "string",
    "templateId": 0,
    "signatureKeysId": 0,
    "customerId": 0,
    "orderId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    },
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "template": {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    },
    "licensee": {
      "name": "string",
      "company": "string",
      "contactInfo": "string",
      "url": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/licenses";
 
      
      string json = @"{
  ""license"": {
    ""id"": 0,
    ""licenseId"": ""string"",
    ""licenseType"": ""string"",
    ""format"": 0,
    ""description"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""issueDate"": ""2019-08-24T14:15:22Z"",
    ""expireDate"": ""2019-08-24T14:15:22Z"",
    ""supportExpireDate"": ""2019-08-24T14:15:22Z"",
    ""revoked"": true,
    ""trace"": true,
    ""licenseKey"": ""string"",
    ""maxAllowedSites"": 0,
    ""userKey"": ""string"",
    ""licensingMode"": 0,
    ""licenseeName"": ""string"",
    ""licenseeCompany"": ""string"",
    ""licenseeEmail"": ""string"",
    ""hash"": ""string"",
    ""meta"": ""string"",
    ""templateId"": 0,
    ""signatureKeysId"": 0,
    ""customerId"": 0,
    ""orderId"": 0,
    ""product"": {
      ""id"": ""string"",
      ""name"": ""string"",
      ""version"": ""string"",
      ""copyright"": ""string"",
      ""url"": ""string"",
      ""description"": ""string""
    },
    ""order"": {
      ""id"": 0,
      ""orderNumber"": ""string"",
      ""status"": ""string"",
      ""processedBy"": ""string"",
      ""purchaseOrder"": ""string"",
      ""total"": 0.1,
      ""currency"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""invoiceNumber"": ""string"",
      ""paymentType"": ""string"",
      ""paymentNumber"": ""string"",
      ""paymentStatus"": ""string"",
      ""paymentDate"": ""2019-08-24T14:15:22Z"",
      ""description"": ""string"",
      ""customerId"": 0,
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""resellerId"": 0
    },
    ""customer"": {
      ""id"": 0,
      ""title"": ""string"",
      ""firstName"": ""string"",
      ""lastName"": ""string"",
      ""company"": ""string"",
      ""code"": ""string"",
      ""vatCode"": ""string"",
      ""invoiceCode"": ""string"",
      ""rating"": 0,
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""address"": ""string"",
      ""address1"": ""string"",
      ""address2"": ""string"",
      ""postalCode"": ""string"",
      ""region"": ""string"",
      ""city"": ""string"",
      ""country"": ""string"",
      ""countryCode"": ""string"",
      ""mapCoordinates"": ""string"",
      ""mapZoomLevel"": 0.1,
      ""email"": ""string"",
      ""phone"": ""string"",
      ""mobile"": ""string"",
      ""fax"": ""string"",
      ""website"": ""string"",
      ""notes"": ""string"",
      ""isReseller"": true,
      ""image"": ""string"",
      ""meta"": ""string"",
      ""contacts"": [
        {
          ""id"": 0,
          ""title"": ""string"",
          ""firstName"": ""string"",
          ""lastName"": ""string"",
          ""email"": ""string"",
          ""phone"": ""string"",
          ""mobile"": ""string"",
          ""fax"": ""string"",
          ""details"": ""string"",
          ""notify"": true,
          ""customerId"": 0,
          ""meta"": ""string""
        }
      ]
    },
    ""template"": {
      ""id"": 0,
      ""name"": ""string"",
      ""code"": ""string"",
      ""licenseType"": ""string"",
      ""format"": 0,
      ""licensingMode"": 0,
      ""licenseFileName"": ""string"",
      ""issueDate"": true,
      ""expireDays"": 0,
      ""supportDays"": 0,
      ""generateKeyInfo"": true,
      ""userKey"": ""string"",
      ""description"": ""string"",
      ""template"": ""string"",
      ""productId"": 0,
      ""signatureKeysId"": 0,
      ""releaseId"": 0,
      ""product"": {
        ""id"": ""string"",
        ""name"": ""string"",
        ""version"": ""string"",
        ""copyright"": ""string"",
        ""url"": ""string"",
        ""description"": ""string""
      },
      ""components"": [
        ""string""
      ],
      ""assemblies"": [
        {
          ""id"": 0,
          ""name"": ""string"",
          ""version"": ""string"",
          ""culture"": ""string"",
          ""publicKeyToken"": ""string"",
          ""mappingFileId"": 0,
          ""debugSymbolsKey"": ""string""
        }
      ],
      ""fields"": [
        {
          ""name"": ""string"",
          ""value"": ""string""
        }
      ],
      ""features"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""description"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""key"": ""string"",
          ""data"": ""string""
        }
      ],
      ""restrictions"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""properties"": {
            ""property1"": ""string"",
            ""property2"": ""string""
          },
          ""customXmlContent"": ""string""
        }
      ]
    },
    ""licensee"": {
      ""name"": ""string"",
      ""company"": ""string"",
      ""contactInfo"": ""string"",
      ""url"": ""string""
    },
    ""components"": [
      ""string""
    ],
    ""assemblies"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""version"": ""string"",
        ""culture"": ""string"",
        ""publicKeyToken"": ""string"",
        ""mappingFileId"": 0,
        ""debugSymbolsKey"": ""string""
      }
    ],
    ""fields"": [
      {
        ""name"": ""string"",
        ""value"": ""string""
      }
    ],
    ""features"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""description"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""key"": ""string"",
        ""data"": ""string""
      }
    ],
    ""restrictions"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""properties"": {
          ""property1"": ""string"",
          ""property2"": ""string""
        },
        ""customXmlContent"": ""string""
      }
    ]
  }
}";
      Management.UpdateLicenseRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateLicenseRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateLicenseRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/licenses

Updates an existing license based on the provided request parameters.

Body parameter


{
  "license": {
    "id": 0,
    "licenseId": "string",
    "licenseType": "string",
    "format": 0,
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "issueDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "supportExpireDate": "2019-08-24T14:15:22Z",
    "revoked": true,
    "trace": true,
    "licenseKey": "string",
    "maxAllowedSites": 0,
    "userKey": "string",
    "licensingMode": 0,
    "licenseeName": "string",
    "licenseeCompany": "string",
    "licenseeEmail": "string",
    "hash": "string",
    "meta": "string",
    "templateId": 0,
    "signatureKeysId": 0,
    "customerId": 0,
    "orderId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    },
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "template": {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    },
    "licensee": {
      "name": "string",
      "company": "string",
      "contactInfo": "string",
      "url": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateLicenseRequest	false	The request containing the parameters for updating a license.

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseKeyId":"string","userKey":"string","licenseKey":"string"}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseKeyId": "string",
  "userKey": "string",
  "licenseKey": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateLicenseResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/licenses/{licenseId}`DELETE /v1/licenses/{licenseId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/licenses/{licenseId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses/{licenseId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/licenses/{licenseId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/licenses/\{licenseId\}

Deletes an existing license based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
licenseId	path	integer(int32)	true	The license ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteLicenseResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/license-tokens`GET /v1/license-tokens

Code samples

cURL


# You can also use wget
curl -X GET /v1/license-tokens \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-tokens',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/license-tokens";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/license-tokens

Retrieves license tokens based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
countOnly	query	boolean	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseTokens":[{"id":0,"token":"string","address":"string","clientId":"string","clientName":"string","machineId":"string","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","lastHeartbeat":"2019-08-24T14:15:22Z","hash":"string","licenseId":0,"license":{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"nodeLockedLicenseId":0,"nodeLockedLicense":{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}}],"licenseTokensCount":0,"totalLicenseTokensCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseTokens": [
    {
      "id": 0,
      "token": "string",
      "address": "string",
      "clientId": "string",
      "clientName": "string",
      "machineId": "string",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "lastHeartbeat": "2019-08-24T14:15:22Z",
      "hash": "string",
      "licenseId": 0,
      "license": {
        "id": 0,
        "licenseId": "string",
        "licenseType": "string",
        "format": 0,
        "description": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "issueDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "supportExpireDate": "2019-08-24T14:15:22Z",
        "revoked": true,
        "trace": true,
        "licenseKey": "string",
        "maxAllowedSites": 0,
        "userKey": "string",
        "licensingMode": 0,
        "licenseeName": "string",
        "licenseeCompany": "string",
        "licenseeEmail": "string",
        "hash": "string",
        "meta": "string",
        "templateId": 0,
        "signatureKeysId": 0,
        "customerId": 0,
        "orderId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        },
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "template": {
          "id": 0,
          "name": "string",
          "code": "string",
          "licenseType": "string",
          "format": 0,
          "licensingMode": 0,
          "licenseFileName": "string",
          "issueDate": true,
          "expireDays": 0,
          "supportDays": 0,
          "generateKeyInfo": true,
          "userKey": "string",
          "description": "string",
          "template": "string",
          "productId": 0,
          "signatureKeysId": 0,
          "releaseId": 0,
          "product": {
            "id": "string",
            "name": "string",
            "version": "string",
            "copyright": "string",
            "url": "string",
            "description": "string"
          },
          "components": [
            "string"
          ],
          "assemblies": [
            {
              "id": 0,
              "name": "string",
              "version": "string",
              "culture": "string",
              "publicKeyToken": "string",
              "mappingFileId": 0,
              "debugSymbolsKey": "string"
            }
          ],
          "fields": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "features": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "key": "string",
              "data": "string"
            }
          ],
          "restrictions": [
            {
              "id": "string",
              "name": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "properties": {
                "property1": "string",
                "property2": "string"
              },
              "customXmlContent": "string"
            }
          ]
        },
        "licensee": {
          "name": "string",
          "company": "string",
          "contactInfo": "string",
          "url": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "nodeLockedLicenseId": 0,
      "nodeLockedLicense": {
        "id": 0,
        "licenseId": "string",
        "licenseType": "string",
        "format": 0,
        "description": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "issueDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "supportExpireDate": "2019-08-24T14:15:22Z",
        "revoked": true,
        "trace": true,
        "licenseKey": "string",
        "maxAllowedSites": 0,
        "userKey": "string",
        "licensingMode": 0,
        "licenseeName": "string",
        "licenseeCompany": "string",
        "licenseeEmail": "string",
        "hash": "string",
        "meta": "string",
        "templateId": 0,
        "signatureKeysId": 0,
        "customerId": 0,
        "orderId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        },
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "template": {
          "id": 0,
          "name": "string",
          "code": "string",
          "licenseType": "string",
          "format": 0,
          "licensingMode": 0,
          "licenseFileName": "string",
          "issueDate": true,
          "expireDays": 0,
          "supportDays": 0,
          "generateKeyInfo": true,
          "userKey": "string",
          "description": "string",
          "template": "string",
          "productId": 0,
          "signatureKeysId": 0,
          "releaseId": 0,
          "product": {
            "id": "string",
            "name": "string",
            "version": "string",
            "copyright": "string",
            "url": "string",
            "description": "string"
          },
          "components": [
            "string"
          ],
          "assemblies": [
            {
              "id": 0,
              "name": "string",
              "version": "string",
              "culture": "string",
              "publicKeyToken": "string",
              "mappingFileId": 0,
              "debugSymbolsKey": "string"
            }
          ],
          "fields": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "features": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "key": "string",
              "data": "string"
            }
          ],
          "restrictions": [
            {
              "id": "string",
              "name": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "properties": {
                "property1": "string",
                "property2": "string"
              },
              "customXmlContent": "string"
            }
          ]
        },
        "licensee": {
          "name": "string",
          "company": "string",
          "contactInfo": "string",
          "url": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      }
    }
  ],
  "licenseTokensCount": 0,
  "totalLicenseTokensCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLicenseTokensResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/licenses/{licenseId}/tokens`GET /v1/licenses/{licenseId}/tokens

Code samples

cURL


# You can also use wget
curl -X GET /v1/licenses/{licenseId}/tokens \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses/{licenseId}/tokens',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/licenses/{licenseId}/tokens";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/licenses/\{licenseId\}/tokens

Retrieves license tokens based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
licenseId	path	integer(int32)	true	The license ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
countOnly	query	boolean	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseTokens":[{"id":0,"token":"string","address":"string","clientId":"string","clientName":"string","machineId":"string","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","lastHeartbeat":"2019-08-24T14:15:22Z","hash":"string","licenseId":0,"license":{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"nodeLockedLicenseId":0,"nodeLockedLicense":{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}}],"licenseTokensCount":0,"totalLicenseTokensCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseTokens": [
    {
      "id": 0,
      "token": "string",
      "address": "string",
      "clientId": "string",
      "clientName": "string",
      "machineId": "string",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "lastHeartbeat": "2019-08-24T14:15:22Z",
      "hash": "string",
      "licenseId": 0,
      "license": {
        "id": 0,
        "licenseId": "string",
        "licenseType": "string",
        "format": 0,
        "description": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "issueDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "supportExpireDate": "2019-08-24T14:15:22Z",
        "revoked": true,
        "trace": true,
        "licenseKey": "string",
        "maxAllowedSites": 0,
        "userKey": "string",
        "licensingMode": 0,
        "licenseeName": "string",
        "licenseeCompany": "string",
        "licenseeEmail": "string",
        "hash": "string",
        "meta": "string",
        "templateId": 0,
        "signatureKeysId": 0,
        "customerId": 0,
        "orderId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        },
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "template": {
          "id": 0,
          "name": "string",
          "code": "string",
          "licenseType": "string",
          "format": 0,
          "licensingMode": 0,
          "licenseFileName": "string",
          "issueDate": true,
          "expireDays": 0,
          "supportDays": 0,
          "generateKeyInfo": true,
          "userKey": "string",
          "description": "string",
          "template": "string",
          "productId": 0,
          "signatureKeysId": 0,
          "releaseId": 0,
          "product": {
            "id": "string",
            "name": "string",
            "version": "string",
            "copyright": "string",
            "url": "string",
            "description": "string"
          },
          "components": [
            "string"
          ],
          "assemblies": [
            {
              "id": 0,
              "name": "string",
              "version": "string",
              "culture": "string",
              "publicKeyToken": "string",
              "mappingFileId": 0,
              "debugSymbolsKey": "string"
            }
          ],
          "fields": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "features": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "key": "string",
              "data": "string"
            }
          ],
          "restrictions": [
            {
              "id": "string",
              "name": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "properties": {
                "property1": "string",
                "property2": "string"
              },
              "customXmlContent": "string"
            }
          ]
        },
        "licensee": {
          "name": "string",
          "company": "string",
          "contactInfo": "string",
          "url": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "nodeLockedLicenseId": 0,
      "nodeLockedLicense": {
        "id": 0,
        "licenseId": "string",
        "licenseType": "string",
        "format": 0,
        "description": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "issueDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "supportExpireDate": "2019-08-24T14:15:22Z",
        "revoked": true,
        "trace": true,
        "licenseKey": "string",
        "maxAllowedSites": 0,
        "userKey": "string",
        "licensingMode": 0,
        "licenseeName": "string",
        "licenseeCompany": "string",
        "licenseeEmail": "string",
        "hash": "string",
        "meta": "string",
        "templateId": 0,
        "signatureKeysId": 0,
        "customerId": 0,
        "orderId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        },
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "template": {
          "id": 0,
          "name": "string",
          "code": "string",
          "licenseType": "string",
          "format": 0,
          "licensingMode": 0,
          "licenseFileName": "string",
          "issueDate": true,
          "expireDays": 0,
          "supportDays": 0,
          "generateKeyInfo": true,
          "userKey": "string",
          "description": "string",
          "template": "string",
          "productId": 0,
          "signatureKeysId": 0,
          "releaseId": 0,
          "product": {
            "id": "string",
            "name": "string",
            "version": "string",
            "copyright": "string",
            "url": "string",
            "description": "string"
          },
          "components": [
            "string"
          ],
          "assemblies": [
            {
              "id": 0,
              "name": "string",
              "version": "string",
              "culture": "string",
              "publicKeyToken": "string",
              "mappingFileId": 0,
              "debugSymbolsKey": "string"
            }
          ],
          "fields": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "features": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "key": "string",
              "data": "string"
            }
          ],
          "restrictions": [
            {
              "id": "string",
              "name": "string",
              "expireDate": "2019-08-24T14:15:22Z",
              "properties": {
                "property1": "string",
                "property2": "string"
              },
              "customXmlContent": "string"
            }
          ]
        },
        "licensee": {
          "name": "string",
          "company": "string",
          "contactInfo": "string",
          "url": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      }
    }
  ],
  "licenseTokensCount": 0,
  "totalLicenseTokensCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLicenseTokensResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/licenses/{licenseId}/tokens`POST /v1/licenses/{licenseId}/tokens

Code samples

cURL


# You can also use wget
curl -X POST /v1/licenses/{licenseId}/tokens \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "licenseToken": {
    "id": 0,
    "token": "string",
    "address": "string",
    "clientId": "string",
    "clientName": "string",
    "machineId": "string",
    "issueDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "lastHeartbeat": "2019-08-24T14:15:22Z",
    "hash": "string",
    "licenseId": 0,
    "license": {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    },
    "nodeLockedLicenseId": 0,
    "nodeLockedLicense": {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses/{licenseId}/tokens',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/licenses/{licenseId}/tokens";
      
      string json = @"{
  ""licenseToken"": {
    ""id"": 0,
    ""token"": ""string"",
    ""address"": ""string"",
    ""clientId"": ""string"",
    ""clientName"": ""string"",
    ""machineId"": ""string"",
    ""issueDate"": ""2019-08-24T14:15:22Z"",
    ""expireDate"": ""2019-08-24T14:15:22Z"",
    ""lastHeartbeat"": ""2019-08-24T14:15:22Z"",
    ""hash"": ""string"",
    ""licenseId"": 0,
    ""license"": {
      ""id"": 0,
      ""licenseId"": ""string"",
      ""licenseType"": ""string"",
      ""format"": 0,
      ""description"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""issueDate"": ""2019-08-24T14:15:22Z"",
      ""expireDate"": ""2019-08-24T14:15:22Z"",
      ""supportExpireDate"": ""2019-08-24T14:15:22Z"",
      ""revoked"": true,
      ""trace"": true,
      ""licenseKey"": ""string"",
      ""maxAllowedSites"": 0,
      ""userKey"": ""string"",
      ""licensingMode"": 0,
      ""licenseeName"": ""string"",
      ""licenseeCompany"": ""string"",
      ""licenseeEmail"": ""string"",
      ""hash"": ""string"",
      ""meta"": ""string"",
      ""templateId"": 0,
      ""signatureKeysId"": 0,
      ""customerId"": 0,
      ""orderId"": 0,
      ""product"": {
        ""id"": ""string"",
        ""name"": ""string"",
        ""version"": ""string"",
        ""copyright"": ""string"",
        ""url"": ""string"",
        ""description"": ""string""
      },
      ""order"": {
        ""id"": 0,
        ""orderNumber"": ""string"",
        ""status"": ""string"",
        ""processedBy"": ""string"",
        ""purchaseOrder"": ""string"",
        ""total"": 0.1,
        ""currency"": ""string"",
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""invoiceNumber"": ""string"",
        ""paymentType"": ""string"",
        ""paymentNumber"": ""string"",
        ""paymentStatus"": ""string"",
        ""paymentDate"": ""2019-08-24T14:15:22Z"",
        ""description"": ""string"",
        ""customerId"": 0,
        ""customer"": {
          ""id"": 0,
          ""title"": ""string"",
          ""firstName"": ""string"",
          ""lastName"": ""string"",
          ""company"": ""string"",
          ""code"": ""string"",
          ""vatCode"": ""string"",
          ""invoiceCode"": ""string"",
          ""rating"": 0,
          ""createdAt"": ""2019-08-24T14:15:22Z"",
          ""updatedAt"": ""2019-08-24T14:15:22Z"",
          ""address"": ""string"",
          ""address1"": ""string"",
          ""address2"": ""string"",
          ""postalCode"": ""string"",
          ""region"": ""string"",
          ""city"": ""string"",
          ""country"": ""string"",
          ""countryCode"": ""string"",
          ""mapCoordinates"": ""string"",
          ""mapZoomLevel"": 0.1,
          ""email"": ""string"",
          ""phone"": ""string"",
          ""mobile"": ""string"",
          ""fax"": ""string"",
          ""website"": ""string"",
          ""notes"": ""string"",
          ""isReseller"": true,
          ""image"": ""string"",
          ""meta"": ""string"",
          ""contacts"": [
            {
              ""id"": 0,
              ""title"": ""string"",
              ""firstName"": ""string"",
              ""lastName"": ""string"",
              ""email"": ""string"",
              ""phone"": ""string"",
              ""mobile"": ""string"",
              ""fax"": ""string"",
              ""details"": ""string"",
              ""notify"": true,
              ""customerId"": 0,
              ""meta"": ""string""
            }
          ]
        },
        ""resellerId"": 0
      },
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""template"": {
        ""id"": 0,
        ""name"": ""string"",
        ""code"": ""string"",
        ""licenseType"": ""string"",
        ""format"": 0,
        ""licensingMode"": 0,
        ""licenseFileName"": ""string"",
        ""issueDate"": true,
        ""expireDays"": 0,
        ""supportDays"": 0,
        ""generateKeyInfo"": true,
        ""userKey"": ""string"",
        ""description"": ""string"",
        ""template"": ""string"",
        ""productId"": 0,
        ""signatureKeysId"": 0,
        ""releaseId"": 0,
        ""product"": {
          ""id"": ""string"",
          ""name"": ""string"",
          ""version"": ""string"",
          ""copyright"": ""string"",
          ""url"": ""string"",
          ""description"": ""string""
        },
        ""components"": [
          ""string""
        ],
        ""assemblies"": [
          {
            ""id"": 0,
            ""name"": ""string"",
            ""version"": ""string"",
            ""culture"": ""string"",
            ""publicKeyToken"": ""string"",
            ""mappingFileId"": 0,
            ""debugSymbolsKey"": ""string""
          }
        ],
        ""fields"": [
          {
            ""name"": ""string"",
            ""value"": ""string""
          }
        ],
        ""features"": [
          {
            ""id"": ""string"",
            ""name"": ""string"",
            ""description"": ""string"",
            ""expireDate"": ""2019-08-24T14:15:22Z"",
            ""key"": ""string"",
            ""data"": ""string""
          }
        ],
        ""restrictions"": [
          {
            ""id"": ""string"",
            ""name"": ""string"",
            ""expireDate"": ""2019-08-24T14:15:22Z"",
            ""properties"": {
              ""property1"": ""string"",
              ""property2"": ""string""
            },
            ""customXmlContent"": ""string""
          }
        ]
      },
      ""licensee"": {
        ""name"": ""string"",
        ""company"": ""string"",
        ""contactInfo"": ""string"",
        ""url"": ""string""
      },
      ""components"": [
        ""string""
      ],
      ""assemblies"": [
        {
          ""id"": 0,
          ""name"": ""string"",
          ""version"": ""string"",
          ""culture"": ""string"",
          ""publicKeyToken"": ""string"",
          ""mappingFileId"": 0,
          ""debugSymbolsKey"": ""string""
        }
      ],
      ""fields"": [
        {
          ""name"": ""string"",
          ""value"": ""string""
        }
      ],
      ""features"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""description"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""key"": ""string"",
          ""data"": ""string""
        }
      ],
      ""restrictions"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""properties"": {
            ""property1"": ""string"",
            ""property2"": ""string""
          },
          ""customXmlContent"": ""string""
        }
      ]
    },
    ""nodeLockedLicenseId"": 0,
    ""nodeLockedLicense"": {
      ""id"": 0,
      ""licenseId"": ""string"",
      ""licenseType"": ""string"",
      ""format"": 0,
      ""description"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""issueDate"": ""2019-08-24T14:15:22Z"",
      ""expireDate"": ""2019-08-24T14:15:22Z"",
      ""supportExpireDate"": ""2019-08-24T14:15:22Z"",
      ""revoked"": true,
      ""trace"": true,
      ""licenseKey"": ""string"",
      ""maxAllowedSites"": 0,
      ""userKey"": ""string"",
      ""licensingMode"": 0,
      ""licenseeName"": ""string"",
      ""licenseeCompany"": ""string"",
      ""licenseeEmail"": ""string"",
      ""hash"": ""string"",
      ""meta"": ""string"",
      ""templateId"": 0,
      ""signatureKeysId"": 0,
      ""customerId"": 0,
      ""orderId"": 0,
      ""product"": {
        ""id"": ""string"",
        ""name"": ""string"",
        ""version"": ""string"",
        ""copyright"": ""string"",
        ""url"": ""string"",
        ""description"": ""string""
      },
      ""order"": {
        ""id"": 0,
        ""orderNumber"": ""string"",
        ""status"": ""string"",
        ""processedBy"": ""string"",
        ""purchaseOrder"": ""string"",
        ""total"": 0.1,
        ""currency"": ""string"",
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""invoiceNumber"": ""string"",
        ""paymentType"": ""string"",
        ""paymentNumber"": ""string"",
        ""paymentStatus"": ""string"",
        ""paymentDate"": ""2019-08-24T14:15:22Z"",
        ""description"": ""string"",
        ""customerId"": 0,
        ""customer"": {
          ""id"": 0,
          ""title"": ""string"",
          ""firstName"": ""string"",
          ""lastName"": ""string"",
          ""company"": ""string"",
          ""code"": ""string"",
          ""vatCode"": ""string"",
          ""invoiceCode"": ""string"",
          ""rating"": 0,
          ""createdAt"": ""2019-08-24T14:15:22Z"",
          ""updatedAt"": ""2019-08-24T14:15:22Z"",
          ""address"": ""string"",
          ""address1"": ""string"",
          ""address2"": ""string"",
          ""postalCode"": ""string"",
          ""region"": ""string"",
          ""city"": ""string"",
          ""country"": ""string"",
          ""countryCode"": ""string"",
          ""mapCoordinates"": ""string"",
          ""mapZoomLevel"": 0.1,
          ""email"": ""string"",
          ""phone"": ""string"",
          ""mobile"": ""string"",
          ""fax"": ""string"",
          ""website"": ""string"",
          ""notes"": ""string"",
          ""isReseller"": true,
          ""image"": ""string"",
          ""meta"": ""string"",
          ""contacts"": [
            {
              ""id"": 0,
              ""title"": ""string"",
              ""firstName"": ""string"",
              ""lastName"": ""string"",
              ""email"": ""string"",
              ""phone"": ""string"",
              ""mobile"": ""string"",
              ""fax"": ""string"",
              ""details"": ""string"",
              ""notify"": true,
              ""customerId"": 0,
              ""meta"": ""string""
            }
          ]
        },
        ""resellerId"": 0
      },
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""template"": {
        ""id"": 0,
        ""name"": ""string"",
        ""code"": ""string"",
        ""licenseType"": ""string"",
        ""format"": 0,
        ""licensingMode"": 0,
        ""licenseFileName"": ""string"",
        ""issueDate"": true,
        ""expireDays"": 0,
        ""supportDays"": 0,
        ""generateKeyInfo"": true,
        ""userKey"": ""string"",
        ""description"": ""string"",
        ""template"": ""string"",
        ""productId"": 0,
        ""signatureKeysId"": 0,
        ""releaseId"": 0,
        ""product"": {
          ""id"": ""string"",
          ""name"": ""string"",
          ""version"": ""string"",
          ""copyright"": ""string"",
          ""url"": ""string"",
          ""description"": ""string""
        },
        ""components"": [
          ""string""
        ],
        ""assemblies"": [
          {
            ""id"": 0,
            ""name"": ""string"",
            ""version"": ""string"",
            ""culture"": ""string"",
            ""publicKeyToken"": ""string"",
            ""mappingFileId"": 0,
            ""debugSymbolsKey"": ""string""
          }
        ],
        ""fields"": [
          {
            ""name"": ""string"",
            ""value"": ""string""
          }
        ],
        ""features"": [
          {
            ""id"": ""string"",
            ""name"": ""string"",
            ""description"": ""string"",
            ""expireDate"": ""2019-08-24T14:15:22Z"",
            ""key"": ""string"",
            ""data"": ""string""
          }
        ],
        ""restrictions"": [
          {
            ""id"": ""string"",
            ""name"": ""string"",
            ""expireDate"": ""2019-08-24T14:15:22Z"",
            ""properties"": {
              ""property1"": ""string"",
              ""property2"": ""string""
            },
            ""customXmlContent"": ""string""
          }
        ]
      },
      ""licensee"": {
        ""name"": ""string"",
        ""company"": ""string"",
        ""contactInfo"": ""string"",
        ""url"": ""string""
      },
      ""components"": [
        ""string""
      ],
      ""assemblies"": [
        {
          ""id"": 0,
          ""name"": ""string"",
          ""version"": ""string"",
          ""culture"": ""string"",
          ""publicKeyToken"": ""string"",
          ""mappingFileId"": 0,
          ""debugSymbolsKey"": ""string""
        }
      ],
      ""fields"": [
        {
          ""name"": ""string"",
          ""value"": ""string""
        }
      ],
      ""features"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""description"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""key"": ""string"",
          ""data"": ""string""
        }
      ],
      ""restrictions"": [
        {
          ""id"": ""string"",
          ""name"": ""string"",
          ""expireDate"": ""2019-08-24T14:15:22Z"",
          ""properties"": {
            ""property1"": ""string"",
            ""property2"": ""string""
          },
          ""customXmlContent"": ""string""
        }
      ]
    }
  }
}";
      Management.InsertLicenseTokenRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertLicenseTokenRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertLicenseTokenRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/licenses/\{licenseId\}/tokens

Inserts a new license token based on the provided request parameters.

Body parameter


{
  "licenseToken": {
    "id": 0,
    "token": "string",
    "address": "string",
    "clientId": "string",
    "clientName": "string",
    "machineId": "string",
    "issueDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "lastHeartbeat": "2019-08-24T14:15:22Z",
    "hash": "string",
    "licenseId": 0,
    "license": {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    },
    "nodeLockedLicenseId": 0,
    "nodeLockedLicense": {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  }
}

Parameters

Name	In	Type	Required	Description
licenseId	path	integer(int32)	true	The license ID.
body	body	Management.InsertLicenseTokenRequest	false	The request containing the parameters for inserting a new license token.

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseId":0,"licenseTokenId":0,"token":"string"}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseId": 0,
  "licenseTokenId": 0,
  "token": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertLicenseTokenResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/licenses/{licenseId}/tokens/{tokenId}`DELETE /v1/licenses/{licenseId}/tokens/{tokenId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/licenses/{licenseId}/tokens/{tokenId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/licenses/{licenseId}/tokens/{tokenId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/licenses/{licenseId}/tokens/{tokenId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/licenses/\{licenseId\}/tokens/\{tokenId\}

Deletes a license token based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
licenseId	path	integer(int32)	true	The license ID.
tokenId	path	integer(int32)	true	The token ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteLicenseTokenResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/license-traces`GET /v1/license-traces

Code samples

cURL


# You can also use wget
curl -X GET /v1/license-traces \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-traces',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/license-traces";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/license-traces

Retrieves license traces based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
licenseId	query	integer(int32)	false	none
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseTraces":[{"id":0,"clientIp":"string","clientId":"string","clientName":"string","machineId":"string","createdDate":"2019-08-24T14:15:22Z","action":0,"geoLocation":"string","meta":"string","licenseId":0}],"totalLicenseTracesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseTraces": [
    {
      "id": 0,
      "clientIp": "string",
      "clientId": "string",
      "clientName": "string",
      "machineId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "action": 0,
      "geoLocation": "string",
      "meta": "string",
      "licenseId": 0
    }
  ],
  "totalLicenseTracesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLicenseTracesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/license-traces`DELETE /v1/license-traces

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/license-traces \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "traceId": 0,
  "licenseId": 0,
  "filter": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-traces',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/license-traces";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/license-traces

Deletes a license trace based on the provided request parameters.

Body parameter


{
  "traceId": 0,
  "licenseId": 0,
  "filter": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Management.DeleteLicenseTraceRequest	false	The request containing the parameters for deleting a license trace.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteLicenseTraceResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/license-templates`GET /v1/license-templates

Code samples

cURL


# You can also use wget
curl -X GET /v1/license-templates \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-templates',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/license-templates";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/license-templates

Retrieves license templates based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseTemplates":[{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicenseTemplatesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseTemplates": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicenseTemplatesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLicenseTemplatesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/license-templates`POST /v1/license-templates

Code samples

cURL


# You can also use wget
curl -X POST /v1/license-templates \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "licenseTemplate": {
    "id": 0,
    "name": "string",
    "code": "string",
    "licenseType": "string",
    "format": 0,
    "licensingMode": 0,
    "licenseFileName": "string",
    "issueDate": true,
    "expireDays": 0,
    "supportDays": 0,
    "generateKeyInfo": true,
    "userKey": "string",
    "description": "string",
    "template": "string",
    "productId": 0,
    "signatureKeysId": 0,
    "releaseId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-templates',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/license-templates";
      
      string json = @"{
  ""licenseTemplate"": {
    ""id"": 0,
    ""name"": ""string"",
    ""code"": ""string"",
    ""licenseType"": ""string"",
    ""format"": 0,
    ""licensingMode"": 0,
    ""licenseFileName"": ""string"",
    ""issueDate"": true,
    ""expireDays"": 0,
    ""supportDays"": 0,
    ""generateKeyInfo"": true,
    ""userKey"": ""string"",
    ""description"": ""string"",
    ""template"": ""string"",
    ""productId"": 0,
    ""signatureKeysId"": 0,
    ""releaseId"": 0,
    ""product"": {
      ""id"": ""string"",
      ""name"": ""string"",
      ""version"": ""string"",
      ""copyright"": ""string"",
      ""url"": ""string"",
      ""description"": ""string""
    },
    ""components"": [
      ""string""
    ],
    ""assemblies"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""version"": ""string"",
        ""culture"": ""string"",
        ""publicKeyToken"": ""string"",
        ""mappingFileId"": 0,
        ""debugSymbolsKey"": ""string""
      }
    ],
    ""fields"": [
      {
        ""name"": ""string"",
        ""value"": ""string""
      }
    ],
    ""features"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""description"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""key"": ""string"",
        ""data"": ""string""
      }
    ],
    ""restrictions"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""properties"": {
          ""property1"": ""string"",
          ""property2"": ""string""
        },
        ""customXmlContent"": ""string""
      }
    ]
  }
}";
      Management.InsertLicenseTemplateRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertLicenseTemplateRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertLicenseTemplateRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/license-templates

Inserts a new license template based on the provided request parameters.

Body parameter


{
  "licenseTemplate": {
    "id": 0,
    "name": "string",
    "code": "string",
    "licenseType": "string",
    "format": 0,
    "licensingMode": 0,
    "licenseFileName": "string",
    "issueDate": true,
    "expireDays": 0,
    "supportDays": 0,
    "generateKeyInfo": true,
    "userKey": "string",
    "description": "string",
    "template": "string",
    "productId": 0,
    "signatureKeysId": 0,
    "releaseId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertLicenseTemplateRequest	false	The request containing the parameters for inserting a new license template.

Example responses

200 Response


{"templateId":0,"success":true,"code":0,"message":"string","template":"string"}


{
  "templateId": 0,
  "success": true,
  "code": 0,
  "message": "string",
  "template": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertLicenseTemplateResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/license-templates`PUT /v1/license-templates

Code samples

cURL


# You can also use wget
curl -X PUT /v1/license-templates \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "licenseTemplate": {
    "id": 0,
    "name": "string",
    "code": "string",
    "licenseType": "string",
    "format": 0,
    "licensingMode": 0,
    "licenseFileName": "string",
    "issueDate": true,
    "expireDays": 0,
    "supportDays": 0,
    "generateKeyInfo": true,
    "userKey": "string",
    "description": "string",
    "template": "string",
    "productId": 0,
    "signatureKeysId": 0,
    "releaseId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-templates',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/license-templates";
 
      
      string json = @"{
  ""licenseTemplate"": {
    ""id"": 0,
    ""name"": ""string"",
    ""code"": ""string"",
    ""licenseType"": ""string"",
    ""format"": 0,
    ""licensingMode"": 0,
    ""licenseFileName"": ""string"",
    ""issueDate"": true,
    ""expireDays"": 0,
    ""supportDays"": 0,
    ""generateKeyInfo"": true,
    ""userKey"": ""string"",
    ""description"": ""string"",
    ""template"": ""string"",
    ""productId"": 0,
    ""signatureKeysId"": 0,
    ""releaseId"": 0,
    ""product"": {
      ""id"": ""string"",
      ""name"": ""string"",
      ""version"": ""string"",
      ""copyright"": ""string"",
      ""url"": ""string"",
      ""description"": ""string""
    },
    ""components"": [
      ""string""
    ],
    ""assemblies"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""version"": ""string"",
        ""culture"": ""string"",
        ""publicKeyToken"": ""string"",
        ""mappingFileId"": 0,
        ""debugSymbolsKey"": ""string""
      }
    ],
    ""fields"": [
      {
        ""name"": ""string"",
        ""value"": ""string""
      }
    ],
    ""features"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""description"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""key"": ""string"",
        ""data"": ""string""
      }
    ],
    ""restrictions"": [
      {
        ""id"": ""string"",
        ""name"": ""string"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""properties"": {
          ""property1"": ""string"",
          ""property2"": ""string""
        },
        ""customXmlContent"": ""string""
      }
    ]
  }
}";
      Management.UpdateLicenseTemplateRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateLicenseTemplateRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateLicenseTemplateRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/license-templates

Updates an existing license template based on the provided request parameters.

Body parameter


{
  "licenseTemplate": {
    "id": 0,
    "name": "string",
    "code": "string",
    "licenseType": "string",
    "format": 0,
    "licensingMode": 0,
    "licenseFileName": "string",
    "issueDate": true,
    "expireDays": 0,
    "supportDays": 0,
    "generateKeyInfo": true,
    "userKey": "string",
    "description": "string",
    "template": "string",
    "productId": 0,
    "signatureKeysId": 0,
    "releaseId": 0,
    "product": {
      "id": "string",
      "name": "string",
      "version": "string",
      "copyright": "string",
      "url": "string",
      "description": "string"
    },
    "components": [
      "string"
    ],
    "assemblies": [
      {
        "id": 0,
        "name": "string",
        "version": "string",
        "culture": "string",
        "publicKeyToken": "string",
        "mappingFileId": 0,
        "debugSymbolsKey": "string"
      }
    ],
    "fields": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "features": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "key": "string",
        "data": "string"
      }
    ],
    "restrictions": [
      {
        "id": "string",
        "name": "string",
        "expireDate": "2019-08-24T14:15:22Z",
        "properties": {
          "property1": "string",
          "property2": "string"
        },
        "customXmlContent": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateLicenseTemplateRequest	false	The request containing the parameters for updating a license template.

Example responses

200 Response


{"success":true,"code":0,"message":"string","template":"string"}


{
  "success": true,
  "code": 0,
  "message": "string",
  "template": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateLicenseTemplateResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/license-templates/{templateId}/licenses`GET /v1/license-templates/{templateId}/licenses

Code samples

cURL


# You can also use wget
curl -X GET /v1/license-templates/{templateId}/licenses \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-templates/{templateId}/licenses',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/license-templates/{templateId}/licenses";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/license-templates/\{templateId\}/licenses

Retrieves licenses for a specific license template based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
templateId	path	integer(int32)	true	The license template ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenses":[{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicensesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenses": [
    {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicensesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLicenseTemplateLicensesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/license-templates/{templateId}`DELETE /v1/license-templates/{templateId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/license-templates/{templateId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/license-templates/{templateId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/license-templates/{templateId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/license-templates/\{templateId\}

Deletes an existing license template based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
templateId	path	integer(int32)	true	The license template ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteLicenseTemplateResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/customers`GET /v1/customers

Code samples

cURL


# You can also use wget
curl -X GET /v1/customers \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/customers";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/customers

Retrieves a list of customers based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","customers":[{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]}],"totalCustomersCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "customers": [
    {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    }
  ],
  "totalCustomersCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetCustomersResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/customers`POST /v1/customers

Code samples

cURL


# You can also use wget
curl -X POST /v1/customers \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "customer": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "code": "string",
    "vatCode": "string",
    "invoiceCode": "string",
    "rating": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "address": "string",
    "address1": "string",
    "address2": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mapCoordinates": "string",
    "mapZoomLevel": 0.1,
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "website": "string",
    "notes": "string",
    "isReseller": true,
    "image": "string",
    "meta": "string",
    "contacts": [
      {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "details": "string",
        "notify": true,
        "customerId": 0,
        "meta": "string"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/customers";
      
      string json = @"{
  ""customer"": {
    ""id"": 0,
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""company"": ""string"",
    ""code"": ""string"",
    ""vatCode"": ""string"",
    ""invoiceCode"": ""string"",
    ""rating"": 0,
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""address"": ""string"",
    ""address1"": ""string"",
    ""address2"": ""string"",
    ""postalCode"": ""string"",
    ""region"": ""string"",
    ""city"": ""string"",
    ""country"": ""string"",
    ""countryCode"": ""string"",
    ""mapCoordinates"": ""string"",
    ""mapZoomLevel"": 0.1,
    ""email"": ""string"",
    ""phone"": ""string"",
    ""mobile"": ""string"",
    ""fax"": ""string"",
    ""website"": ""string"",
    ""notes"": ""string"",
    ""isReseller"": true,
    ""image"": ""string"",
    ""meta"": ""string"",
    ""contacts"": [
      {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""details"": ""string"",
        ""notify"": true,
        ""customerId"": 0,
        ""meta"": ""string""
      }
    ]
  }
}";
      Management.InsertCustomerRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertCustomerRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertCustomerRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/customers

Inserts a new customer based on the provided request parameters.

Body parameter


{
  "customer": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "code": "string",
    "vatCode": "string",
    "invoiceCode": "string",
    "rating": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "address": "string",
    "address1": "string",
    "address2": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mapCoordinates": "string",
    "mapZoomLevel": 0.1,
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "website": "string",
    "notes": "string",
    "isReseller": true,
    "image": "string",
    "meta": "string",
    "contacts": [
      {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "details": "string",
        "notify": true,
        "customerId": 0,
        "meta": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertCustomerRequest	false	The request parameters for inserting a new customer.

Example responses

200 Response


{"customerId":0,"success":true,"code":0,"message":"string","customerCode":"string"}


{
  "customerId": 0,
  "success": true,
  "code": 0,
  "message": "string",
  "customerCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertCustomerResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/customers`PUT /v1/customers

Code samples

cURL


# You can also use wget
curl -X PUT /v1/customers \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "customer": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "code": "string",
    "vatCode": "string",
    "invoiceCode": "string",
    "rating": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "address": "string",
    "address1": "string",
    "address2": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mapCoordinates": "string",
    "mapZoomLevel": 0.1,
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "website": "string",
    "notes": "string",
    "isReseller": true,
    "image": "string",
    "meta": "string",
    "contacts": [
      {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "details": "string",
        "notify": true,
        "customerId": 0,
        "meta": "string"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/customers";
 
      
      string json = @"{
  ""customer"": {
    ""id"": 0,
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""company"": ""string"",
    ""code"": ""string"",
    ""vatCode"": ""string"",
    ""invoiceCode"": ""string"",
    ""rating"": 0,
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""address"": ""string"",
    ""address1"": ""string"",
    ""address2"": ""string"",
    ""postalCode"": ""string"",
    ""region"": ""string"",
    ""city"": ""string"",
    ""country"": ""string"",
    ""countryCode"": ""string"",
    ""mapCoordinates"": ""string"",
    ""mapZoomLevel"": 0.1,
    ""email"": ""string"",
    ""phone"": ""string"",
    ""mobile"": ""string"",
    ""fax"": ""string"",
    ""website"": ""string"",
    ""notes"": ""string"",
    ""isReseller"": true,
    ""image"": ""string"",
    ""meta"": ""string"",
    ""contacts"": [
      {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""details"": ""string"",
        ""notify"": true,
        ""customerId"": 0,
        ""meta"": ""string""
      }
    ]
  }
}";
      Management.UpdateCustomerRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateCustomerRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateCustomerRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/customers

Updates an existing customer based on the provided request parameters.

Body parameter


{
  "customer": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "code": "string",
    "vatCode": "string",
    "invoiceCode": "string",
    "rating": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "address": "string",
    "address1": "string",
    "address2": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mapCoordinates": "string",
    "mapZoomLevel": 0.1,
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "website": "string",
    "notes": "string",
    "isReseller": true,
    "image": "string",
    "meta": "string",
    "contacts": [
      {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "details": "string",
        "notify": true,
        "customerId": 0,
        "meta": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateCustomerRequest	false	The request parameters for updating a customer.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateCustomerResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/customers/{customerId}/contacts`GET /v1/customers/{customerId}/contacts

Code samples

cURL


# You can also use wget
curl -X GET /v1/customers/{customerId}/contacts \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers/{customerId}/contacts',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/customers/{customerId}/contacts";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/customers/\{customerId\}/contacts

Retrieves a list of customer contacts based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	The customer ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}],"totalContactsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "contacts": [
    {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "details": "string",
      "notify": true,
      "customerId": 0,
      "meta": "string"
    }
  ],
  "totalContactsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetCustomerContactsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/customers/{customerId}/orders`GET /v1/customers/{customerId}/orders

Code samples

cURL


# You can also use wget
curl -X GET /v1/customers/{customerId}/orders \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers/{customerId}/orders',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/customers/{customerId}/orders";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/customers/\{customerId\}/orders

Retrieves a list of customer orders based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	The customer ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","orders":[{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0}],"totalOrdersCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "orders": [
    {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  ],
  "totalOrdersCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetCustomerOrdersResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/customers/{customerId}/licenses`GET /v1/customers/{customerId}/licenses

Code samples

cURL


# You can also use wget
curl -X GET /v1/customers/{customerId}/licenses \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers/{customerId}/licenses',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/customers/{customerId}/licenses";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/customers/\{customerId\}/licenses

Retrieves a list of customer licenses based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	The customer ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenses":[{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicensesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenses": [
    {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicensesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetCustomerLicensesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/customers/{customerId}`DELETE /v1/customers/{customerId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/customers/{customerId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/customers/{customerId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/customers/{customerId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/customers/\{customerId\}

Deletes an existing customer based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	The customer ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteCustomerResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/contacts`GET /v1/contacts

Code samples

cURL


# You can also use wget
curl -X GET /v1/contacts \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/contacts";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/contacts

Retrieves a list of contacts based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}],"totalContactsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "contacts": [
    {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "details": "string",
      "notify": true,
      "customerId": 0,
      "meta": "string"
    }
  ],
  "totalContactsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetContactsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/contacts`POST /v1/contacts

Code samples

cURL


# You can also use wget
curl -X POST /v1/contacts \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/contacts";
      
      string json = @"{
  ""contact"": {
    ""id"": 0,
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""email"": ""string"",
    ""phone"": ""string"",
    ""mobile"": ""string"",
    ""fax"": ""string"",
    ""details"": ""string"",
    ""notify"": true,
    ""customerId"": 0,
    ""meta"": ""string""
  }
}";
      Management.InsertContactRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertContactRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertContactRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/contacts

Inserts a new contact based on the provided request parameters.

Body parameter


{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertContactRequest	false	The request parameters for inserting a new contact.

Example responses

200 Response


{"contactId":0,"success":true,"code":0,"message":"string"}


{
  "contactId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertContactResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/contacts`PUT /v1/contacts

Code samples

cURL


# You can also use wget
curl -X PUT /v1/contacts \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/contacts";
 
      
      string json = @"{
  ""contact"": {
    ""id"": 0,
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""email"": ""string"",
    ""phone"": ""string"",
    ""mobile"": ""string"",
    ""fax"": ""string"",
    ""details"": ""string"",
    ""notify"": true,
    ""customerId"": 0,
    ""meta"": ""string""
  }
}";
      Management.UpdateContactRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateContactRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateContactRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/contacts

Updates an existing contact based on the provided request parameters.

Body parameter


{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateContactRequest	false	The request parameters for updating a contact.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateContactResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/contacts/{contactId}`DELETE /v1/contacts/{contactId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/contacts/{contactId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts/{contactId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/contacts/{contactId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/contacts/\{contactId\}

Deletes an existing contact based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
contactId	path	integer(int32)	true	The ID of the contact to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteContactResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/products`GET /v1/products

Code samples

cURL


# You can also use wget
curl -X GET /v1/products \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/products";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/products

Gets the products based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","products":[{"id":0,"code":"string","name":"string","description":"string","url":"string","copyright":"string","createdAt":"2019-08-24T14:15:22Z","image":"string","price":0.1,"resellerPrice":0.1,"currency":"string","signatureKeysId":0,"meta":"string","signatureKeys":{"id":0,"name":"string","type":"string","code":"string","description":"string","source":"string","password":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","data":"string","dataFormat":"string","meta":"string"},"productOrders":[{"productId":0,"orderId":0,"quantity":0,"unitPrice":0.1,"discount":0.1,"taxes":0.1,"description":"string","product":{},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0}}]}],"totalProductsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "products": [
    {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {
          "productId": 0,
          "orderId": 0,
          "quantity": 0,
          "unitPrice": 0.1,
          "discount": 0.1,
          "taxes": 0.1,
          "description": "string",
          "product": {},
          "order": {
            "id": 0,
            "orderNumber": "string",
            "status": "string",
            "processedBy": "string",
            "purchaseOrder": "string",
            "total": 0.1,
            "currency": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "invoiceNumber": "string",
            "paymentType": "string",
            "paymentNumber": "string",
            "paymentStatus": "string",
            "paymentDate": "2019-08-24T14:15:22Z",
            "description": "string",
            "customerId": 0,
            "customer": {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "company": "string",
              "code": "string",
              "vatCode": "string",
              "invoiceCode": "string",
              "rating": 0,
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "address": "string",
              "address1": "string",
              "address2": "string",
              "postalCode": "string",
              "region": "string",
              "city": "string",
              "country": "string",
              "countryCode": "string",
              "mapCoordinates": "string",
              "mapZoomLevel": 0.1,
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "website": "string",
              "notes": "string",
              "isReseller": true,
              "image": "string",
              "meta": "string",
              "contacts": [
                {
                  "id": 0,
                  "title": "string",
                  "firstName": "string",
                  "lastName": "string",
                  "email": "string",
                  "phone": "string",
                  "mobile": "string",
                  "fax": "string",
                  "details": "string",
                  "notify": true,
                  "customerId": 0,
                  "meta": "string"
                }
              ]
            },
            "resellerId": 0
          }
        }
      ]
    }
  ],
  "totalProductsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetProductsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/products`POST /v1/products

Code samples

cURL


# You can also use wget
curl -X POST /v1/products \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "product": {
    "id": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "copyright": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "image": "string",
    "price": 0.1,
    "resellerPrice": 0.1,
    "currency": "string",
    "signatureKeysId": 0,
    "meta": "string",
    "signatureKeys": {
      "id": 0,
      "name": "string",
      "type": "string",
      "code": "string",
      "description": "string",
      "source": "string",
      "password": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "data": "string",
      "dataFormat": "string",
      "meta": "string"
    },
    "productOrders": [
      {
        "productId": 0,
        "orderId": 0,
        "quantity": 0,
        "unitPrice": 0.1,
        "discount": 0.1,
        "taxes": 0.1,
        "description": "string",
        "product": {},
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        }
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/products";
      
      string json = @"{
  ""product"": {
    ""id"": 0,
    ""code"": ""string"",
    ""name"": ""string"",
    ""description"": ""string"",
    ""url"": ""string"",
    ""copyright"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""image"": ""string"",
    ""price"": 0.1,
    ""resellerPrice"": 0.1,
    ""currency"": ""string"",
    ""signatureKeysId"": 0,
    ""meta"": ""string"",
    ""signatureKeys"": {
      ""id"": 0,
      ""name"": ""string"",
      ""type"": ""string"",
      ""code"": ""string"",
      ""description"": ""string"",
      ""source"": ""string"",
      ""password"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""data"": ""string"",
      ""dataFormat"": ""string"",
      ""meta"": ""string""
    },
    ""productOrders"": [
      {
        ""productId"": 0,
        ""orderId"": 0,
        ""quantity"": 0,
        ""unitPrice"": 0.1,
        ""discount"": 0.1,
        ""taxes"": 0.1,
        ""description"": ""string"",
        ""product"": {},
        ""order"": {
          ""id"": 0,
          ""orderNumber"": ""string"",
          ""status"": ""string"",
          ""processedBy"": ""string"",
          ""purchaseOrder"": ""string"",
          ""total"": 0.1,
          ""currency"": ""string"",
          ""createdAt"": ""2019-08-24T14:15:22Z"",
          ""updatedAt"": ""2019-08-24T14:15:22Z"",
          ""invoiceNumber"": ""string"",
          ""paymentType"": ""string"",
          ""paymentNumber"": ""string"",
          ""paymentStatus"": ""string"",
          ""paymentDate"": ""2019-08-24T14:15:22Z"",
          ""description"": ""string"",
          ""customerId"": 0,
          ""customer"": {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""company"": ""string"",
            ""code"": ""string"",
            ""vatCode"": ""string"",
            ""invoiceCode"": ""string"",
            ""rating"": 0,
            ""createdAt"": ""2019-08-24T14:15:22Z"",
            ""updatedAt"": ""2019-08-24T14:15:22Z"",
            ""address"": ""string"",
            ""address1"": ""string"",
            ""address2"": ""string"",
            ""postalCode"": ""string"",
            ""region"": ""string"",
            ""city"": ""string"",
            ""country"": ""string"",
            ""countryCode"": ""string"",
            ""mapCoordinates"": ""string"",
            ""mapZoomLevel"": 0.1,
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""website"": ""string"",
            ""notes"": ""string"",
            ""isReseller"": true,
            ""image"": ""string"",
            ""meta"": ""string"",
            ""contacts"": [
              {
                ""id"": 0,
                ""title"": ""string"",
                ""firstName"": ""string"",
                ""lastName"": ""string"",
                ""email"": ""string"",
                ""phone"": ""string"",
                ""mobile"": ""string"",
                ""fax"": ""string"",
                ""details"": ""string"",
                ""notify"": true,
                ""customerId"": 0,
                ""meta"": ""string""
              }
            ]
          },
          ""resellerId"": 0
        }
      }
    ]
  }
}";
      Management.InsertProductRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertProductRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertProductRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/products

Inserts a new product.

Body parameter


{
  "product": {
    "id": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "copyright": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "image": "string",
    "price": 0.1,
    "resellerPrice": 0.1,
    "currency": "string",
    "signatureKeysId": 0,
    "meta": "string",
    "signatureKeys": {
      "id": 0,
      "name": "string",
      "type": "string",
      "code": "string",
      "description": "string",
      "source": "string",
      "password": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "data": "string",
      "dataFormat": "string",
      "meta": "string"
    },
    "productOrders": [
      {
        "productId": 0,
        "orderId": 0,
        "quantity": 0,
        "unitPrice": 0.1,
        "discount": 0.1,
        "taxes": 0.1,
        "description": "string",
        "product": {},
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        }
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertProductRequest	false	The request containing the product to insert.

Example responses

200 Response


{"productId":0,"success":true,"code":0,"message":"string"}


{
  "productId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertProductResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/products`PUT /v1/products

Code samples

cURL


# You can also use wget
curl -X PUT /v1/products \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "product": {
    "id": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "copyright": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "image": "string",
    "price": 0.1,
    "resellerPrice": 0.1,
    "currency": "string",
    "signatureKeysId": 0,
    "meta": "string",
    "signatureKeys": {
      "id": 0,
      "name": "string",
      "type": "string",
      "code": "string",
      "description": "string",
      "source": "string",
      "password": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "data": "string",
      "dataFormat": "string",
      "meta": "string"
    },
    "productOrders": [
      {
        "productId": 0,
        "orderId": 0,
        "quantity": 0,
        "unitPrice": 0.1,
        "discount": 0.1,
        "taxes": 0.1,
        "description": "string",
        "product": {},
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        }
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/products";
 
      
      string json = @"{
  ""product"": {
    ""id"": 0,
    ""code"": ""string"",
    ""name"": ""string"",
    ""description"": ""string"",
    ""url"": ""string"",
    ""copyright"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""image"": ""string"",
    ""price"": 0.1,
    ""resellerPrice"": 0.1,
    ""currency"": ""string"",
    ""signatureKeysId"": 0,
    ""meta"": ""string"",
    ""signatureKeys"": {
      ""id"": 0,
      ""name"": ""string"",
      ""type"": ""string"",
      ""code"": ""string"",
      ""description"": ""string"",
      ""source"": ""string"",
      ""password"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""data"": ""string"",
      ""dataFormat"": ""string"",
      ""meta"": ""string""
    },
    ""productOrders"": [
      {
        ""productId"": 0,
        ""orderId"": 0,
        ""quantity"": 0,
        ""unitPrice"": 0.1,
        ""discount"": 0.1,
        ""taxes"": 0.1,
        ""description"": ""string"",
        ""product"": {},
        ""order"": {
          ""id"": 0,
          ""orderNumber"": ""string"",
          ""status"": ""string"",
          ""processedBy"": ""string"",
          ""purchaseOrder"": ""string"",
          ""total"": 0.1,
          ""currency"": ""string"",
          ""createdAt"": ""2019-08-24T14:15:22Z"",
          ""updatedAt"": ""2019-08-24T14:15:22Z"",
          ""invoiceNumber"": ""string"",
          ""paymentType"": ""string"",
          ""paymentNumber"": ""string"",
          ""paymentStatus"": ""string"",
          ""paymentDate"": ""2019-08-24T14:15:22Z"",
          ""description"": ""string"",
          ""customerId"": 0,
          ""customer"": {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""company"": ""string"",
            ""code"": ""string"",
            ""vatCode"": ""string"",
            ""invoiceCode"": ""string"",
            ""rating"": 0,
            ""createdAt"": ""2019-08-24T14:15:22Z"",
            ""updatedAt"": ""2019-08-24T14:15:22Z"",
            ""address"": ""string"",
            ""address1"": ""string"",
            ""address2"": ""string"",
            ""postalCode"": ""string"",
            ""region"": ""string"",
            ""city"": ""string"",
            ""country"": ""string"",
            ""countryCode"": ""string"",
            ""mapCoordinates"": ""string"",
            ""mapZoomLevel"": 0.1,
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""website"": ""string"",
            ""notes"": ""string"",
            ""isReseller"": true,
            ""image"": ""string"",
            ""meta"": ""string"",
            ""contacts"": [
              {
                ""id"": 0,
                ""title"": ""string"",
                ""firstName"": ""string"",
                ""lastName"": ""string"",
                ""email"": ""string"",
                ""phone"": ""string"",
                ""mobile"": ""string"",
                ""fax"": ""string"",
                ""details"": ""string"",
                ""notify"": true,
                ""customerId"": 0,
                ""meta"": ""string""
              }
            ]
          },
          ""resellerId"": 0
        }
      }
    ]
  }
}";
      Management.UpdateProductRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateProductRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateProductRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/products

Updates an existing product.

Body parameter


{
  "product": {
    "id": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "copyright": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "image": "string",
    "price": 0.1,
    "resellerPrice": 0.1,
    "currency": "string",
    "signatureKeysId": 0,
    "meta": "string",
    "signatureKeys": {
      "id": 0,
      "name": "string",
      "type": "string",
      "code": "string",
      "description": "string",
      "source": "string",
      "password": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "data": "string",
      "dataFormat": "string",
      "meta": "string"
    },
    "productOrders": [
      {
        "productId": 0,
        "orderId": 0,
        "quantity": 0,
        "unitPrice": 0.1,
        "discount": 0.1,
        "taxes": 0.1,
        "description": "string",
        "product": {},
        "order": {
          "id": 0,
          "orderNumber": "string",
          "status": "string",
          "processedBy": "string",
          "purchaseOrder": "string",
          "total": 0.1,
          "currency": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "invoiceNumber": "string",
          "paymentType": "string",
          "paymentNumber": "string",
          "paymentStatus": "string",
          "paymentDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "customerId": 0,
          "customer": {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "code": "string",
            "vatCode": "string",
            "invoiceCode": "string",
            "rating": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "address": "string",
            "address1": "string",
            "address2": "string",
            "postalCode": "string",
            "region": "string",
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "mapCoordinates": "string",
            "mapZoomLevel": 0.1,
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "website": "string",
            "notes": "string",
            "isReseller": true,
            "image": "string",
            "meta": "string",
            "contacts": [
              {
                "id": 0,
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "mobile": "string",
                "fax": "string",
                "details": "string",
                "notify": true,
                "customerId": 0,
                "meta": "string"
              }
            ]
          },
          "resellerId": 0
        }
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateProductRequest	false	The request containing the product to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateProductResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/products/{productId}`DELETE /v1/products/{productId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/products/{productId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/products/\{productId\}

Deletes an existing product.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The ID of the product to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteProductResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/products/{productId}/orders`GET /v1/products/{productId}/orders

Code samples

cURL


# You can also use wget
curl -X GET /v1/products/{productId}/orders \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/orders',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/products/{productId}/orders";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/products/\{productId\}/orders

Gets the product orders based on the provided request.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","productOrders":[{"productId":0,"orderId":0,"quantity":0,"unitPrice":0.1,"discount":0.1,"taxes":0.1,"description":"string","product":{"id":0,"code":"string","name":"string","description":"string","url":"string","copyright":"string","createdAt":"2019-08-24T14:15:22Z","image":"string","price":0.1,"resellerPrice":0.1,"currency":"string","signatureKeysId":0,"meta":"string","signatureKeys":{"id":0,"name":"string","type":"string","code":"string","description":"string","source":"string","password":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","data":"string","dataFormat":"string","meta":"string"},"productOrders":[{}]},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0}}],"totalProductOrdersCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "productOrders": [
    {
      "productId": 0,
      "orderId": 0,
      "quantity": 0,
      "unitPrice": 0.1,
      "discount": 0.1,
      "taxes": 0.1,
      "description": "string",
      "product": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "url": "string",
        "copyright": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "image": "string",
        "price": 0.1,
        "resellerPrice": 0.1,
        "currency": "string",
        "signatureKeysId": 0,
        "meta": "string",
        "signatureKeys": {
          "id": 0,
          "name": "string",
          "type": "string",
          "code": "string",
          "description": "string",
          "source": "string",
          "password": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "data": "string",
          "dataFormat": "string",
          "meta": "string"
        },
        "productOrders": [
          {}
        ]
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      }
    }
  ],
  "totalProductOrdersCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetProductOrdersResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/products/{productId}/releases`GET /v1/products/{productId}/releases

Code samples

cURL


# You can also use wget
curl -X GET /v1/products/{productId}/releases \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/products/{productId}/releases";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/products/\{productId\}/releases

Gets the product releases based on the provided request.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","releases":[{"id":0,"releaseDate":"2019-08-24T14:15:22Z","name":"string","version":"string","description":"string"}],"totalReleasesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "releases": [
    {
      "id": 0,
      "releaseDate": "2019-08-24T14:15:22Z",
      "name": "string",
      "version": "string",
      "description": "string"
    }
  ],
  "totalReleasesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetProductReleasesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/products/{productId}/releases`POST /v1/products/{productId}/releases

Code samples

cURL


# You can also use wget
curl -X POST /v1/products/{productId}/releases \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/products/{productId}/releases";
      
      string json = @"{
  ""release"": {
    ""id"": 0,
    ""releaseDate"": ""2019-08-24T14:15:22Z"",
    ""name"": ""string"",
    ""version"": ""string"",
    ""description"": ""string""
  }
}";
      Management.InsertProductReleaseRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertProductReleaseRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertProductReleaseRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/products/\{productId\}/releases

Inserts a new product release.

Body parameter


{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string"
  }
}

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
body	body	Management.InsertProductReleaseRequest	false	The request containing the product release to insert.

Example responses

200 Response


{"releaseId":0,"success":true,"code":0,"message":"string"}


{
  "releaseId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertProductReleaseResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/products/{productId}/releases`PUT /v1/products/{productId}/releases

Code samples

cURL


# You can also use wget
curl -X PUT /v1/products/{productId}/releases \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}/releases";
 
      
      string json = @"{
  ""release"": {
    ""id"": 0,
    ""releaseDate"": ""2019-08-24T14:15:22Z"",
    ""name"": ""string"",
    ""version"": ""string"",
    ""description"": ""string""
  }
}";
      Management.UpdateProductReleaseRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateProductReleaseRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateProductReleaseRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/products/\{productId\}/releases

Updates an existing product release.

Body parameter


{
  "release": {
    "id": 0,
    "releaseDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "version": "string",
    "description": "string"
  }
}

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
body	body	Management.UpdateProductReleaseRequest	false	The request containing the product release to update.

Example responses

200 Response


{"releaseId":0,"success":true,"code":0,"message":"string"}


{
  "releaseId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateProductReleaseResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/products/{productId}/releases/{releaseId}`DELETE /v1/products/{productId}/releases/{releaseId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/products/{productId}/releases/{releaseId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}/releases/{releaseId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/products/\{productId\}/releases/\{releaseId\}

Deletes an existing product release.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteProductReleaseResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/products/{productId}/releases/{releaseId}/assemblies`GET /v1/products/{productId}/releases/{releaseId}/assemblies

Code samples

cURL


# You can also use wget
curl -X GET /v1/products/{productId}/releases/{releaseId}/assemblies \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}/assemblies',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/products/{productId}/releases/{releaseId}/assemblies";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/products/\{productId\}/releases/\{releaseId\}/assemblies

Gets the assemblies of a product release.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"totalAssembliesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "assemblies": [
    {
      "id": 0,
      "name": "string",
      "version": "string",
      "culture": "string",
      "publicKeyToken": "string",
      "mappingFileId": 0,
      "debugSymbolsKey": "string"
    }
  ],
  "totalAssembliesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetProductReleaseAssembliesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/products/{productId}/releases/{releaseId}/assemblies`POST /v1/products/{productId}/releases/{releaseId}/assemblies

Code samples

cURL


# You can also use wget
curl -X POST /v1/products/{productId}/releases/{releaseId}/assemblies \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "productId": 0,
  "releaseId": 0,
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}/assemblies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/products/{productId}/releases/{releaseId}/assemblies";
      
      string json = @"{
  ""productId"": 0,
  ""releaseId"": 0,
  ""assembly"": {
    ""id"": 0,
    ""name"": ""string"",
    ""version"": ""string"",
    ""culture"": ""string"",
    ""publicKeyToken"": ""string"",
    ""mappingFileId"": 0,
    ""debugSymbolsKey"": ""string""
  }
}";
      Management.InsertProductReleaseAssemblyRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertProductReleaseAssemblyRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertProductReleaseAssemblyRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/products/\{productId\}/releases/\{releaseId\}/assemblies

Inserts a new assembly for a product release.

Body parameter


{
  "productId": 0,
  "releaseId": 0,
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.
body	body	Management.InsertProductReleaseAssemblyRequest	false	The request containing the product release assembly to insert.

Example responses

200 Response


{"assemblyId":0,"success":true,"code":0,"message":"string"}


{
  "assemblyId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertProductReleaseAssemblyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/products/{productId}/releases/{releaseId}/assemblies`PUT /v1/products/{productId}/releases/{releaseId}/assemblies

Code samples

cURL


# You can also use wget
curl -X PUT /v1/products/{productId}/releases/{releaseId}/assemblies \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}/assemblies',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}/releases/{releaseId}/assemblies";
 
      
      string json = @"{
  ""assembly"": {
    ""id"": 0,
    ""name"": ""string"",
    ""version"": ""string"",
    ""culture"": ""string"",
    ""publicKeyToken"": ""string"",
    ""mappingFileId"": 0,
    ""debugSymbolsKey"": ""string""
  }
}";
      Management.UpdateProductReleaseAssemblyRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateProductReleaseAssemblyRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateProductReleaseAssemblyRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/products/\{productId\}/releases/\{releaseId\}/assemblies

Updates an existing assembly for a product release.

Body parameter


{
  "assembly": {
    "id": 0,
    "name": "string",
    "version": "string",
    "culture": "string",
    "publicKeyToken": "string",
    "mappingFileId": 0,
    "debugSymbolsKey": "string"
  }
}

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.
body	body	Management.UpdateProductReleaseAssemblyRequest	false	The request containing the product release assembly to update.

Example responses

200 Response


{"assemblyId":0,"success":true,"code":0,"message":"string"}


{
  "assemblyId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateProductReleaseAssemblyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/products/{productId}/releases/{releaseId}/assemblies/{assemblyId}`DELETE /v1/products/{productId}/releases/{releaseId}/assemblies/{assemblyId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/products/{productId}/releases/{releaseId}/assemblies/{assemblyId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}/assemblies/{assemblyId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/products/{productId}/releases/{releaseId}/assemblies/{assemblyId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/products/\{productId\}/releases/\{releaseId\}/assemblies/\{assemblyId\}

Deletes an existing assembly for a product release.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.
assemblyId	path	integer(int32)	true	The assembly ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteProductReleaseAssemblyResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/products/{productId}/releases/{releaseId}/license-templates`GET /v1/products/{productId}/releases/{releaseId}/license-templates

Code samples

cURL


# You can also use wget
curl -X GET /v1/products/{productId}/releases/{releaseId}/license-templates \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/products/{productId}/releases/{releaseId}/license-templates',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/products/{productId}/releases/{releaseId}/license-templates";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/products/\{productId\}/releases/\{releaseId\}/license-templates

Gets the license templates of a product release.

Parameters

Name	In	Type	Required	Description
productId	path	integer(int32)	true	The product ID.
releaseId	path	integer(int32)	true	The release ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenseTemplates":[{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicenseTemplatesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenseTemplates": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "licenseType": "string",
      "format": 0,
      "licensingMode": 0,
      "licenseFileName": "string",
      "issueDate": true,
      "expireDays": 0,
      "supportDays": 0,
      "generateKeyInfo": true,
      "userKey": "string",
      "description": "string",
      "template": "string",
      "productId": 0,
      "signatureKeysId": 0,
      "releaseId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicenseTemplatesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetProductReleaseLicenseTemplatesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/orders`GET /v1/orders

Code samples

cURL


# You can also use wget
curl -X GET /v1/orders \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/orders";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/orders

Gets the orders based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","orders":[{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0}],"totalOrdersCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "orders": [
    {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  ],
  "totalOrdersCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetOrdersResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/orders`POST /v1/orders

Code samples

cURL


# You can also use wget
curl -X POST /v1/orders \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "order": {
    "id": 0,
    "orderNumber": "string",
    "status": "string",
    "processedBy": "string",
    "purchaseOrder": "string",
    "total": 0.1,
    "currency": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "paymentType": "string",
    "paymentNumber": "string",
    "paymentStatus": "string",
    "paymentDate": "2019-08-24T14:15:22Z",
    "description": "string",
    "customerId": 0,
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "resellerId": 0
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/orders";
      
      string json = @"{
  ""order"": {
    ""id"": 0,
    ""orderNumber"": ""string"",
    ""status"": ""string"",
    ""processedBy"": ""string"",
    ""purchaseOrder"": ""string"",
    ""total"": 0.1,
    ""currency"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""invoiceNumber"": ""string"",
    ""paymentType"": ""string"",
    ""paymentNumber"": ""string"",
    ""paymentStatus"": ""string"",
    ""paymentDate"": ""2019-08-24T14:15:22Z"",
    ""description"": ""string"",
    ""customerId"": 0,
    ""customer"": {
      ""id"": 0,
      ""title"": ""string"",
      ""firstName"": ""string"",
      ""lastName"": ""string"",
      ""company"": ""string"",
      ""code"": ""string"",
      ""vatCode"": ""string"",
      ""invoiceCode"": ""string"",
      ""rating"": 0,
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""address"": ""string"",
      ""address1"": ""string"",
      ""address2"": ""string"",
      ""postalCode"": ""string"",
      ""region"": ""string"",
      ""city"": ""string"",
      ""country"": ""string"",
      ""countryCode"": ""string"",
      ""mapCoordinates"": ""string"",
      ""mapZoomLevel"": 0.1,
      ""email"": ""string"",
      ""phone"": ""string"",
      ""mobile"": ""string"",
      ""fax"": ""string"",
      ""website"": ""string"",
      ""notes"": ""string"",
      ""isReseller"": true,
      ""image"": ""string"",
      ""meta"": ""string"",
      ""contacts"": [
        {
          ""id"": 0,
          ""title"": ""string"",
          ""firstName"": ""string"",
          ""lastName"": ""string"",
          ""email"": ""string"",
          ""phone"": ""string"",
          ""mobile"": ""string"",
          ""fax"": ""string"",
          ""details"": ""string"",
          ""notify"": true,
          ""customerId"": 0,
          ""meta"": ""string""
        }
      ]
    },
    ""resellerId"": 0
  }
}";
      Management.InsertOrderRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertOrderRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertOrderRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/orders

Inserts a new order.

Body parameter


{
  "order": {
    "id": 0,
    "orderNumber": "string",
    "status": "string",
    "processedBy": "string",
    "purchaseOrder": "string",
    "total": 0.1,
    "currency": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "paymentType": "string",
    "paymentNumber": "string",
    "paymentStatus": "string",
    "paymentDate": "2019-08-24T14:15:22Z",
    "description": "string",
    "customerId": 0,
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "resellerId": 0
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertOrderRequest	false	The request containing the details of the order to insert.

Example responses

200 Response


{"orderId":0,"success":true,"code":0,"message":"string","orderNumber":"string"}


{
  "orderId": 0,
  "success": true,
  "code": 0,
  "message": "string",
  "orderNumber": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertOrderResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/orders`PUT /v1/orders

Code samples

cURL


# You can also use wget
curl -X PUT /v1/orders \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "order": {
    "id": 0,
    "orderNumber": "string",
    "status": "string",
    "processedBy": "string",
    "purchaseOrder": "string",
    "total": 0.1,
    "currency": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "paymentType": "string",
    "paymentNumber": "string",
    "paymentStatus": "string",
    "paymentDate": "2019-08-24T14:15:22Z",
    "description": "string",
    "customerId": 0,
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "resellerId": 0
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/orders";
 
      
      string json = @"{
  ""order"": {
    ""id"": 0,
    ""orderNumber"": ""string"",
    ""status"": ""string"",
    ""processedBy"": ""string"",
    ""purchaseOrder"": ""string"",
    ""total"": 0.1,
    ""currency"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""invoiceNumber"": ""string"",
    ""paymentType"": ""string"",
    ""paymentNumber"": ""string"",
    ""paymentStatus"": ""string"",
    ""paymentDate"": ""2019-08-24T14:15:22Z"",
    ""description"": ""string"",
    ""customerId"": 0,
    ""customer"": {
      ""id"": 0,
      ""title"": ""string"",
      ""firstName"": ""string"",
      ""lastName"": ""string"",
      ""company"": ""string"",
      ""code"": ""string"",
      ""vatCode"": ""string"",
      ""invoiceCode"": ""string"",
      ""rating"": 0,
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""address"": ""string"",
      ""address1"": ""string"",
      ""address2"": ""string"",
      ""postalCode"": ""string"",
      ""region"": ""string"",
      ""city"": ""string"",
      ""country"": ""string"",
      ""countryCode"": ""string"",
      ""mapCoordinates"": ""string"",
      ""mapZoomLevel"": 0.1,
      ""email"": ""string"",
      ""phone"": ""string"",
      ""mobile"": ""string"",
      ""fax"": ""string"",
      ""website"": ""string"",
      ""notes"": ""string"",
      ""isReseller"": true,
      ""image"": ""string"",
      ""meta"": ""string"",
      ""contacts"": [
        {
          ""id"": 0,
          ""title"": ""string"",
          ""firstName"": ""string"",
          ""lastName"": ""string"",
          ""email"": ""string"",
          ""phone"": ""string"",
          ""mobile"": ""string"",
          ""fax"": ""string"",
          ""details"": ""string"",
          ""notify"": true,
          ""customerId"": 0,
          ""meta"": ""string""
        }
      ]
    },
    ""resellerId"": 0
  }
}";
      Management.UpdateOrderRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateOrderRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateOrderRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/orders

Updates an existing order.

Body parameter


{
  "order": {
    "id": 0,
    "orderNumber": "string",
    "status": "string",
    "processedBy": "string",
    "purchaseOrder": "string",
    "total": 0.1,
    "currency": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "paymentType": "string",
    "paymentNumber": "string",
    "paymentStatus": "string",
    "paymentDate": "2019-08-24T14:15:22Z",
    "description": "string",
    "customerId": 0,
    "customer": {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "code": "string",
      "vatCode": "string",
      "invoiceCode": "string",
      "rating": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": "string",
      "address1": "string",
      "address2": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mapCoordinates": "string",
      "mapZoomLevel": 0.1,
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "website": "string",
      "notes": "string",
      "isReseller": true,
      "image": "string",
      "meta": "string",
      "contacts": [
        {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "details": "string",
          "notify": true,
          "customerId": 0,
          "meta": "string"
        }
      ]
    },
    "resellerId": 0
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateOrderRequest	false	The request containing the details of the order to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateOrderResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/orders/{orderId}`DELETE /v1/orders/{orderId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/orders/{orderId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/orders/{orderId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/orders/\{orderId\}

Deletes an existing order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteOrderResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/orders/{orderId}/products`GET /v1/orders/{orderId}/products

Code samples

cURL


# You can also use wget
curl -X GET /v1/orders/{orderId}/products \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/orders/{orderId}/products";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/orders/\{orderId\}/products

Gets the products for a specific order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
include	query	string	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","orderProducts":[{"productId":0,"orderId":0,"quantity":0,"unitPrice":0.1,"discount":0.1,"taxes":0.1,"description":"string","product":{"id":0,"code":"string","name":"string","description":"string","url":"string","copyright":"string","createdAt":"2019-08-24T14:15:22Z","image":"string","price":0.1,"resellerPrice":0.1,"currency":"string","signatureKeysId":0,"meta":"string","signatureKeys":{"id":0,"name":"string","type":"string","code":"string","description":"string","source":"string","password":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","data":"string","dataFormat":"string","meta":"string"},"productOrders":[{}]},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0}}],"totalOrderProductsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "orderProducts": [
    {
      "productId": 0,
      "orderId": 0,
      "quantity": 0,
      "unitPrice": 0.1,
      "discount": 0.1,
      "taxes": 0.1,
      "description": "string",
      "product": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "url": "string",
        "copyright": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "image": "string",
        "price": 0.1,
        "resellerPrice": 0.1,
        "currency": "string",
        "signatureKeysId": 0,
        "meta": "string",
        "signatureKeys": {
          "id": 0,
          "name": "string",
          "type": "string",
          "code": "string",
          "description": "string",
          "source": "string",
          "password": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "data": "string",
          "dataFormat": "string",
          "meta": "string"
        },
        "productOrders": [
          {}
        ]
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      }
    }
  ],
  "totalOrderProductsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetOrderProductsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/orders/{orderId}/products/{productId}`POST /v1/orders/{orderId}/products/{productId}

Code samples

cURL


# You can also use wget
curl -X POST /v1/orders/{orderId}/products/{productId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products/{productId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/orders/{orderId}/products/{productId}";
      
      string json = @"{
  ""productOrder"": {
    ""productId"": 0,
    ""orderId"": 0,
    ""quantity"": 0,
    ""unitPrice"": 0.1,
    ""discount"": 0.1,
    ""taxes"": 0.1,
    ""description"": ""string"",
    ""product"": {
      ""id"": 0,
      ""code"": ""string"",
      ""name"": ""string"",
      ""description"": ""string"",
      ""url"": ""string"",
      ""copyright"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""image"": ""string"",
      ""price"": 0.1,
      ""resellerPrice"": 0.1,
      ""currency"": ""string"",
      ""signatureKeysId"": 0,
      ""meta"": ""string"",
      ""signatureKeys"": {
        ""id"": 0,
        ""name"": ""string"",
        ""type"": ""string"",
        ""code"": ""string"",
        ""description"": ""string"",
        ""source"": ""string"",
        ""password"": ""string"",
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""data"": ""string"",
        ""dataFormat"": ""string"",
        ""meta"": ""string""
      },
      ""productOrders"": [
        {}
      ]
    },
    ""order"": {
      ""id"": 0,
      ""orderNumber"": ""string"",
      ""status"": ""string"",
      ""processedBy"": ""string"",
      ""purchaseOrder"": ""string"",
      ""total"": 0.1,
      ""currency"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""invoiceNumber"": ""string"",
      ""paymentType"": ""string"",
      ""paymentNumber"": ""string"",
      ""paymentStatus"": ""string"",
      ""paymentDate"": ""2019-08-24T14:15:22Z"",
      ""description"": ""string"",
      ""customerId"": 0,
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""resellerId"": 0
    }
  }
}";
      Management.InsertProductOrderRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertProductOrderRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertProductOrderRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/orders/\{orderId\}/products/\{productId\}

Inserts a new product order.

Body parameter


{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
productId	path	integer(int32)	true	The product ID.
body	body	Management.InsertProductOrderRequest	false	The request containing the details of the product order to insert.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertProductOrderResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/orders/{orderId}/products/{productId}`PUT /v1/orders/{orderId}/products/{productId}

Code samples

cURL


# You can also use wget
curl -X PUT /v1/orders/{orderId}/products/{productId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products/{productId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/orders/{orderId}/products/{productId}";
 
      
      string json = @"{
  ""productOrder"": {
    ""productId"": 0,
    ""orderId"": 0,
    ""quantity"": 0,
    ""unitPrice"": 0.1,
    ""discount"": 0.1,
    ""taxes"": 0.1,
    ""description"": ""string"",
    ""product"": {
      ""id"": 0,
      ""code"": ""string"",
      ""name"": ""string"",
      ""description"": ""string"",
      ""url"": ""string"",
      ""copyright"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""image"": ""string"",
      ""price"": 0.1,
      ""resellerPrice"": 0.1,
      ""currency"": ""string"",
      ""signatureKeysId"": 0,
      ""meta"": ""string"",
      ""signatureKeys"": {
        ""id"": 0,
        ""name"": ""string"",
        ""type"": ""string"",
        ""code"": ""string"",
        ""description"": ""string"",
        ""source"": ""string"",
        ""password"": ""string"",
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""data"": ""string"",
        ""dataFormat"": ""string"",
        ""meta"": ""string""
      },
      ""productOrders"": [
        {}
      ]
    },
    ""order"": {
      ""id"": 0,
      ""orderNumber"": ""string"",
      ""status"": ""string"",
      ""processedBy"": ""string"",
      ""purchaseOrder"": ""string"",
      ""total"": 0.1,
      ""currency"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""invoiceNumber"": ""string"",
      ""paymentType"": ""string"",
      ""paymentNumber"": ""string"",
      ""paymentStatus"": ""string"",
      ""paymentDate"": ""2019-08-24T14:15:22Z"",
      ""description"": ""string"",
      ""customerId"": 0,
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""resellerId"": 0
    }
  }
}";
      Management.UpdateProductOrderRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateProductOrderRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateProductOrderRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/orders/\{orderId\}/products/\{productId\}

Updates an existing product order.

Body parameter


{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
productId	path	integer(int32)	true	The product ID.
body	body	Management.UpdateProductOrderRequest	false	The request containing the details of the product order to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateProductOrderResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/orders/{orderId}/products/{productId}`DELETE /v1/orders/{orderId}/products/{productId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/orders/{orderId}/products/{productId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products/{productId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/orders/{orderId}/products/{productId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/orders/\{orderId\}/products/\{productId\}

Deletes a specific product order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
productId	path	integer(int32)	true	The product ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteProductOrderResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/orders/{orderId}/licenses`GET /v1/orders/{orderId}/licenses

Code samples

cURL


# You can also use wget
curl -X GET /v1/orders/{orderId}/licenses \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/licenses',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/orders/{orderId}/licenses";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/orders/\{orderId\}/licenses

Gets the licenses for a specific order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenses":[{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicensesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenses": [
    {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicensesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetOrderLicensesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/resources`GET /v1/resources

Code samples

cURL


# You can also use wget
curl -X GET /v1/resources \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/resources',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/resources";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/resources

Gets a list of resources.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","resources":[{"id":0,"name":"string","type":"string","code":"string","description":"string","source":"string","password":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","data":"string","dataFormat":"string","meta":"string"}],"totalResourcesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "resources": [
    {
      "id": 0,
      "name": "string",
      "type": "string",
      "code": "string",
      "description": "string",
      "source": "string",
      "password": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "data": "string",
      "dataFormat": "string",
      "meta": "string"
    }
  ],
  "totalResourcesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetResourcesResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/resources`POST /v1/resources

Code samples

cURL


# You can also use wget
curl -X POST /v1/resources \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "resource": {
    "id": 0,
    "name": "string",
    "type": "string",
    "code": "string",
    "description": "string",
    "source": "string",
    "password": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "data": "string",
    "dataFormat": "string",
    "meta": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/resources',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/resources";
      
      string json = @"{
  ""resource"": {
    ""id"": 0,
    ""name"": ""string"",
    ""type"": ""string"",
    ""code"": ""string"",
    ""description"": ""string"",
    ""source"": ""string"",
    ""password"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""data"": ""string"",
    ""dataFormat"": ""string"",
    ""meta"": ""string""
  }
}";
      Management.InsertResourceRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertResourceRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertResourceRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/resources

Inserts a new resource.

Body parameter


{
  "resource": {
    "id": 0,
    "name": "string",
    "type": "string",
    "code": "string",
    "description": "string",
    "source": "string",
    "password": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "data": "string",
    "dataFormat": "string",
    "meta": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertResourceRequest	false	The request containing the details of the resource to insert.

Example responses

200 Response


{"resourceId":0,"success":true,"code":0,"message":"string"}


{
  "resourceId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertResourceResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/resources`PUT /v1/resources

Code samples

cURL


# You can also use wget
curl -X PUT /v1/resources \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "resource": {
    "id": 0,
    "name": "string",
    "type": "string",
    "code": "string",
    "description": "string",
    "source": "string",
    "password": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "data": "string",
    "dataFormat": "string",
    "meta": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/resources',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/resources";
 
      
      string json = @"{
  ""resource"": {
    ""id"": 0,
    ""name"": ""string"",
    ""type"": ""string"",
    ""code"": ""string"",
    ""description"": ""string"",
    ""source"": ""string"",
    ""password"": ""string"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""data"": ""string"",
    ""dataFormat"": ""string"",
    ""meta"": ""string""
  }
}";
      Management.UpdateResourceRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateResourceRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateResourceRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/resources

Updates an existing resource.

Body parameter


{
  "resource": {
    "id": 0,
    "name": "string",
    "type": "string",
    "code": "string",
    "description": "string",
    "source": "string",
    "password": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "data": "string",
    "dataFormat": "string",
    "meta": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateResourceRequest	false	The request containing the details of the resource to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateResourceResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/resources/{resourceId}`DELETE /v1/resources/{resourceId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/resources/{resourceId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/resources/{resourceId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/resources/{resourceId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/resources/\{resourceId\}

Deletes a resource.

Parameters

Name	In	Type	Required	Description
resourceId	path	integer(int32)	true	The resource ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteResourceResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/reports`GET /v1/reports

Code samples

cURL


# You can also use wget
curl -X GET /v1/reports \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/reports',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/reports";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/reports

Gets reports based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
include	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","reports":[{"id":0,"uid":"string","name":"string","version":"string","date":"2019-08-24T14:15:22Z","userKey":"string","machineId":"string","clientId":"string","clientName":"string","contentType":"string","content":"string","address":"string","properties":[{"id":0,"name":"string","value":"string","reportId":0}]}],"totalReportsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "reports": [
    {
      "id": 0,
      "uid": "string",
      "name": "string",
      "version": "string",
      "date": "2019-08-24T14:15:22Z",
      "userKey": "string",
      "machineId": "string",
      "clientId": "string",
      "clientName": "string",
      "contentType": "string",
      "content": "string",
      "address": "string",
      "properties": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "reportId": 0
        }
      ]
    }
  ],
  "totalReportsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetReportResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/reports/{reportId}`DELETE /v1/reports/{reportId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/reports/{reportId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/reports/{reportId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/reports/{reportId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/reports/\{reportId\}

Deletes a report with the specified ID.

Parameters

Name	In	Type	Required	Description
reportId	path	integer(int32)	true	The ID of the report to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteReportResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/log/levels`GET /v1/log/levels

Code samples

cURL


# You can also use wget
curl -X GET /v1/log/levels \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/log/levels',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/log/levels";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/log/levels

Gets the log levels for the specified date range.

Parameters

Name	In	Type	Required	Description
startDate	query	string(date-time)	false	none
endDate	query	string(date-time)	false	none
intervals	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","logLevels":[{"date":"2019-08-24T14:15:22Z","level":"string","count":0}],"groupBy":"string","totalLogLevelEntriesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "logLevels": [
    {
      "date": "2019-08-24T14:15:22Z",
      "level": "string",
      "count": 0
    }
  ],
  "groupBy": "string",
  "totalLogLevelEntriesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLogLevelsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/log`GET /v1/log

Code samples

cURL


# You can also use wget
curl -X GET /v1/log \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/log',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/log";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/log

Gets the log entries based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
startDate	query	string(date-time)	false	none
endDate	query	string(date-time)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","logEntries":[{"id":0,"message":"string","messageTemplate":"string","level":"string","timeStamp":"2019-08-24T14:15:22Z","exception":"string","properties":"string"}],"totalLogEntriesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "logEntries": [
    {
      "id": 0,
      "message": "string",
      "messageTemplate": "string",
      "level": "string",
      "timeStamp": "2019-08-24T14:15:22Z",
      "exception": "string",
      "properties": "string"
    }
  ],
  "totalLogEntriesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetLogResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

DELETE`/v1/log`DELETE /v1/log

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/log \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'x-api-key':'API_KEY'
};
 
fetch('/v1/log',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/log";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/log

Deletes a log based on the provided request.

Parameters

Name	In	Type	Required	Description
id	query	integer(int32)	false	none
filter	query	string	false	none
startDate	query	string(date-time)	false	none
endDate	query	string(date-time)	false	none
deleteAll	query	boolean	false	none

Responses

Status	Meaning	Description
200	OK	The log has been deleted successfully. Example:
{
“Success”: true,
“Message”: “A total of 10 log entries have been deleted.”,
“DeletedLogCount”: 10
}	None

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/settings`GET /v1/settings

Code samples

cURL


# You can also use wget
curl -X GET /v1/settings \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/settings',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/settings";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/settings

Gets the application settings.

Parameters

Name	In	Type	Required	Description
request	query	Management.GetSettingsRequest	false	The request containing the parameters for the application settings to retrieve.

Example responses

200 Response


{"success":true,"code":0,"message":"string","settings":[{"group":"string","name":"string","type":"string","value":null}]}


{
  "success": true,
  "code": 0,
  "message": "string",
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetSettingsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

PUT`/v1/settings`PUT /v1/settings

Code samples

cURL


# You can also use wget
curl -X PUT /v1/settings \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/settings',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/settings";
 
      
      string json = @"{
  ""settings"": [
    {
      ""group"": ""string"",
      ""name"": ""string"",
      ""type"": ""string"",
      ""value"": null
    }
  ]
}";
      Management.UpdateSettingsRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateSettingsRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateSettingsRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/settings

Updates the application settings.

Body parameter


{
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateSettingsRequest	false	The request containing the updated settings.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateSettingsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET`/v1/info`GET /v1/info

Code samples

cURL


# You can also use wget
curl -X GET /v1/info \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/info',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/info";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/info

Gets the server information.

Example responses

200 Response


{"success":true,"code":0,"message":"string","product":"string","edition":0,"version":"string","license":"string","serverHost":"string","serverTime":"2019-08-24T14:15:22Z","clientAddress":"string","activeTokens":0,"maxTokens":0,"activationTokens":0,"floatingTokens":0,"expiredTokens":0,"totalLicenses":0,"revokedLicenses":0,"tracedLicenses":0,"activationLicenses":0,"floatingLicenses":0,"fileLicenses":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "product": "string",
  "edition": 0,
  "version": "string",
  "license": "string",
  "serverHost": "string",
  "serverTime": "2019-08-24T14:15:22Z",
  "clientAddress": "string",
  "activeTokens": 0,
  "maxTokens": 0,
  "activationTokens": 0,
  "floatingTokens": 0,
  "expiredTokens": 0,
  "totalLicenses": 0,
  "revokedLicenses": 0,
  "tracedLicenses": 0,
  "activationLicenses": 0,
  "floatingLicenses": 0,
  "fileLicenses": 0
}

Responses

Status	Meaning	Description
200	OK	The server information has been retrieved successfully. Example:
{
“Product”: “Babel Licensing Service”,
“Version”: “10.7.0"
"ServerHost”: “172.34.12.1"
"ServerTime”: “2022-01-01T00:00:00Z”,
…
}	Management.GetServerInfoResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/email/send`POST /v1/email/send

Code samples

cURL


# You can also use wget
curl -X POST /v1/email/send \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "to": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "subject": "string",
  "body": "string",
  "isHtml": true,
  "attachments": [
    {
      "fileName": "string",
      "content": "string",
      "contentType": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/email/send',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/email/send";
      
      string json = @"{
  ""to"": [
    {
      ""name"": ""string"",
      ""email"": ""string""
    }
  ],
  ""subject"": ""string"",
  ""body"": ""string"",
  ""isHtml"": true,
  ""attachments"": [
    {
      ""fileName"": ""string"",
      ""content"": ""string"",
      ""contentType"": ""string""
    }
  ]
}";
      Management.SendEmailRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.SendEmailRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.SendEmailRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/email/send

Sends an email using the configured email service.

Body parameter


{
  "to": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "subject": "string",
  "body": "string",
  "isHtml": true,
  "attachments": [
    {
      "fileName": "string",
      "content": "string",
      "contentType": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	Management.SendEmailRequest	false	The request containing the email details to send.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.SendEmailResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST`/v1/email/license`POST /v1/email/license

Code samples

cURL


# You can also use wget
curl -X POST /v1/email/license \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "licenseId": 0,
  "resourceId": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/email/license',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/email/license";
      
      string json = @"{
  ""licenseId"": 0,
  ""resourceId"": 0
}";
      Management.SendLicenseEmailRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.SendLicenseEmailRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.SendLicenseEmailRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/email/license

Sends an email to a licensee based on a license and email resource.

Body parameter


{
  "licenseId": 0,
  "resourceId": 0
}

Parameters

Name	In	Type	Required	Description
body	body	Management.SendLicenseEmailRequest	false	The request containing license and email details to send.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.SendLicenseEmailResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET/v1/api-keysGET /v1/api-keys

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/api-keysPOST /v1/api-keys

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/api-keysPUT /v1/api-keys

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/api-keys/{apiKeyId}DELETE /v1/api-keys/{apiKeyId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET/v1/usersGET /v1/users

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/usersPOST /v1/users

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/usersPUT /v1/users

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/users/{userId}DELETE /v1/users/{userId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET/v1/users/{userId}/settingsGET /v1/users/{userId}/settings

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/users/{userId}/settingsPOST /v1/users/{userId}/settings

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/users/{userId}/settingsPUT /v1/users/{userId}/settings

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/users/{userId}/settings/{settingId}DELETE /v1/users/{userId}/settings/{settingId}

Code samples

cURL

GET`/v1/api-keys`GET /v1/api-keys

POST`/v1/api-keys`POST /v1/api-keys

PUT`/v1/api-keys`PUT /v1/api-keys

DELETE`/v1/api-keys/{apiKeyId}`DELETE /v1/api-keys/{apiKeyId}

GET`/v1/users`GET /v1/users

POST`/v1/users`POST /v1/users

PUT`/v1/users`PUT /v1/users

DELETE`/v1/users/{userId}`DELETE /v1/users/{userId}

GET`/v1/users/{userId}/settings`GET /v1/users/{userId}/settings

POST`/v1/users/{userId}/settings`POST /v1/users/{userId}/settings

PUT`/v1/users/{userId}/settings`PUT /v1/users/{userId}/settings

DELETE`/v1/users/{userId}/settings/{settingId}`DELETE /v1/users/{userId}/settings/{settingId}

GET`/v1/roles`GET /v1/roles

GET`/v1/users/{userId}/roles`GET /v1/users/{userId}/roles

POST`/v1/users/{userId}/roles`POST /v1/users/{userId}/roles

DELETE`/v1/users/{userId}/roles`DELETE /v1/users/{userId}/roles

GET`/v1/assemblies`GET /v1/assemblies

POST`/v1/assemblies`POST /v1/assemblies

PUT`/v1/assemblies`PUT /v1/assemblies

DELETE`/v1/assemblies/{assemblyId}`DELETE /v1/assemblies/{assemblyId}

GET`/v1/licenses`GET /v1/licenses

POST`/v1/licenses`POST /v1/licenses