| API REFERENCE |
|---|
| FUNCTIONS |
|---|
| Partner Services |
| Create Quick Lead |
| Application Status |
| Application Bounce |
API Reference
The Utilihub API is RESTful. Our API has resource-oriented URLs, uses basic authentication and HTTPS, at all times. Pre-registration with Utilihub is required to obtain authentication credentials and all data objects are represented via the JSON format.
The following methods are supported:
- HTTP POST: For Create operations
- HTTP GET – For Read operations
- HTTP PUT – For Update operations
Moreover, Utilihub API now supports CORS. For a third-party domain to be allowed to make a CORS request, the domain must be whitelisted by our API. The whitelisting of domains enforces additional security to Utilihub API.
Functions
Partner Services
Retrieves services available for the Partner
Sample Request:
Output:
[
{
"ServiceId": "1",
"ServiceName": "Electricity"
},
{
"ServiceId": "2"
"ServiceName": "Gas"
},
{
"ServiceId": "3",
"ServiceName": "Water"
}
]
Create Quick Lead
Enables the submission of a Quick Application from the Partner Example Request:
{
"PartnerCode":"mhb",
"Lead":{
"FirstName":"John",
"LastName":"Doe",
"Email":"testjohn@mail.com",
"PrimaryPhone":"0123456789",
"MoveInDate":"30-05-2016"
},
"SelectedServices":"1,2,3",
"AgentReferred":"developer@movinghub.com.au"
}
Output:
{
"PartnerCode":"mhb",
"Lead":{
"FirstName":"John",
"LastName":"Doe",
"Email":"testjohn@mail.com",
"PrimaryPhone":"0123456789",
"MoveInDate":"30-05-2016"
},
"SelectedServices":"1,2,3",
"AgentReferred":"developer@movinghub.com.au"
}
Application Status
Enables the Partners to query the status of submitted applications
Sample Request:
Output:
[
{
"ReferenceCode": "mhb-8SP31540",
"ApplicationStatus": "Quick",
"ApplicationTag": null,
"DateAdded": "22-06-2017 13:30:24",
"DateUpdated": "22-06-2017 13:30:24",
"DateActioned": null,
"DateCompleted": null
}
]
Application Bounce
Enables the Partners to correct an error in any application.
Sample Request:
{
"ReferenceCode":"mhb-8SP31540",
"Lead":{
"PrimaryPhone":"0123456789"
},
"Metacomment":"Contacted client. Reachable now."
}
Output:
{
"ReferenceCode":"mhb-8SP31540",
"ApplicationStatus":"Partial"
}