TM Forum Community

 View Only
Expand all | Collapse all

In TMF-641 CREATE cancelServiceOrder API Swagger for 201(Success) case 'errorMessage' property is present in response payload. What does this errorMessage represents in success (201) case?

  • 1.  In TMF-641 CREATE cancelServiceOrder API Swagger for 201(Success) case 'errorMessage' property is present in response payload. What does this errorMessage represents in success (201) case?

    Posted May 09, 2022 05:23
    PFA Screenshot of Swagger for CREATE cancelServiceOrder API. for this API in response payload "errorMessage" property is present for 201 case. Can someone provide me details of what this property represents and what should be its value in case of 201 status code.


    #General

    ------------------------------
    Varad Kotgire
    Zensar Technologies Ltd.
    ------------------------------


  • 2.  RE: In TMF-641 CREATE cancelServiceOrder API Swagger for 201(Success) case 'errorMessage' property is present in response payload. What does this errorMessage represents in success (201) case?

    TM Forum Member
    Posted May 09, 2022 07:18
    Hi Varad
    It looks as if no business example was supplied for this operation, in this case the tooling that we use generates a sample payload directly from the schema, without any business meaning.
    In general, the ErrorMessage sub-entity was added to Service Order entities to allow recording and communication of error situations that can arise during order processing.
    Specifically for the Cancel Service Order task entity, I think it unlikely that the canceling task would be created (201) with a known error condition. But it is entirely possible that after the task is created, it might be discovered that the service order cannot be canceled (e.g. past point of no return), in which case the error message would be populated.
    Hope it helps

    ------------------------------
    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.
    ------------------------------