PLBFInspections

API change history

Submit Plumbing Backflow (PLBF) Device Inspections
Please see Developer Guide for more info.

Submit a PLBF Device Inspection

Submit a PLBF Device 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

{
    "application": {
        "modelNumber": "40415A1I",
        "serialNumber": "SF808",
        "plumbingApplicationNumber": "",
        "backFlowDeviceReferenceNumber": "",
        "byPassModelNumber": null,
        "byPassSerialNumber": null,
        "byPassPlumbingApplicationNumber": null,
        "byPassBackFlowDeviceReferenceNumber": null,
        "address": "8 Omrah Ave",
        "city": "Caloundra",
        "state": "QLD",
        "postcode": "4551",
        "location": "IGA - FHR on wall at base of stairwell in office area.",
        "makeId": "Conbraco",
        "makeDescription": "Conbraco",
        "byPassMakeId": null,
        "byPassMakeDescription": null,
        "typeId": "DCV",
        "typeDescription": "Double Check Valve",
        "byPassTypeId": null,
        "protectionId": "Individual",
        "protectionDescription": "Individual",
        "truckId": "No",
        "truckDescription": "No"
    },
    "company": {
        "vendorMappingInUse": "SCCTest",
        "companyId": "SCC",
        "companyDescription": "SCC"
    },
    "appendix": "E",
    "testComment": "",
    "testDateTime": "2020-05-14T12:00:26Z",
    "testerFirstName": "Dev",
    "testerLastName": "Portal",
    "testerLicenceNo": "10001",
    "testKitLastVerified": "2020-03-02T12:00:00Z",
    "testResult": "Pass",
    "pdfDocumentInBase64": "",
    "pdfDocument2InBase64": "",
    "serialNumberPhotoInBase64": "",
    "devicePhotoInBase64": "",
    "locationPhotoInBase64": ""
}
{
  "type": "object",
  "properties": {
    "application": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InspectionApplication"
        }
      ]
    },
    "company": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InspectionCompany"
        }
      ]
    },
    "appendix": {
      "type": "string",
      "default": "E"
    },
    "testComment": {
      "type": "string",
      "nullable": true,
      "default": ""
    },
    "testDateTime": {
      "type": "string",
      "format": "date-time",
      "default": "2020-01-01T01:00:00Z"
    },
    "testerFirstName": {
      "type": "string",
      "default": "Dev"
    },
    "testerLastName": {
      "type": "string",
      "default": "Portal"
    },
    "testerLicenceNo": {
      "type": "string",
      "default": "10001"
    },
    "testKitLastVerified": {
      "type": "string",
      "format": "date-time",
      "default": "2020-01-01T01:00:00Z"
    },
    "testResult": {
      "type": "string",
      "description": "Basic values: Pass, Failed, Removed, Replaced.",
      "default": "Pass"
    },
    "pdfDocumentInBase64": {
      "type": "string",
      "description": "Attach a PDF by encoding the file to base64.\r\nOptional.",
      "nullable": true,
      "default": ""
    },
    "pdfDocument2InBase64": {
      "type": "string",
      "description": "Optionally attach a second PDF Document",
      "nullable": true,
      "default": ""
    },
    "serialNumberPhotoInBase64": {
      "type": "string",
      "description": "Attach a Photo by encoding the file to base64.\r\nOptional.",
      "nullable": true,
      "default": ""
    },
    "devicePhotoInBase64": {
      "type": "string",
      "description": "Attach a Photo by encoding the file to base64.\r\nOptional.",
      "nullable": true,
      "default": ""
    },
    "locationPhotoInBase64": {
      "type": "string",
      "description": "Attach a Photo by encoding the file to base64.\r\nOptional.",
      "nullable": true,
      "default": ""
    }
  },
  "additionalProperties": false,
  "required": [
    "appendix",
    "application",
    "company",
    "testDateTime",
    "testerFirstName",
    "testerLastName",
    "testerLicenceNo",
    "testKitLastVerified",
    "testResult"
  ]
}

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.sunshinecoast.qld.gov.au/plbfinspections/"
-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.sunshinecoast.qld.gov.au/plbfinspections/?" + 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.sunshinecoast.qld.gov.au/plbfinspections/");


            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.sunshinecoast.qld.gov.au/plbfinspections/?" + $.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.sunshinecoast.qld.gov.au/plbfinspections/";
    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.sunshinecoast.qld.gov.au/plbfinspections/');
$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.sunshinecoast.qld.gov.au')
    conn.request("POST", "/plbfinspections/?%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.sunshinecoast.qld.gov.au')
    conn.request("POST", "/plbfinspections/?%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.sunshinecoast.qld.gov.au/plbfinspections/')


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