FAQ
How can I be notified when there are changes to the APIs?
We constantly update the API in terms of bug fixes and new functionality. All changes are documented in the Release Notes. In addition, when there is a breaking change due to be released, we will inform you in advance.
Where can I find the The Web Application Description Language (WADL)?
The Web Application Description Language is available here
Do you have a beta API that I can use for testing?
Yes, a beta API is available for you to test your integration. Please request this from your account manager who would be able to configure an account for you.
Why don't I see all the data for the entity I requested?
Depending on your permissions, some records may not be visible for a given entity. Please check your permissions if that is the case.
What are the supported programming languages?
You can use any programming language to call API methods, there are some Samples available for frequently used programming languages.
Do I have to authenticate every request?
There are two ways to authenticate yourself to consume the API. One of them allows you to use a token to authenticate. Read more about Authentication.
I get a 404 when trying to access the API. Where am I wrong?
Probably you are calling a non-existing method. Check the reference page to see all available methods
I get a 409 when trying to access the API. Where am I wrong?
Probably you are trying to insert a conflicted value. Do a Get request first to see existing values. A detailed error message should be provided with the response in this case.
Do you support paging in responses with large amount of records?
Some get methods like contracts, site/{id}/cli and site/{id}/servicecharge, could potentially return a large number of records. For these methods, extra parameters for paging, searching and sort direction can be provided with the request. For more information, please refer to the documentation for the method in question.
I want to update a field, should I use PUT or PATCH method?
PUT and PATCH both methods behave exactly same. The API will only update the fields you have passed in. Other fields will not be touched unless there are specific business rules involved.
Salesforce does not support PATCH, so for all updates we're limited to PUT?
In this case, please use PUT method, it will behave as same as the PATCH