OSFInspections

API change history

Submit Onsite Sewage Facilities (OSF) Inspections
Please see Developer Guide for more info.

Submit an OSF Inspection

Submit an OSF Inspection

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "osf": {
    "vendorMappingInUse": "SCCTest",
    "applicationNumber": "",
    "processId": null,
    "propertyId": 123123,
    "address1": "1 Omrah Avenue",
    "address2": "string",
    "suburb": "Caloundra",
    "state": "QLD",
    "postCode": "4551",
    "disposalTypeId": "2",
    "disposalTypeDescription": "sub-surface",
    "systemTypeId": "AquaNova",
    "systemTypeDescription": "AquaNova",
    "serviceIntervalId": "3",
    "serviceIntervalDescription": "3 months",
    "serialNumber": "123456",
    "lastServiceDateTime": "2020-01-01T01:00:00Z"
  },
  "serviceDateTime": "2020-01-01T01:00:00Z",
  "testerFirstName": "SCC",
  "testerLastName": "Test",
  "testerLicenceNo": "1001001",
  "testerComments": "This is a test",
  "problemIdentified": true,
  "inspectionResultId": "Satisfy",
  "inspectionResultDescription": "Satisfactory",
  "inspectionTypeId": "Service",
  "inspectionTypeDescription": "Service",
  "alarmConditionId": "Satisfy",
  "alarmConditionDescription": "Satisfactory",
  "causeId": "HighSludge",
  "causeDescription": "High Sludge",
  "disposalConditionId": "GOOD",
  "disposalConditionDescription": "GOOD",
  "sludgeConditionId": "Level OK",
  "sludgeConditionDescription": "Level OK",
  "report": "",
  "reportFilename": ""
}
{
  "type": "object",
  "properties": {
    "osf": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "vendorMappingInUse": {
              "type": "string",
              "description": "This code is provided by SCC",
              "default": "SCCTest"
            },
            "applicationNumber": {
              "type": "string",
              "default": ""
            },
            "processId": {
              "type": "integer",
              "format": "int32",
              "default": null
            },
            "propertyId": {
              "type": "integer",
              "format": "int32",
              "default": 123123
            },
            "address1": {
              "type": "string",
              "default": "1 Omrah Avenue"
            },
            "address2": {
              "type": "string"
            },
            "suburb": {
              "type": "string",
              "default": "Caloundra"
            },
            "state": {
              "type": "string",
              "default": "QLD"
            },
            "postCode": {
              "type": "string",
              "default": "4551"
            },
            "disposalTypeId": {
              "type": "string",
              "default": "2"
            },
            "disposalTypeDescription": {
              "type": "string",
              "default": "sub-surface"
            },
            "systemTypeId": {
              "type": "string",
              "default": "AquaNova"
            },
            "systemTypeDescription": {
              "type": "string",
              "default": "AquaNova"
            },
            "serviceIntervalId": {
              "type": "string",
              "default": "3"
            },
            "serviceIntervalDescription": {
              "type": "string",
              "default": "3 months"
            },
            "serialNumber": {
              "type": "string",
              "default": "123456"
            },
            "lastServiceDateTime": {
              "type": "string",
              "format": "date-time",
              "default": "2020-01-01T01:00:00Z"
            }
          },
          "required": [
            "disposalTypeId",
            "serviceIntervalId",
            "systemTypeId",
            "vendorMappingInUse"
          ]
        }
      ]
    },
    "serviceDateTime": {
      "type": "string",
      "format": "date-time",
      "default": "2020-01-01T01:00:00Z"
    },
    "testerFirstName": {
      "type": "string",
      "default": "SCC"
    },
    "testerLastName": {
      "type": "string",
      "default": "Test"
    },
    "testerLicenceNo": {
      "type": "string",
      "default": "1001001"
    },
    "testerComments": {
      "type": "string",
      "default": "This is a test"
    },
    "problemIdentified": {
      "type": "boolean",
      "default": true
    },
    "inspectionResultId": {
      "type": "string",
      "default": "Satisfy"
    },
    "inspectionResultDescription": {
      "type": "string",
      "default": "Satisfactory"
    },
    "inspectionTypeId": {
      "type": "string",
      "default": "Service"
    },
    "inspectionTypeDescription": {
      "type": "string",
      "default": "Service"
    },
    "alarmConditionId": {
      "type": "string",
      "default": "Satisfy"
    },
    "alarmConditionDescription": {
      "type": "string",
      "default": "Satisfactory"
    },
    "causeId": {
      "type": "string",
      "description": "Single or multiple Cause IDs (separated by comma) are accepted",
      "default": "HighSludge"
    },
    "causeDescription": {
      "type": "string",
      "default": "High Sludge"
    },
    "disposalConditionId": {
      "type": "string",
      "default": "GOOD"
    },
    "disposalConditionDescription": {
      "type": "string",
      "default": "GOOD"
    },
    "sludgeConditionId": {
      "type": "string",
      "default": "Level OK"
    },
    "sludgeConditionDescription": {
      "type": "string",
      "default": "Level OK"
    },
    "report": {
      "type": "string",
      "description": "Report as a Base64 string",
      "default": ""
    },
    "reportFilename": {
      "type": "string",
      "description": "The name of the report file",
      "default": ""
    }
  },
  "required": [
    "serviceDateTime",
    "testerFirstName",
    "testerLastName",
    "testerLicenceNo"
  ]
}

Responses

200 OK

Submission successful

Representations

{
  "errors": [
    {
      "detail": "string",
      "code": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "errors": [
    {
      "detail": "string",
      "code": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    }
  }
}

401 Unauthorized

Unauthorized

Representations

{
  "errors": [
    {
      "detail": "string",
      "code": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    }
  }
}

422 Unprocessable Entity

Inspection failed validation

Representations

{
  "errors": [
    {
      "detail": "string",
      "code": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.devi.sccdi-internal.com/osfinspections/"
-H "Content-Type: application/json"
-H "ApiKey: {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("ApiKey", "{subscription key}");

            var uri = "https://api.devi.sccdi-internal.com/osfinspections/?" + 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.PostAsync(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.devi.sccdi-internal.com/osfinspections/");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("ApiKey", "{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
        };
      
        $.ajax({
            url: "https://api.devi.sccdi-internal.com/osfinspections/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("ApiKey","{subscription key}");
            },
            type: "POST",
            // 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.devi.sccdi-internal.com/osfinspections/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"ApiKey"];
    // 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.devi.sccdi-internal.com/osfinspections/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'ApiKey' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json',
    'ApiKey': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.devi.sccdi-internal.com')
    conn.request("POST", "/osfinspections/?%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
    'Content-Type': 'application/json',
    'ApiKey': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.devi.sccdi-internal.com')
    conn.request("POST", "/osfinspections/?%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.devi.sccdi-internal.com/osfinspections/')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['ApiKey'] = '{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