GreenDeal-Open Api Document

Update Job Address

Path: /pvds/update_address.json

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

HTTP Method: POST

Request Parameter

Parameter	Type	Is Required?	Note	Example
id	String	Yes		"GWT383595"
owner_address	Hash	Required if needed	See owner_address params info Note: The information is the same as before if set as null or not included in the request body.	`{ "first_name": "test", "last_name": "test", "address_type": "physical", "street_number": "116", "street_type":"ACCS", "suburb": "CHURCHLANDS", "street_name": "BIRCHWOOD AVENUE", "phone": "0xxxxxxxxx", "state": "ACT", "post_code": "6068", "owner_type": "Individual", "email": "test@hotmail.com" }`
install_address	Hash	Required if needed	See install_address params info Note: The information is the same as before if set as null or not included in the request body.	`{ "same_as_postal": "false", "story": "Single story", "post_code": "6068", "street_number": "116", "street_name": "BIRCHWOOD AVENUE WOODLANDS", "street_type": "ACCS", "suburb": "CHURCHLANDS", "state": "ACT", "property_type": "Residential", "nmi": "xxxxxxxxxx", "job_number": "yyyyyyyyy" }`

owner_address params info

Parameter	Type	Is Required?	Note	Example
owner_type	String	Yes	Valid values are: "Individual", "Corporate body", "Government body" or "Trustee"	"Individual"
first_name	String	No	first name(required when owner_type is "Individual" )	"Avril Ramona"
last_name	String	No	last name(required when owner_type is "Individual" )	"Lavigne"
owner_type_name	String	No	the name of "Corporate body", "Government body" or "Trustee" (required when owner_type is each of them)	"INTERNATIONAL FISH SUPPLIERS PTY. LTD"
owner_representative_name	String	No	the name of "Corporate body", "Government body" or "Trustee" (required when owner_type is each of them)	"test"
owner_representative_position	String	No	the name of "Corporate body", "Government body" or "Trustee" (required when owner_type is each of them)	"test"
unit_type	String	No	unit Type of owner address	"ANT"
unit_number	String	No	unit number of owner address	"4"
street_number	String	No	street number of owner address	"10"
street_name	String	No	street name of owner address	"GEORGE ST"
street_type	String	No	street Type of owner address	"ACCESS"
suburb	String	Yes	suburb of the owner address	"Barangaroo"
state	String	Yes	state of the owner address	"QLD"
post_code	String	Yes	the region zip code	"4571"
address_type	String	Yes	Type of owner address 1.physical 2.p_o_box(postal) Valid values are: "physical" or "p_o_box"	"physical"
phone	String	Yes	owner phone	"07 3387 1810"
email	String	Yes	owner email	"stc@greendeal.com.au"
price_to_the_home_owner	String	Yes	System owner's STC unit price required when owner_type is not "Individual" and property_type is "Commercial" or "School"	3x.xx
home_owner_abn	String	Yes	System owner's ABN required when owner_type is not "Individual" and property_type is "Commercial" or "School"	12345678911

install_address params info

Parameter	Type	Is Required?	Note	Example
same_as_postal	String	No	The installation address is the same as the owner's address； 1.Value="true",The following owner_address parameter information is required,and address_type must be "physical": address_type=physical,street_number,street_name,street_type,suburb,state,post_code 2.Value="false" Note: Cannot update the parameter after panel installed.	"true"
property_type	String	Yes	Valid values are: "Residential", "School" or "Commercial"	"School"
story	String	Yes	Valid values are: "Single story" or "Multi story"	"Single story"
nmi	String	Yes	serial number of electric meter	"1111111111"
job_number	String	No	Job Number for DERR	"1111111111"
unit_type	String	No	unit type Note: Cannot update the parameter after panel installed.	"ANT"
unit_number	String	No	unit number Note: Cannot update the parameter after panel installed.	"25"
street_number	String	No	street number Note: Cannot update the parameter after panel installed.	"33"
street_name	String	Yes	street name Note: Cannot update the parameter after panel installed.	"JERVIS"
street_type	String	Yes	street type Note: Cannot update the parameter after panel installed.	"ACCESS"
suburb	String	Yes	suburb Note: Cannot update the parameter after panel installed.	"BEECHMONT"
state	String	Yes	state Note: Cannot update the parameter after panel installed.	"QLD"
post_code	String	Yes	post code Note: Cannot update the parameter after panel installed.	"4211"
latitude	String	No	between -90 and 90	"50"
longitude	String	No	between -180 and 180	"80"
special_address	String	No	special address	"Street type should be : Avenue south"

Request Example

      
{
  "client_id": "23565656e63f33016ad7f4f338a6f70be78c136addbbb9c803d09756c6ee93f1",
  "signature": "2dc1b977b376a2fd26bf05c1f15da59b",
  "timestamp": "2019-08-02T10:31:50+11:00",
  "id": "GWT383595",
  "install_address":{
      "unit_type":null,
      "unit_number":null,
      "post_code":"",
      "street_number":"",
      "street_name":"",
      "suburb":"",
      "state":"ACT",
      "property_type":"",
      "latitude":null,
      "longitude":null,
      "special_address":null,
      "story":"",
      "nmi":"",
      "job_number":null,
      "installation_address":"",
      "single_or_multi_story":"",
      "same_as_postal":false,
      "street_type":""
  },
  "owner_address":{
      "first_name":null,
      "last_name":null,
      "phone":"",
      "delivery_type":"",
      "delivery_number":"",
      "unit_type":null,
      "unit_number":null,
      "post_code":"",
      "street_number":"",
      "street_name":" AVENUE",
      "suburb":"",
      "state":"ACT",
      "email":"",
      "price_to_the_home_owner":"33.xx",
      "home_owner_abn":"",
      "owner_representative_name":"test",
      "owner_representative_position":"test",
      "type":"",
      "type_name":"test",
      "address_type":"",
      "address":"",
      "street_type":""
  }
}

Response Example

See Get Stc Job Response