Participant APIs | REST

Refresh Cache
Selected Version:
Download Open API Specification

Gets Common Code Tier Type

https://development.api.wealthcare.com/participant/services/tpa/commoncodetier/{tpaId}/{tierTypeKey}/{commonCodeType}

Retrieves the details of a specific Common Code Tier Type based on the provided identifiers, enabling clients to understand the structure and categorization of service tiers.

Request

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.

  • tierTypeKey integer <int32> Required

    Tier Type Key. Unique identifier for the Common Code Tier Type.

  • commonCodeType integer <int32> Required

    Common Code Type. Valid value for ServiceCategory = 1.

Response

  • TpaId string

    Unique identifier that WealthCareAdmin assigns to a TPA.

  • TierTypeKey integer <int32>

    Unique identifier for the Common Code Tier Type.

  • TierTypeId string

    ID of the Common Code Tier Type of the TPA.

  • TierTypeDesc string

    Description of the Common Code Tier Type.

  • CommonCodeType integer <int32>

    Common Code Type. Valid value for ServiceCategory = 1.

  • NumTiers integer <int32>

    Number of service category tiers associated with a service category tier type. Maximum value is 8.

  • InsertDte string <date-time>

    Date when the common code tier type was inserted.

  • UpdateDte string <date-time>

    Date when the common code tier type was updated.

  • InsertUserIdKey integer <int32>

    Unique identifier of the user who inserted the record.

  • UpdateUserIdKey integer <int32>

    Unique identifier of the user who updated the record.

  • UpdateUserFirstName string

    First Name of the user who updated the record.

  • UpdateUserFirstNameSecure string
  • UpdateUserLastName string

    Last Name of the user who updated the record.

  • UpdateUserLastNameSecure string
  • InUse boolean

    Boolean field to indicate if the common code tier type is being used in any of the service categories or not. Valid values are 0 and 1.

  • CommonCodeTiers array <object>

    List of all common code tier types.

    • TpaId string

      Unique identifier that WealthCareAdmin assigns to a TPA.

    • TierKey integer <int32>

      Unique identifier for the Common Code Tier.

    • TierTypeKey integer <int32>

      Unique identifier for the Common Code Tier Type.

    • TierId string

      ID of the Common Code Tier of the TPA.

    • TierDesc string

      Description of the Common Code Tier.

    • InsertDte string <date-time>

      Date when the common code tier was inserted.

    • UpdateDte string <date-time>

      Date when the common code tier was updated.

    • InsertUserIdKey integer <int32>

      Unique identifier of the user who inserted the record.

    • UpdateUserIdKey integer <int32>

      Unique identifier of the user who updated the record.

    • DeleteObject boolean

      Boolen value to indicate if the common code tier can be deleted. Valid values are 0 and 1.

    • IsEditable boolean

      Boolen value to indicate if the common code tier can be edited. Valid values are 0 and 1.

    • InUse boolean

      Boolean field to indicate if the common code tier type is being used in any of the service categories or not. Valid values are 0 and 1.

AI Assistant Preview

Generating response...