Updated API response header's index case.

Posts about the simPRO API. Help/support/how-to etc.
Forum rules
  • Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
  • No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
  • Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
  • Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
  • Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
  • Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
  • Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
  • Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
Post Reply
demo
Posts: 17
Joined: Sat May 14, 2022 12:24 pm

Updated API response header's index case.

Post by demo » Thu Dec 29, 2022 4:30 am

Hello Simpro,
I am using API for getting the data of All Jobs. For all jobs, first I get jobs headers, I am getting 'Result-Pages', 'Result-Total', and 'Result-Count' then we execute it according to the 'Result-Pages' and I was getting all jobs according to the page and pageSize. But now I am getting 'result-pages', 'result-total', and 'result-count'. So what's the specific reason for changing the case of the index? If there is any particular reason for the change so please let me know about it. So I also changed it where I am using it.

I was using the index's name according to this doc:
https://developer.simprogroup.com/apido ... Pagination

And now I am getting this index's name, I have attached a screenshot of the postman.

Thank You
Attachments
Index_Issue.png
Index_Issue.png (62.59 KiB) Viewed 8251 times
robbertcha
Posts: 416
Joined: Thu Apr 15, 2021 10:07 pm

Re: Updated API response header's index case.

Post by robbertcha » Mon Jan 02, 2023 10:47 pm

Hi,

Thanks for your information, I will go and check the case sensitive for the response header parameters as we didn't update this part for long time, so please use 'result-pages', 'result-total', and 'result-count' first, thank you.
Robbert
API Developer | simPRO Software Group
robbertcha
Posts: 416
Joined: Thu Apr 15, 2021 10:07 pm

Re: Updated API response header's index case.

Post by robbertcha » Fri Jan 06, 2023 1:45 am

Hi,

The parameters on the header response are always converted by our API framework into lowercase due to consistency and ease of use, we will update this on the API documentation and so sorry to confuse you.
Robbert
API Developer | simPRO Software Group
giggida
Posts: 8
Joined: Thu Jun 02, 2022 4:57 pm

Re: Updated API response header's index case.

Post by giggida » Wed Jun 21, 2023 11:34 pm

It appears something has changed almost two weeks ago that broke our API. The headers are now in upper and lower case, yet in this post it clearly states API framework is always in lowercase for consistency.

User DEMO herein did all the API work for us and now claims this is the reason it no longer works.

We need this addressed immediately as none of our customers are receiving their communications.

Please advise ASAP. Thanks!
Attachments
image (7).png
image (7).png (229.02 KiB) Viewed 7970 times
Sindre
Posts: 493
Joined: Wed Apr 20, 2022 4:51 am
Location: Brisbane

Re: Updated API response header's index case.

Post by Sindre » Thu Jun 22, 2023 12:52 am

Hi Giggida,
I haven't seen any changes in this and when testing my Postman get the response headers in lower case as expected.

I'm unfamiliar with the endpoint you are posting to. Can you try to GET or POST data to one of our regular endpoints such as

Code: Select all

/api/v1.0/companies/{companyID}/jobs/
and see what headers you get in return.

Also check the return header tab in your attached image.

Regard
Sindre
Sindre
API Developer | Simpro Software Group
Post Reply