Investigate if BIP has endpoint for special issue codes

[dfitchett]

Summary

Investigate whether or not the BIP api has the capability of returning special issue codes, and if so, does it include information about the deactivation date.

Acceptance Criteria

• [x] document findings in this ticket
• [x] create follow-on tickets if necessary for further investigation, VRO support, and/or implementation

  • 3213

  • 3048

Findings

Summary

The BIP Claims API has an endpoint to get special issue codes. The GET endpoint is /contentions/special_issue_codes and returns an array of codeNamePairs with the schema below:

"CodeNamePairsResponse" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/ProviderResponse"
        }, {
          "$ref" : "#/components/schemas/CodeNamePairsResponse_allOf"
        } ],
        "title" : "CodeNamePairsResponse"
      },
      "CodeNamePair" : {
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "code" : {
            "type" : "string"
          },
          "description" : {
            "type" : "string"
          },
          "deactiveDate" : {
            "description" : "Date indicating when this item is deactivated and is no longer valid, or an empty value.",
            "format" : "date-time",
            "type" : "string"
          }
        },
        "required" : [ "code", "deactiveDate", "name" ],
        "title" : "CodeNamePair",
        "type" : "object"
      },

name, code, and deactiveDate are required, however deactiveDate is the date-time indicating when this item is deactivated and is no longer valid, or an empty value.

Follow-Ons

• svc-bip-api needs to be updated to add the contentions/special_issue_codes GET endpoint
• mock-bip-claims-api needs to be updated to add acceptable responses
  • one request gets an active special issue code, and another a deactivated special issue code
• svc-bip-api needs to be updated to add a corresponding RabbitMQ configuration for the REST endpoint
  • this information shouldn't need to be fetched often, this is a great place for caching
  • multiple useful queues could be created
    1. returning the entire list of special issue codes,
    2. request contains array of codes to lookup, and response returns if they are all active