Greenbot’s Vendor API documentation allows you to create Greenbot jobs, Edit Jobs and Retrieve Job information from your Solar Company Greenbot Portal.

For the implementation process, Greenbot provides test server information as follows:

Test API Service URL: https://devapi.greenbot.com.au/
To test the API, you are able to use the devapi user logging to explore.

Test Login User: devapi  | Test Login Password: devapi

Live API Service URL: https://api.greenbot.com.au

Please Note: For a new account, only test environment is available. Until the connection and implementation prove sends by the approval, the live environment of Greenbot system will not beavailable.

Below are the standard response you will get on when it is success response or error response :

Success Response

{
"Status": true,
"StatusCode": "OK",
"Message": "Successful message"
}

Error Responses

1.

{
"Status": false,
"StatusCode": "NoContent",
"Message": " Error message"
}

2.

{
"Status": false,
"StatusCode": "BadRequest",
"Message": "Street Number is required. Phone is required. State is required. Post Code is required.
Street Number is required. Street Name is required. Town is required. State is required. Street Type
is required."
}

3.

{
Message": "Authorization has been denied for this request."
}

This method is used to validate login details like Username and Password to access greenbot system. On success response api will return bearer token for Authentication. This token will active for 1 day for now and we can change it as per our need.

5.1.1 Invocation Details

• Path : /api/Account/Login
• Type : Post
• Headers:
    - Content-Type: application/json

5.1.2 Login Request Base Parameters

5.1.3 Login Examples

Request:

{
"Username" : "devapi",
"Password" : "devapi"
} 

Response:

{
"TokenData": {
"access_token": "N3Xo6SVvmic483QG6lGgsHJIJ9pzWe9bvyfQTNqZcmIjY_I-
5g92W_CRnQ9exQeIozLBZkFNNjRCqDqcMf7EoWh6Rvv4-
1qt14bASoWSiz8TBhPbu82ltmKFb6G9FSh9Al5C_q-
M5zWDJE14rsec3wCDVGvSoXsqZGIGD092l4i7D4KXEdeoZT8ZceZlnQ4pFzUE9RgzCJa9yKqYEG1OUQ",
"token_type": "bearer"
},
"Status": true,
"StatusCode": "OK",
"Message": "Login Successfully"
}

This method is used for creating job. You need to pass bearer token which was generated at the time of login for authentication along with request body parameters

5.2.1 Create Job Invocation Details

• Path : /api/Account/CreateJob
• Type : Post
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    _{(Example :
    Authorization: bearer N3Xo6SVvmic483QG6lGgsHJIJ9pzWe9bvyfQTNqZcmIjY_I-
    5g92W_CRnQ9exQeIozLBZkFNNjRCqDqcMf7EoWh6Rvv4-
    1qt14bASoWSiz8TBhPbu82ltmKFb6G9FSh9Al5C_q-
    M5zWDJE14rsec3wCDVGvSoXsqZGIGD092l4i7D4KXEdeoZT8ZceZlnQ4pFzUE9RgzCJa9yKqYEG1OU
    Q)}

5.2.2 Create Job Request Base Parameters

5.2.3 Create Job Example

Request:

{
    "VendorJobId": "YourUniqueVendorID_01",
    "BasicDetails": {
        "Title": "Mark Jacobs - 5kW System VIC ",
        "Description": "22 x 330W suntech panels with 5kW SMA inverter",
        "RefNumber": "YourUniqueVendorID_01",
        "JobStage": "1",
        "JobType": "1",
        "Priority": "1",
        "strInstallationDate": "2020/08/12", // YYYY/MM/DD
        "IsGst": "true", //for attaching GST invoice to the job for +GST claims
        "GSTDocument": "Gst.txt",
        "GstFileBase64": ""
    },
    "JobOwnerDetails": {
        "OwnerType": "Corporate body",
        "CompanyName": " GREENBOT PTY. LTD.",
        "CompanyABN": "83614837124",
        "FirstName": "Mark",
        "LastName": "Jacobs",
        "Phone": "0399000000",
        "Mobile": "0400000000",
        "EMail": "noreply@emergingenergy.com.au",
        "AddressID": 1,
        "IsPostalAddress": false,
        "StreetNumber": "300",
        "StreetName": "Wales",
        "StreetTypeID": "1",
        "Town": "MELBOURNE",
        "State": "VIC",
        "PostCode": "3000"
    },
    "JobInstallationDetails": {
        "AddressID": 1,
        "PostalAddressID": 0,
        "StreetNumber": "300",
        "StreetName": "Wales",
        "StreetTypeID": "1",
        "Town": "MELBOURNE",
        "State": "VIC",
        "PostCode": "3000",
        "NMI": "22313113222",
        "PropertyType": "Commercial",
        "SingleMultipleStory": "Single story",
        "InstallingNewPanel": "replacing", //values are new, extension, adding or replacing. If value is not new, then JobInstallationDetails>location and  JobSTCDetails>AdditionalCapacityNotes is mandatory
        "Location": "North", //Associated with installingNewPanel field if additional or replacement
        "ExistingSystem": true, //Put information about any existing system before
        "ExistingSystemSize": "10",
        "NoOfPanels": 2,
        "SystemLocation": "Existing system location notes isset here and also in JobSTCDetails>AdditionalCapacityNotes field",
        "AdditionalInstallationInformation": "Custom installation information that is in the Additional Installation field"
    },
    "JobSTCDetails": {
        "TypeOfConnection": "Connected to an electricity grid without battery storage",
        "SystemMountingType": "Building or structure",
        "DeemingPeriod": "10",
        "MultipleSGUAddress": "Yes",
        "Location": "South",
        "AdditionalLocationInformation": "This notes is used for more than 1 SGU additional information", //this notes is for more than 1 SGU
        "AdditionalCapacityNotes": "this is for additional systems, replacing systems or extension systems installation notes" //this notes is for installation type: Additional, Replacement. This note is mandatory if InstallingNewPanel value is extension, adding, or replacing
    },
    "InstallerView": {
        "CECAccreditationNumber": "A1234567",
        "FirstName": "Greenbot",
        "LastName": "El",
        "IsAutoAddVisit": "false", //if installer is connected, allows for a visit to be scheduled if set to true.
        "IsUpdate": "true", //allows for installer details to be edited for example address information if set to true
        "AddressID": 1,
        "StreetNumber": "123",
        "StreetName": "Wales",
        "StreetTypeID": "1",
        "Town": "TANSEY",
        "State": "QLD",
        "PostCode": "4601",
        "Phone": "4563221",
        "Mobile": "895463217",
        "Email": "noreply@emergingenergy.com.au",
        "SEDesignRoleId": 3,
        "SignBase64": "",
        "SESignature": "installerSignature.jpg",
        "Latitude": "23.0346774", //associated with installer signature capture
        "Longitude": "72.5021803" //associated with installer signature capture
    },
    "DesignerView": {
        "CECAccreditationNumber": "A2834459",
        "FirstName": "Aaron",
        "LastName": "Adams",
        "IsUpdate": "true", //allows for designer details to be edited for example address information if set to true
        "Phone": "4563221",
        "Mobile": "895463217",
        "Email": "noreply@emergingenergy.com.au",
        "AddressID": 1,
        "StreetName": "melbourne",
        "StreetNumber": "123",
        "StreetTypeID": "1",
        "Town": "MELBOURNE",
        "State": "VIC",
        "PostCode": "3000",
        "SEDesignRoleId": 1,
        "SignBase64": "",
        "SESignature": "r_4ab4acb5-aa31-4ddb-99fc-a94e36ecbd11.jpg",
        "Latitude": "23.0346774",
        "Longitude": "72.5021803"
    },
    "JobElectricians": {
        "LicenseNumber": "a4290312123",
        "CompanyName": "Electrician Company Name",
        "FirstName": "John",
        "LastName": "Doe",
        "IsUpdate": "true", //allows for installer details to be edited for example address information if set to true
        "IsPostalAddress": 0,
        "StreetTypeID": "1",
        "StreetNumber": "123",
        "StreetName": "melbourne",
        "Town": "MELBOURNE",
        "State": "VIC",
        "PostCode": "3000",
        "Phone": "0400000000",
        "Mobile": "0400000000",
        "Email": "noreply@emergingenergy.com.au"
    },
    "JobSystemDetails": {
        "SystemSize": "6.66",
        "SerialNumbers": "4567"
    },
    "panel": [
        {
            "Brand": "Wuxi Suntech Power Co Ltd",
            "Model": "STP330S-A60/Wfhm",
            "NoOfPanel": "2"
        }
    ],
    "inverter": [
        {
            "Brand": "ABB Australia",
            "Series": "ACSM1 Solar Pump Drive",
            "Model": "ACSM1-04AS-012A-4",
            "NoOfInverter": "1"
        }
    ],
    "batteryManufacturer": [
        {
            "Brand": "Alpha ESS Co Ltd",
            "Model": "eSTORE-BAT-10.3",
            "BatterySystemPartOfAnAggregatedControl": "No",
            "ChangedSettingOfBatteryStorageSystem": "No"
        }
    ]
    //  "lstJobNotes" : 
    //[
    //{"VendorJobNoteId" : "21","Notes" : ""},
    // {"VendorJobNoteId" : "22","Notes" : ""}
    //],
    //"lstCustomDetails": [
    //  {
    //    "VendorJobCustomFieldId": "InverterSerialNumber",
    //   "FieldValue": "322390538259023,325235252",
    //    "FieldName": "InverterSerialNumber"
    //  }
    // ]
} 

Response:

{
"Status": true,
"StatusCode": "OK",
"Message": "Job Created Successfully"
}

This method is used for updating job. You need to pass bearer token which was generated at the time of login for authentication along with request body parameters

5.3.1 Update Job Invocation Details

• Path : /api/Account/UpdateJob
• Type : Post
• Headers:
• Content-Type: application/json
• Authorization: "token_type" "access_token"

5.3.2 Request Base Parameters

Refer table on Section 5.2.2

5.3.3 Update Job Example

Success Response:

{
"Status": true,
"StatusCode": "OK",
"Message": " Job Updated Successfully"
}

This method will allow you to retrieve data of all panels by calling this API

5.4.1 Get Panel Invocation Details

• Path : /api/Account/GetPanel
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"

5.4.2 Get Panel Example

Success Response:

{
"panel":
[
{"Brand":"Ablytek Co Ltd","Model":"6MN48145"},
{"Brand":"Ablytek Co Ltd","Model":"6MN48150"}
]
}

You will get the data of inverters by calling this API.

5.5.1 Get Inverter Invocation Details

• Path : /api/Account/GetInverter
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"

5.5.2 Get Inverter Example

Success Response:

{
"inverter":[
{
      "Brand": "(ABB) Power-One Energy Solutions Pty Ltd",
      "Series": "String Inverter",
      "Model": "UNO-2.0-I-OUTD"
},
{
      "Brand": "(ABB) Power-One Energy Solutions Pty Ltd",
      "Series": "String Inverter",
      "Model": "UNO-2.0-I-OUTD-S"
}
]
}

You will get the data for system brand by using this method.

5.6.1 Get System Brand Invocation Details

• Path : /api/Account/GetSystemBrand
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"

5.6.2 Get System Brand Example

Success Response:

{
"systemBrand":[
{
"Brand": "Airmax",
"Model": "270-11AC3-134"
},
{
"Brand": "Airmax",
"Model": "270-11AC4-134"
}]
}

You will get the data of battery storage detail by calling this API.

5.7.1 Get Battery Manufacture Invocation Details

• Path : /api/Account/GetBatterymanufacturer
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
     

5.7.2 Get Battery Manufacture Example

Success Response:

{
"batteryManufacturer:[
{
"Brand": "Wuxi Soltaro EnergyTechnology Co Ltd", "Model": "SOL-R16-4.5KWH"
},
{
"Brand": "LG Chem LTD.",
"Model": "RESU10"
}
]
}

This method will allow you to upload images into your targeted job by using the VendorJobId parameter. Images must be converted to a base64 string. Images will be sent to the Default Photos (New Job Screen) and targeted folder such as serial number photos or installation photos sub-folders. Target destination of photo file by using the PhotoType parameter.

5.8.1 Upload Job Image Invocation Details

• Path : /api/Account/UploadJobImage
• Type : Post
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.8.2 Upload Job Image Request Base Parameters

5.8.3 Upload Job Image Example

Request:

{
"VendorJobPhotoId" : "SerialPhotos01",
"VendorJobID":735,
"IsClassic": false,
"ImageBase64":"BASE64 STRING",
"PhotoType":"1",
"Filename":"r_4ab4acb5-aa31-4ddb-99fc-a94e36ecbd11.jpg",
"Latitude":"23.0346774",
"Longitude":"72.5021803"
}

Success Response:

{
"Status": true,
"StatusCode": "OK",
"Message": "Photo uploaded successfully"
}

This method will allow you to upload documents into your targeted job by using the VendorJobId parameter. Documents must be converted to a base64 string. Documents will be sent to CES, STC or Other document sections. Target destination of document file by using the DocumentType parameter.

5.9.1 Upload Documents Invocation Details

• Path : /api/Account/UploadJobImage
• Type : Post
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.9.2 Upload Documents Request Base Parameters

5.9.3 Upload Documents Example

Request:

{
"VendorJobId":"12Feb2",
"IsClassic":1,
"VendorJobDocumentId":"12Feb_D_1",
"DocumentType":"2",
"DocumentName":"New2.pdf",
"JobType":"1",
"DocumentBase64":"BASE64 STRING"
}

Success Response:

{
"Status": true,
"StatusCode": "OK",
"Message": "Document uploaded successfully"
}

This method will allow you to delete images in a targeted job by using the VendorJobId parameter and also the VendorJobPhotoId.

5.10.1 Delete Job Image Invocation Details

• Path : /api/Account/DeleteJobImage
• Type : Post
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.10.2 Delete Job Image Request Base Parameters

5.10.3 Delete Job Image Example

Request:

Deleting single photo :
{
"VendorJobId":"12Feb2018",
"VendorJobPhotoId":"12Feb2018_P_125",
"IsClassic":1
}

Deleting multiple photos :
{
"VendorJobId":"12Feb2018",
"VendorJobPhotoId":"12Feb2018_P_125, 12Feb2018_P_126",
"IsClassic":1
}Success Response:

{
"Status": true,
"StatusCode": "OK",
"Message": "Photo deleted successfully"
}

This method will allow you to delete job documents into your targeted job by using the VendorJobId and VendorJobDocumentId parameter.

5.11.1 Delete Documents Invocation Details

• Path : /api/Account/DeleteDocuments
• Type : Post
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.11.2 Delete Documents Request Base Parameters

5.11.3 Delete Documents Example

Request:

Deleting single document:
{
"VendorJobId":"12Feb2018",
" VendorJobDocumentId ":" 12Feb2018_D_1",
"IsClassic":1
}

Deleting multiple documents:
{
"VendorJobId":"12Feb2018",
" VendorJobDocumentId ":" 12Feb2018_D_1, 12Feb2018_D_2",
"IsClassic":1
}

Success Response:

{
"Status": true,
"StatusCode": "OK",
"Message": " Document deleted successfully"
}

This method will allow you to get solar job data from the Greenbot Portal. Data can be retrieved by date range, creation date, refNumber and VendorJobId.

5.12.1 GetJobs Invocation Details

• Path : /api/Account/GetJobs?CreatedDate=DD/MM/YYYY
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.12.2 GetJobs Examples

Request:

Path : /api/Account/GetJobs?FromDate=08/02/2018&ToDate=09/02/2018
Path : /api/Account/GetJobs?CreatedDate=08/02/2018
Path : /api/Account/GetJobs?RefNumber=XXX
Path : /api/Account/GetJobs?VendorJobId=XXXXXX
Path : /api/Account/GetJobs?JobId=XXXXXX

Success Response:

{

"lstJobData": [

{

"BasicDetails": {
"VendorJobId":"12Feb2018",
“CreatedDate”:"2018-02-08T00:00:00”,
"JobType": 1,
"RefNumber": "ClassicScreen_Job",
"JobStage": 1,
"Title": "ClassicScreen_Job",
"InstallationDate": "2018-12-10T00:00:00",
"Priority": 1,
"Description": "ClassicScreen_Job",
"IsClassic": true
},
"JobOwnerDetails": {
"OwnerType": "Individual",
"CompanyName": "",
"FirstName": "FFF2",
"LastName": "LL2",
"UnitTypeID": null,
"UnitNumber": "",
"StreetNumber": "123",
"StreetName": "Wales",
"Town": "MELROSE",
"State": "QLD",
"PostCode": "4613",
"Phone": "456321",
"Mobile": "",
"Email": "",
"IsPostalAddress": false,
"PostalAddressID": "",
"PostalDeliveryNumber": "",
"AddressID": 1,
"StreetTypeID": 1
},
"JobElectricians": {
"CompanyName": "",
"FirstName": "",
"LastName": "",
"Email": "",
"Phone": "",
"Mobile": "",
"LicenseNumber": "",
"AddressID": 1,
"UnitTypeID": null,
"UnitNumber": "",
"IsPostalAddress": false,
"PostalAddressID": 0,
"PostalDeliveryNumber": "",
"StreetNumber": "",
"StreetName": "",
"StreetTypeID": null,
"Town": "",
"State": "",
"PostCode": ""
},
"JobInstallationDetails": {
"UnitTypeID": null,
"UnitNumber": "",
"StreetNumber": "123",
"StreetName": "Wales",
"Town": "MELROSE",
"State": "QLD",
"PostCode": "4613",
"NMI": "",
"PropertyType": "Commercial",
"PropertyName": "",
"SingleMultipleStory": "Single story",
"InstallingNewPanel": "New",
"MeterNumber": "",
"PhaseProperty": "",
"ElectricityProviderID": null,
"AdditionalNotes": "",
"ExistingSystem": true,
"ExistingSystemSize": 10,
"NoOfPanels": 2,
"SystemLocation": "first sys location",
"SystemSize": null,
"PostalDeliveryNumber": "",
"IsPostalAddress": false,
"PostalAddressID": 0,
"AddressID": 1,
"StreetTypeID": 1,
"Location": "",
"DistributorID": null,
"AdditionalInstallationInformation": "adddi"
},
"JobSTCDetails": {
"TypeOfConnection": "Connected to an electricity grid without battery storage",
"SystemMountingType": "Building or Structure",
"InstallingCompleteUnit": "Yes",
"AdditionalCapacityNotes": "",
"DeemingPeriod": "One year",
"CertificateCreated": "",
"FailedAccreditationCode": "",
"FailedReason": "",
"MultipleSGUAddress": "Yes",
"Location": "North",
"SGUSystemLocated": "",
"VolumetricCapacity": "",
"StatutoryDeclarations": "",
"SecondhandWaterHeater": "",
"AdditionalLocationInformation": "",
"AdditionalSystemInformation": ""
},
"JobSystemDetails": {
"SystemSize": 26,
"SerialNumbers": "oneagainyes
"CalculatedSTC": 35,
"CalculatedSTCForSWH": null,
"SystemBrand": null,
"SystemModel": null,
"NoOfPanel": null,
"InstallationType": ""
},
"JobInstallerDetails": {
"FirstName": "",
"Surname": "",
"Phone": "",
"Mobile": "",
"Email": "",
"UnitTypeID": null,
"UnitNumber": "",
"StreetNumber": "",
"StreetName": "",
"Town": "",
"State": "",
"PostCode": "",
"IsPostalAddress": false,
"PostalAddressID": 0,
"PostalDeliveryNumber": "",
"StreetTypeID": null,
"AddressID": 1,
"ElectricianID": 0
},
"InstallerView": {
"FirstName": "Installer_test",
"LastName": "Test_Installer",
"UnitTypeID": 0,
"UnitNumber": "",
"StreetNumber": "123",
"StreetName": "Wales",
"StreetTypeID": 1,
"Town": "MELROSE",
"State": "QLD",
"PostCode": "4613",
"CECAccreditationNumber": "A0242480",
"CECDesignerNumber": "",
"IsPostalAddress": false,
"PostalAddressID": 0,
"PostalDeliveryNumber": "",
"AddressID": 1,
"Email": "",
"SEDesignRoleId": 0,
"ElectricalContractorsLicenseNumber": "",
"Phone": "4563221",
"Mobile": "895463217"
},
"DesignerView": {
"FirstName": null,
"LastName": null,
"UnitTypeID": 0,
"UnitNumber": null,
"StreetNumber": null,
"StreetName": null,
"StreetTypeID": 0,
"Town": null,
"State": null,
"PostCode": null,
"CECAccreditationNumber": null,
"CECDesignerNumber": null,
"IsPostalAddress": false,
"PostalAddressID": 0,
"PostalDeliveryNumber": null,
"AddressID": 1,
"Email": null,
"SEDesignRoleId": 0,
"ElectricalContractorsLicenseNumber": null,
"Phone": null,
"Mobile": null
},
"lstJobPanelDetails": [
{
"JobPanelID": 24353,
"JobID": 7530,
"Brand": "Advance Future GmbH",
"Model": "AEF-5M-170M-72",
"NoOfPanel": 2,
"CreatedBy": 544,
"ModifiedBy": 0,
"IsDeleted": false,
"CertificateHolder": null,
"ModelNumber": null
},
{
"JobPanelID": 24354,
"JobID": 7530,
"Brand": "All PV Australia Pty Ltd",
"Model": "AP5M24-55",
"NoOfPanel": 2,
"CreatedBy": 544,
"ModifiedBy": 0,
"IsDeleted": false,
"CertificateHolder": null,
"ModelNumber": null
}
],
"lstJobInverterDetails": [],
"lstCustomDetails": null,
"STCStatus": "Not Yet Submitted"
}
],
"Status": true,
"StatusCode": "OK",
"Message": "Jobs found"
}

This method will allow you to get STC submission data from the Greenbot Portal. Data can be retrieved by date range, creation date, refNumber and VendorJobId.

5.13.1 Get Submission Invocation Details

• Path : /api/Account/GetStcSubmission?VendorJobId=VendorJobId
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.13.2 Get Submission Examples

Success Response:

{
"lstStcSubmissionData": [
{
"VendorJobId":
"Vendor_20180718",
"STC": 4,
"STCStatus": "CER Approved",
"STCPVDCode": "125",
"CERApprovedDate": "2018-07-18T20:04:11.69",
"TradedBy": "Deep Solar Company"
}
],
"Status": true,
"StatusCode": "OK",
"Message": "Stc data found"
}

This method will allow you to get the scheduling details of job from the Greenbot Portal.

5.14.1 Get Job Scheduling Detail Invocation Details

• Path : /api/Account/GetJobSchedulingDetail?VendorJobId=VendorJobId
• Type : Get
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.14.2 Get Submission Examples

Success Response:

{
"lstJobSchedulingDetails": [ 
{ 
"JobSchedulingId": 167288, 
"VisitUniqueId": "200818002", 
"VisitStatus": "Open", 
"VisitCheckListItems": [ 
{ 
"VisitChecklistItemId": 1544535, 
"ItemName": "Capture Back Panel Label" 
}, 
{ 
"VisitChecklistItemId": 1544536, 
"ItemName": "Capture PV Serial Numbers" 
}, 
{ 
"VisitChecklistItemId": 1544537, 
"ItemName": "Capture Installation Photos" 
}, 
{ 
"VisitChecklistItemId": 1544538, 
"ItemName": "Capture Inverter(s) photo" 
}, 
{ 
"VisitChecklistItemId": 1544539, 
"ItemName": "Capture Meterbox Photos" 
}, 
{ 
"VisitChecklistItemId": 1544540, 
"ItemName": "Capture Switchboard Photos" 
}, 
{
"VisitChecklistItemId": 1544541, 
"ItemName": "Capture inverter(s) Model label" 
}, 
{ 
"VisitChecklistItemId": 1544542, 
"ItemName": "Capture Signatures" 
}, 
{ 
"VisitChecklistItemId": 1544543, 
"ItemName": "Capture Certificate of Electrical Safety" 
}, 
{ 
"VisitChecklistItemId": 1544544, 
"ItemName": "Scan serial numbers only" 
} 
] 
} 
], 
"Status": true, 
"StatusCode": "OK", 
"Message": "Job Scheduling data found" 
}

This method will allow you to close visit of job from the Greenbot Portal.

5.15.1 Close Visit Invocation Details

• Path : /api/Account/CloseVisit
• Type : Post
• Headers:
  • Content-Type: application/json
  • Authorization: "token_type" "access_token"
    
    

5.9.2 Upload Documents Request Base Parameters

5.9.3 Upload Documents Example

Request:

{ 
"VendorJobId":"rid_VendorApi_20200820_3", 
"JobSchedulingId":"10917", 
"VisitStatus":1 
}

Success Response:

{ 
"Status": true, 
"StatusCode": "OK", 
"Message": "Visit status has been changed successfully." 
}

6.1 JobType

6.2 JobStage

6.3 Priority

6.4 OwnerType

6.5 AddressID

6.6 PropertyType

6.7 SingleMultipleStory

6.8 InstallingNewPanel

6.9 TypeOfConnection

6.10 SystemMountingType

6.11 DeemingPeriod (Based on installation year)

With increase in Installation Year = DeemingPeriod will decrease

6.12 MultipleSGUAddress

6.13 Location

6.14 UnitTypeID

6.15 StreetTypeID

6.16 PostalAddressID

6.17 SWH InstallationType

6.18 SEDesignRole

6.19 PhotoType

6.20 DocumentType

6.21 DocumentNameID

6.22 DistributorID

6.23 ElectricityProviderID

6.24 IsDefault