Open APIs

Hi,

I'm new to the TM Forum APIs. Is there any sepecification for possible values of the "status" field for a customer?

Best regards,

Fabian

For such details, your source of truth is the "Open API Specification"  (yaml file) from this link Customer Management API TMF629-v5.0

Regards,
Plamen

Hi,

I'm new to the TM Forum APIs. Is there any sepecification for possible values of the "status" field for a customer?

Best regards,

Fabian

That's what I was hoping for, too. Unfortunately, the API specification doesn't provide more guidance
Best regards,

Fabian

For such details, your source of truth is the "Open API Specification"  (yaml file) from this link Customer Management API TMF629-v5.0

Regards,
Plamen

Hi,

I'm new to the TM Forum APIs. Is there any sepecification for possible values of the "status" field for a customer?

Best regards,

Fabian

You should look at the "API Specification", i.e. YAML file, not the "User Guide" - the PDF file.

There you can see:
status:
              $ref: '#/components/schemas/IndividualStateType'
IndividualStateType:
      enum:
        - initialized
        - validated
        - deceased
      type: string
      description: Valid values for the lifecycle state of the individual
(and there are different statuses if it is Organisation)

That's what I was hoping for, too. Unfortunately, the API specification doesn't provide more guidance
Best regards,

Fabian

For such details, your source of truth is the "Open API Specification"  (yaml file) from this link Customer Management API TMF629-v5.0

Regards,
Plamen

Hi,

I'm new to the TM Forum APIs. Is there any sepecification for possible values of the "status" field for a customer?

Best regards,

Fabian

I did. The screenshot was taken from the Swagger UI Editor. 

The example your referring to is for the Individual which is to my knowledge a subclass of Party. I'm looking for information on Customer.status, which is a subclass of PartyRole.

You should look at the "API Specification", i.e. YAML file, not the "User Guide" - the PDF file.

There you can see:
status:
              $ref: '#/components/schemas/IndividualStateType'
IndividualStateType:
      enum:
        - initialized
        - validated
        - deceased
      type: string
      description: Valid values for the lifecycle state of the individual
(and there are different statuses if it is Organisation)

That's what I was hoping for, too. Unfortunately, the API specification doesn't provide more guidance
Best regards,

Fabian

For such details, your source of truth is the "Open API Specification"  (yaml file) from this link Customer Management API TMF629-v5.0

Regards,
Plamen

Hi,

I'm new to the TM Forum APIs. Is there any sepecification for possible values of the "status" field for a customer?

Best regards,

Fabian

Oh, you are right. I did not pay attention.

In case where TMF does not define specific values, it is up to your implementation to define these (based on your needs).

Regards,
Plamen

I did. The screenshot was taken from the Swagger UI Editor. 

The example your referring to is for the Individual which is to my knowledge a subclass of Party. I'm looking for information on Customer.status, which is a subclass of PartyRole.

You should look at the "API Specification", i.e. YAML file, not the "User Guide" - the PDF file.

There you can see:
status:
              $ref: '#/components/schemas/IndividualStateType'
IndividualStateType:
      enum:
        - initialized
        - validated
        - deceased
      type: string
      description: Valid values for the lifecycle state of the individual
(and there are different statuses if it is Organisation)

That's what I was hoping for, too. Unfortunately, the API specification doesn't provide more guidance
Best regards,

Fabian

For such details, your source of truth is the "Open API Specification"  (yaml file) from this link Customer Management API TMF629-v5.0

Regards,
Plamen

Hi,

I'm new to the TM Forum APIs. Is there any sepecification for possible values of the "status" field for a customer?

Best regards,

Fabian