API REFERENCE |
---|
FUNCTIONS |
---|
Partner Services |
Create Quick Lead |
Application Status |
Application Bounce |
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:
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.
Retrieves services available for the Partner
[
{
"ServiceId": "1",
"ServiceName": "Electricity"
},
{
"ServiceId": "2"
"ServiceName": "Gas"
},
{
"ServiceId": "3",
"ServiceName": "Water"
}
]
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"
}
{
"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"
}
Enables the Partners to query the status of submitted applications
[
{
"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
}
]
Enables the Partners to correct an error in any application.
{
"ReferenceCode":"mhb-8SP31540",
"Lead":{
"PrimaryPhone":"0123456789"
},
"Metacomment":"Contacted client. Reachable now."
}
{
"ReferenceCode":"mhb-8SP31540",
"ApplicationStatus":"Partial"
}