Design guidelines for v5 are not published yet, they are a work in progress.
I believe that when they are published it will be under a different number, TMF763.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------
Original Message:
Sent: Feb 08, 2024 00:16
From: Ajay Saini
Subject: 404 or 204 or 200 with empty response
@Jonathan Goldberg I could not find V5 of this -> (TMF630 Part 1 section 4). Can you please help me for link of V5- TMF 630.
------------------------------
Ajay Saini
Bharti Airtel Ltd
Original Message:
Sent: Feb 07, 2024 07:47
From: Jonathan Goldberg
Subject: 404 or 204 or 200 with empty response
I'm not sure that v4 design guideline document is still being maintained. To best of my knowledge it's correct in v5, but I'll try to verify that.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Feb 07, 2024 04:40
From: Ajay Saini
Subject: 404 or 204 or 200 with empty response
@Jonathan Goldberg I see that this is still not updated in the design guidelines regarding 200 for no matching result. Can you please give update on this?
------------------------------
Ajay Saini
Bharti Airtel Ltd
Original Message:
Sent: Apr 14, 2021 05:22
From: Jonathan Goldberg
Subject: 404 or 204 or 200 with empty response
We've taken it internally in the Open API team, with intent to update the design guidelines to ensure that any ambiguity is removed. It is looking like we'll go for what Vance stated here (200 for no matching result), but let's wait until the update is made and approved.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Apr 09, 2021 01:09
From: Vance Shipley
Subject: 404 or 204 or 200 with empty response
On Apr 08, 2021 06:32 @Sravya A wrote:
> When an URI does not have any results satisfying the specified filters, what should be the response?
Yes, the first case is a retrieval of an item, identified by id, in the adjustBalance Collection, if it doesn't exist 404 is the correct response.
The rest of the examples are queries on the adjustBalance Collection. If the client provided a query with incorrect syntax expect a 400 response. If the server experiences an internal error expect a 500 response. Otherwise the query is "successful" and the success result body is an array of items in the Collection matching the query filters. If no items match expect an empty array ("[]") in the body with a 200 OK response.
------------------------------
Vance Shipley
SigScale
Original Message:
Sent: Apr 08, 2021 06:32
From: Sravya A
Subject: 404 or 204 or 200 with empty response
Hi all,
When an URI does not have any results satisfying the specified filters, what should be the response? For example what should be the response of the below URIs
1. prepayBalanceManagement/v4/adjustBalance/invalidID
2. prepayBalanceManagement/v4/adjustBalance?id=invalidID
3. prepayBalanceManagement/v4/adjustBalance?id=valid&partyAccount.id=invalidID
4. prepayBalanceManagement/v4/adjustBalance?partyAccount.id=invalidID (For ex, no adjustBalance created on the account given)
For the first case, spec clearly mentions that 404 would be the appropriate response.
However, I wanted to confirm for other cases as well since I did not find any explicit mention of the expectation and this would impact all our implementations.
Thanks in advance,
Sravya
------------------------------
Sravya A
Oracle Corporation
------------------------------