organisationExtOrganisationIdStatusGet
Check Organisation Status
Used to check the status of your organisation with MiPro
/organisation/{extOrganisationId}/status
Usage and SDK Samples
curl -X GET\
-H "X-API-KEY: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.mipro.com/organisation/{extOrganisationId}/status"import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganisationDataApi;
import java.io.File;
import java.util.*;
public class OrganisationDataApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");
OrganisationDataApi apiInstance = new OrganisationDataApi();
String xAPIKEY = xAPIKEY_example; // String | API authentication key
String extOrganisationId = extOrganisationId_example; // String | External organisation identifier
try {
OrganisationStatus result = apiInstance.organisationExtOrganisationIdStatusGet(xAPIKEY, extOrganisationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganisationDataApi#organisationExtOrganisationIdStatusGet");
e.printStackTrace();
}
}
}import io.swagger.client.api.OrganisationDataApi;
public class OrganisationDataApiExample {
public static void main(String[] args) {
OrganisationDataApi apiInstance = new OrganisationDataApi();
String xAPIKEY = xAPIKEY_example; // String | API authentication key
String extOrganisationId = extOrganisationId_example; // String | External organisation identifier
try {
OrganisationStatus result = apiInstance.organisationExtOrganisationIdStatusGet(xAPIKEY, extOrganisationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganisationDataApi#organisationExtOrganisationIdStatusGet");
e.printStackTrace();
}
}
}Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
String *xAPIKEY = xAPIKEY_example; // API authentication key
String *extOrganisationId = extOrganisationId_example; // External organisation identifier
OrganisationDataApi *apiInstance = [[OrganisationDataApi alloc] init];
// Check Organisation Status
[apiInstance organisationExtOrganisationIdStatusGetWith:xAPIKEY
extOrganisationId:extOrganisationId
completionHandler: ^(OrganisationStatus output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var MiProApi = require('mi_pro_api');
var defaultClient = MiProApi.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-KEY'] = "Token"
var api = new MiProApi.OrganisationDataApi()
var xAPIKEY = xAPIKEY_example; // {{String}} API authentication key
var extOrganisationId = extOrganisationId_example; // {{String}} External organisation identifier
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.organisationExtOrganisationIdStatusGet(xAPIKEY, extOrganisationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class organisationExtOrganisationIdStatusGetExample
{
public void main()
{
// Configure API key authorization: apiKey
Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
var apiInstance = new OrganisationDataApi();
var xAPIKEY = xAPIKEY_example; // String | API authentication key
var extOrganisationId = extOrganisationId_example; // String | External organisation identifier
try
{
// Check Organisation Status
OrganisationStatus result = apiInstance.organisationExtOrganisationIdStatusGet(xAPIKEY, extOrganisationId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling OrganisationDataApi.organisationExtOrganisationIdStatusGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');
$api_instance = new Swagger\Client\ApiOrganisationDataApi();
$xAPIKEY = xAPIKEY_example; // String | API authentication key
$extOrganisationId = extOrganisationId_example; // String | External organisation identifier
try {
$result = $api_instance->organisationExtOrganisationIdStatusGet($xAPIKEY, $extOrganisationId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OrganisationDataApi->organisationExtOrganisationIdStatusGet: ', $e->getMessage(), PHP_EOL;
}
?>use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationDataApi;
# Configure API key authorization: apiKey
$WWW::SwaggerClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";
my $api_instance = WWW::SwaggerClient::OrganisationDataApi->new();
my $xAPIKEY = xAPIKEY_example; # String | API authentication key
my $extOrganisationId = extOrganisationId_example; # String | External organisation identifier
eval {
my $result = $api_instance->organisationExtOrganisationIdStatusGet(xAPIKEY => $xAPIKEY, extOrganisationId => $extOrganisationId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling OrganisationDataApi->organisationExtOrganisationIdStatusGet: $@\n";
}from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: apiKey
swagger_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.OrganisationDataApi()
xAPIKEY = xAPIKEY_example # String | API authentication key
extOrganisationId = extOrganisationId_example # String | External organisation identifier
try:
# Check Organisation Status
api_response = api_instance.organisation_ext_organisation_id_status_get(xAPIKEY, extOrganisationId)
pprint(api_response)
except ApiException as e:
print("Exception when calling OrganisationDataApi->organisationExtOrganisationIdStatusGet: %s\n" % e)Parameters
Path parameters
| Name | Description |
|---|---|
| extOrganisationId* |
String
External organisation identifier
Required
|
Header parameters
| Name | Description |
|---|---|
| X-API-KEY* |
String
API authentication key
Required
|