GreenDeal-Open Api Document

Get Checklist

Path: /pvds/get_checklist.json

Example: https://www.greendeal.com.au/rapi/v1/pvds/get_checklist.json

HTTP Method: GET

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"

Response

Parameter	Type	Example	Description
checklist_id	Integer	3	checklist id
title	String		checklist title
type	String	boolean	Has to be one of the following options: boolean text image
images	JSON		checklist_image_parameter_info
answer	String	test
answered_at	String	Jan 12 2021 20:07:49
full_name	String	xx xx	installer name
is_required	String	true	the checklist is required

Checklist Image parameter info

Parameter	Type	Example	Description
id	Integer
image	String	https://xxx.com.au/xxx.png	checklist image url
record_at	String

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595"
}

Response Example

      
[
  {
    "checklist_id":3,
    "title":"Array frame is certified to AS1170.2 for installation location",
    "type":"boolean",
    "images":[
    ],
    "answer":"true",
    "answered_at":"Jan 12 2021 20:07:49",
    "full_name":"xx xx",
    "is_required":"false"
  },
  {
    "checklist_id":15,
    "title":"Picture of Roof before installation",
    "type":"image",
    "images":[
      {
        "id":"332072",
        "image":"https://xxx.com/greendeals3test/xxx.png",
        "record_at":"2020-11-10T19:52:15.418+11:00"
      }
    ],
    "answer":"",
    "answered_at":"Jan 12 2021 20:15:49",
    "full_name":"xx xx",
    "is_required":"true"
  },
  {
    "checklist_id":406,
    "title":"test",
    "type":"text",
    "images":[
    ],
    "answer":"test text",
    "answered_at":"Jan 12 2021 20:09:42",
    "full_name":"xx xx",
    "is_required":"true"
  }
]