Admin Organizations (v1)

The Admin Organization API provides access to create, read and update organization resources. Organizations are the top level of the organizational hierarchy. All child resources are associated to organizations either directly or through intermediary resources. Only a partner can create or modify an organization.

PutOrganizationsWithAddresses

Save or update a list of new or existing organization with address resources.
Partner subscription key is required.

Test Route

Try it

Note: When you click on the Try It button you may see the following warning message: "" You can ignore this warning message and proceed by entering appropriate values for any query parameters and required header values.

Request URL

Request parameters

(optional)

string

Filter by active state.

Request headers

string

Environment in which to execute the request.

string

A GUID identifier for requesting partner specific resources.

string

String value representing userid or application name issuing the request.
(optional)

string

Media type of the body sent to the API.

string

A string identifier for authenticating subscription specific resources.

Request body

[
  {
    "organizationID": 1,
    "organizationName": "Demo Organization",
    "beaconProximityUUID": "dc57e2b5-a7b7-477b-b971-da2bec4d0c69",
    "active": true,
    "businessAddress_ID": 1,
    "address1": "1400 Lester Rd NW",
    "address2": "",
    "city": "Conyers",
    "stateProvince": "GA",
    "postalCode": "30012",
    "country": "USA",
    "contact_ID": 1,
    "contactName": "jenny smith",
    "contactNumber": "410-867-5309",
    "contactRole": "admin",
    "sitesAssociated": "all",
    "contactEmail": "jenny.smith@acuitynext.io"
  },
  {
    "organizationName": "Demo Organization",
    "beaconProximityUUID": "dc57e2b5-a7b7-477b-b971-da2bec4d0c69",
    "active": true,
    "businessAddress_ID": 1,
    "address1": "1400 Lester Rd NW",
    "address2": "",
    "city": "Conyers",
    "stateProvince": "GA",
    "postalCode": "30012",
    "country": "USA",
    "contact_ID": 1,
    "contactName": "jenny smith",
    "contactNumber": "410-867-5309",
    "contactRole": "admin",
    "sitesAssociated": "all",
    "contactEmail": "jenny.smith@acuitynext.io"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "organizationID": {
        "format": "int32",
        "description": "A unique numerical identifier of the organization resource",
        "type": "integer"
      },
      "organizationName": {
        "description": "User friendly name for organization",
        "type": "string"
      },
      "partner_ID": {
        "format": "int32",
        "description": "A numerical identifier that associates an organization to a partner resource",
        "type": "integer"
      },
      "beaconProximityUUID": {
        "description": "GUID for beacon proximity",
        "type": "string"
      },
      "active": {
        "description": "Flag defining active status",
        "type": "boolean"
      },
      "businessAddress_ID": {
        "format": "int32",
        "description": "A numerical identifier that associates an organization to a business address resource",
        "type": "integer"
      },
      "address1": {
        "description": "Address First Line",
        "type": "string"
      },
      "address2": {
        "description": "Address Second Line",
        "type": "string"
      },
      "city": {
        "description": "City",
        "type": "string"
      },
      "stateProvince": {
        "description": "State / Province",
        "type": "string"
      },
      "postalCode": {
        "description": "Organization's primary address postal code",
        "type": "string"
      },
      "country": {
        "description": "3 Digit Country Code",
        "type": "string"
      }
    },
    "example": {
      "organizationID": 1,
      "organizationName": "Demo Organization",
      "partner_ID": 1,
      "beaconProximityUUID": "dc57e2b5-a7b7-477b-b971-da2bec4d0c69",
      "active": true,
      "businessAddress_ID": 1,
      "address1": "1400 Lester Rd NW",
      "address2": "",
      "city": "Conyers",
      "stateProvince": "GA",
      "postalCode": "30012",
      "country": "USA"
    }
  },
  "example": [
    {
      "organizationID": 1,
      "organizationName": "Demo Organization",
      "beaconProximityUUID": "dc57e2b5-a7b7-477b-b971-da2bec4d0c69",
      "partner_ID": 1,
      "active": true,
      "businessAddress_ID": 1,
      "address1": "1400 Lester Rd NW",
      "address2": "",
      "city": "Conyers",
      "stateProvince": "GA",
      "postalCode": "30012",
      "country": "USA"
    }
  ]
}

Response 200

Returns a collection of updated organization with address and contact and role resources.

{
  "result": [
    {
      "role_ID": 1,
      "allSites": false,
      "organizationID": 1,
      "organizationName": "Demo Organization",
      "partner_ID": 1,
      "beaconProximityUUID": "dc57e2b5-a7b7-477b-b971-da2bec4d0c69",
      "active": true,
      "businessAddress_ID": 1,
      "address1": "1400 Lester Rd NW",
      "address2": "",
      "city": "Conyers",
      "stateProvince": "GA",
      "postalCode": "30012",
      "country": "USA"
    }
  ],
  "count": 1,
  "limit": null,
  "offset": null
}
{
  "required": [
    "result",
    "count"
  ],
  "type": "object",
  "properties": {
    "result": {
      "description": "Array of Results",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role_ID": {
            "format": "int32",
            "description": "A numerical identifier that associates a role_ to a role resource",
            "type": "integer"
          },
          "allSites": {
            "description": "Defines if Role has access to all sites",
            "type": "boolean"
          },
          "organizationID": {
            "format": "int32",
            "description": "Unique Organization Identifier",
            "type": "integer"
          },
          "organizationName": {
            "description": "User friendly name for organization",
            "type": "string"
          },
          "partner_ID": {
            "format": "int32",
            "description": "A numerical identifier that associates an organization to a partner resource",
            "type": "integer"
          },
          "beaconProximityUUID": {
            "description": "Beacon Proximity UUID",
            "type": "string"
          },
          "active": {
            "description": "Defines whether record is active.",
            "type": "boolean"
          },
          "businessAddress_ID": {
            "format": "int32",
            "description": "A numerical identifier that associates a role_ to a business address resource",
            "type": "integer"
          },
          "address1": {
            "description": "Organization's primary address number and street name",
            "type": "string"
          },
          "address2": {
            "description": "Organization's primary address additional address line",
            "type": "string"
          },
          "city": {
            "description": "Organization's primary address city",
            "type": "string"
          },
          "stateProvince": {
            "description": "Organization's primary address state",
            "type": "string"
          },
          "postalCode": {
            "description": "Organization's primary address postal code",
            "type": "string"
          },
          "country": {
            "description": "Organization's primary address country",
            "type": "string"
          }
        },
        "example": {
          "role_ID": 1,
          "allSites": false,
          "organizationID": 1,
          "organizationName": "Demo organization",
          "partner_ID": 1,
          "beaconProximityUUID": 1,
          "active": true,
          "businessAddress_ID": 1,
          "address1": "1400 Lester Rd NW",
          "address2": "",
          "city": "Conyers",
          "stateProvince": "GA",
          "postalCode": "30012",
          "country": "USA"
        }
      }
    },
    "count": {
      "format": "int32",
      "description": "The number of records in the response",
      "type": "integer"
    },
    "limit": {
      "format": "int32",
      "description": "The requested result limit",
      "type": "integer"
    },
    "offset": {
      "format": "int32",
      "description": "The requested number of skipped results",
      "type": "integer"
    }
  },
  "example": {
    "result": [
      {
        "role_ID": 1,
        "allSites": false,
        "organizationID": 1,
        "organizationName": "Demo Organization",
        "partner_ID": 1,
        "beaconProximityUUID": "dc57e2b5-a7b7-477b-b971-da2bec4d0c69",
        "active": true,
        "businessAddress_ID": 1,
        "address1": "1400 Lester Rd NW",
        "address2": "",
        "city": "Conyers",
        "stateProvince": "GA",
        "postalCode": "30012",
        "country": "USA"
      }
    ],
    "count": 1,
    "limit": null,
    "offset": null
  }
}

Response 400

Invalid Request.

{
  "msg": "Improper format for call.",
  "requestId": "273e4bb4-3019-42ea-8de9-f2c7853f7fdd",
  "code": "BadRequest"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Response 401

Not Authorized To Access This Resource.

{
  "msg": "Unauthorized to access this resource.",
  "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
  "code": "Unauthorized"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Response 404

Resource Not Found.

{
  "msg": "The resource requested was not found.",
  "requestId": "b9ff87b2-3397-45f7-a0b6-25482b0a7898",
  "code": "NotFound"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses?active=active"
-H "atr-environment-id: atrdemo01us"
-H "atr-partner-id: "
-H "atr-request-source: "
-H "Content-Type: application/json"
-H "atr-subscription-key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("atr-environment-id", "atrdemo01us");
            client.DefaultRequestHeaders.Add("atr-partner-id", "");
            client.DefaultRequestHeaders.Add("atr-request-source", "");
            client.DefaultRequestHeaders.Add("atr-subscription-key", "{subscription key}");

            // Request parameters
            queryString["active"] = "active";
            var uri = "https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses");

            builder.setParameter("active", "active");

            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("atr-environment-id", "atrdemo01us");
            request.setHeader("atr-partner-id", "");
            request.setHeader("atr-request-source", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("atr-subscription-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "active": "active",
        };
      
        $.ajax({
            url: "https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("atr-environment-id","atrdemo01us");
                xhrObj.setRequestHeader("atr-partner-id","");
                xhrObj.setRequestHeader("atr-request-source","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("atr-subscription-key","{subscription key}");
            },
            type: "PUT",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"active=active",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"atrdemo01us" forHTTPHeaderField:@"atr-environment-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-partner-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-request-source"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"atr-subscription-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'atr-environment-id' => 'atrdemo01us',
    'atr-partner-id' => '',
    'atr-request-source' => '',
    'Content-Type' => 'application/json',
    'atr-subscription-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'active' => 'active',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'atr-environment-id': 'atrdemo01us',
    'atr-partner-id': '',
    'atr-request-source': '',
    'Content-Type': 'application/json',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'active': 'active',
})

try:
    conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("PUT", "/api/v1/admin/organizations/with-addresses?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'atr-environment-id': 'atrdemo01us',
    'atr-partner-id': '',
    'atr-request-source': '',
    'Content-Type': 'application/json',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'active': 'active',
})

try:
    conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("PUT", "/api/v1/admin/organizations/with-addresses?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.us.atrius-iot.io/api/v1/admin/organizations/with-addresses')

query = URI.encode_www_form({
    # Request parameters
    'active' => 'active'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['atr-environment-id'] = 'atrdemo01us'
# Request headers
request['atr-partner-id'] = ''
# Request headers
request['atr-request-source'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['atr-subscription-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body