GetRequests API

Base Endpoint: GET https://api.vlenseg.com/api/BusinessRequest/GetRequests

Overview: This endpoint retrieves a paginated list of business requests. It supports filtering and sorting options for easy access to the data. The response includes metadata such as the total count of requests and details for each request.

Headers:

• ApiKey (required): The API key for authenticating the request.

• TenancyName (required): The tenancy name that identifies the tenant.

• Authorization (required): Bearer token for user authentication, obtained from the Login API.

Get a list of business requests

get

This endpoint retrieves a paginated list of business requests. It supports bearer authentication using the access token from the login API.

Authorizations

BearerAuth

Query parameters

skipCountintegerOptional

The number of records to skip

maxResultCountintegerOptional

The maximum number of records to return

RequestTypestringOptional

The business request id to filter by

FilterTextstringOptional

To filter any text for Id, RequestNumber, .. etc

Header parameters

ApiKeystringRequired

TenancyNamestringRequired

AuthorizationstringRequiredExample: Bearer <access_token>

Responses

200

Successful response

application/json

400

Bad request, missing or invalid fields

401

Unauthorized, invalid credentials

get

/api/BusinessRequest/GetRequests

HTTPcURLJavaScriptPython

GET /api/BusinessRequest/GetRequests HTTP/1.1
Host: 
Authorization: Bearer <access_token>
ApiKey: text
TenancyName: text
Accept: */*

{
  "data": {
    "totalCount": 86,
    "items": [
      {
        "id": "1e83a2e5-3d89-4b30-aa29-21e6171dd388",
        "requestNumber": "Req-7269230638555178366428213",
        "requestStatusName": "CustomerSigned",
        "creationTime": "2024-07-02T11:50:36.6427383",
        "lastModificationTime": "2024-08-12T12:40:31.553314",
        "hasContract": true
      }
    ]
  },
  "error_code": null,
  "error_message": null
}

JavaScript

const axios = require('axios');

const url = 'https://api.vlenseg.com/api/BusinessRequest/GetRequests';
const headers = {
    'ApiKey': 'xxx',  // Replace with your actual API key
    'TenancyName': 'Test',  // Replace with your tenancy name
    'Authorization': 'Bearer <access_token>'  // Replace <access_token> with the token returned from the login API
};

axios.get(url, { headers })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(`Error: ${error.response.status}`, error.response.data);
    });

Python

cURL