Cedarai Equipment History API

openapi: 3.2.0
info:
  title: ARMS External Equipment History API
  version: 1.0.0
  description: OpenAPI specification generated from external API schemas. Endpoints require query parameter carrierId and headers x-arms-api-key and x-arms-assume-user.
  license:
    name: Proprietary
    url: https://cedarai.com
servers:
- url: https://api-lg.arms.cedarai.com
  description: Production (US)
- url: https://api-lg.arms.cedarai.se
  description: Production (EU)
security:
- ApiKeyAuth: []
  AssumeUser: []
tags:
- name: Equipment History
paths:
  /equipment-history/:
    post:
      summary: List railcar history
      description: Retrieves equipment history records, filterable by equipment, time range, and flags.
      operationId: listEquipmentHistory
      parameters:
      - $ref: '#/components/parameters/CarrierId'
      - $ref: '#/components/parameters/ViewAsUserGroup'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEquipmentHistoryInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEquipmentHistoryOutput'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Equipment History
components:
  schemas:
    Station:
      type: object
      properties:
        fsac:
          type: string
        cityName:
          type: string
        stateOrProvince:
          type: string
        postalCode:
          type: string
        countryCode:
          type: string
        splc:
          type: string
    HazardousInformation:
      type: object
      properties:
        ladingUnitCode: a14d81c2-807b-443c-b776-a08508622fa1
        ladingQuantity:
          type: number
        unIdCode:
          type: string
        unPageNumber:
          type: string
        commodityCode:
          type: string
        unitCode: 0bb40fcf-51c2-4e87-bd9b-74ef671f9ba6
        quantity:
          type: number
        compartmentIdCode:
          type: string
        residueIndicatorCode:
          type: string
        packagingGroupCode:
          type: string
        interimHazmatRegulatoryNumber:
          type: string
        industryCode:
          type: string
        classificationInfo:
          type: array
          items:
            $ref: '#/components/schemas/HazardousClassificationInformation'
        hazmatShippingNameInfo:
          type: array
          items:
            $ref: '#/components/schemas/HazmatShippingNameInformation'
        hazmatAdditionalInfo:
          type: array
          items:
            $ref: '#/components/schemas/HazmatFreeFormInformation'
        epaRequiredData:
          type: array
          items:
            $ref: '#/components/schemas/EPARequiredData'
        canadianDangerousRequirements:
          type: array
          items:
            $ref: '#/components/schemas/CanadianDangerousRequirements'
        transborderHazardousRequirements:
          type: array
          items:
            $ref: '#/components/schemas/TransborderHazardousRequirements'
        hazmatReferenceNumbers:
          type: array
          items:
            $ref: '#/components/schemas/HazmatReferenceNumber'
        administrativeContacts:
          type: array
          items:
            $ref: '#/components/schemas/AdministrativeContact'
        parties:
          type: array
          items:
            $ref: '#/components/schemas/Party'
    EquipmentDetails:
      type: object
      properties:
        equipmentInitial:
          type: string
        equipmentNumber:
          type: integer
        netWeightLbs:
          type: number
        grossWeightLbs:
          type: number
        weightType:
          type: string
          enum:
          - ESTIMATED
          - ACTUAL
        tareWeightLbs:
          type: number
        weightAllowance:
          type: number
        dunnage:
          type: number
        ownershipCode:
          type: string
          enum:
          - L
          - R
          - T
        descriptionCode:
          type: string
        owningCarrierCode:
          type: string
        position:
          type: string
        lengthIn:
          type: number
        tareQualifierCode:
          type: string
          enum:
          - A
          - M
        checkDigit:
          type: integer
        heightIn:
          type: number
        widthIn:
          type: number
        isoContainerCode:
          type: string
        carrierCode:
          type: string
        aarCarType:
          type: string
        sealNumbers:
          type: array
          description: Seal numbers on equipment (X12 M7).
          items:
            type: string
        chassisInitial:
          type: string
        chassisNumber:
          type: integer
        terminals:
          type: array
          items:
            $ref: '#/components/schemas/Terminal'
        interchangeMoveAuthorities:
          type: array
          items:
            $ref: '#/components/schemas/InterchangeMoveAuthority'
        shipmentInfo:
          type: array
          description: Per-equipment Carta Porte data for cross-border waybills. See Cross-border (Mexico) waybills in the API docs.
          items:
            $ref: '#/components/schemas/EquipmentShipmentInformation'
    Grouping:
      type: object
      properties:
        resourceType:
          type: string
          enum:
          - Grouping
        resourceId:
          type: integer
        uuid:
          type: string
          description: UUID that complements the legacy numeric resourceId.
        name:
          type: string
        groupingType:
          type: string
        colorToken:
          type: string
        attributes:
          $ref: '#/components/schemas/AttributesBase'
        rules:
          $ref: '#/components/schemas/GroupingRule'
        equipmentIndexEnabled:
          type: boolean
          enum:
          - false
        deletedAt:
          type: string
        updatedAt:
          type: string
        objectType:
          type: string
          enum:
          - EQUIPMENT
          - CONTAINER
      required:
      - resourceType
      - resourceId
      - groupingType
      - attributes
      - rules
      - equipmentIndexEnabled
      - objectType
    Umler:
      allOf:
      - $ref: '#/components/schemas/UmlerCommon'
    Waybill:
      type: object
      properties:
        loadStatus:
          type: string
        commodityCode:
          type: string
        netWeightTons:
          type: number
        originCityName:
          type: string
        originStateOrProvince:
          type: string
        originFsac:
          type: string
        destinationCityName:
          type: string
        destinationStateOrProvince:
          type: string
        destinationFsac:
          type: string
        consignorCustomerName:
          type: string
        consigneeCustomerName:
          type: string
        originScac:
          type: string
        trafficType:
          type: string
          enum:
          - LOCAL
          - ORIGINATING
          - TERMINATING
          - STORAGE
          - BRIDGE
          - UNKNOWN
        shipmentPaymentMethod:
          type: string
          enum:
          - '11'
          - CC
          - MX
          - NC
          - NR
          - PP
        transportationMethod:
          type: string
          enum:
          - R
          - X
        shipmentId:
          type: string
        weightUnitCode:
          type: string
          enum:
          - E
          - K
          - L
          - S
          - T
        shipmentQualifier:
          type: string
          enum:
          - '1'
          - '6'
          - '7'
          - '8'
          - B
          - C
          - E
          - F
          - G
          - H
          - I
          - M
          - N
          - S
          - W
          - X
        capacityLoadCode:
          type: string
          enum:
          - C
          - F
          - G
          - M
          - V
        customsDocumentationHandlingCode:
          type: string
        confidentialBillingRequestCode:
          type: string
          enum:
          - C
          - M
          - N
          - R
        taxReasonCode:
          type: string
        shipmentWeightCode:
          type: string
          enum:
          - A3
          - B
          - C
          - E
          - G
          - J
          - K
          - M
          - N
          - O
          - S
          - X
        referencedPatternIdentifier:
          type: string
        billingCode:
          type: string
          enum:
          - A
          - D
          - E
          - G
          - H
          - M
          - P
          - S
          - U
          - V
          - W
          - X
          - Y
        repetitivePatternNumber:
          type: integer
        extendedReferenceInfo:
          type: array
          items:
            $ref: '#/components/schemas/ExtendedReferenceInformation'
        crossReferenceEquipment:
          type: array
          items:
            $ref: '#/components/schemas/CrossReferenceEquipment'
        equipmentDetails:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentDetails'
        intermodalStatusDetails:
          $ref: '#/components/schemas/IntermodalStatusDetails'
        specialHandlingCodes:
          type: array
          items:
            type: string
        protectiveService:
          type: array
          items:
            $ref: '#/components/schemas/ProtectiveService'
        originStation:
          $ref: '#/components/schemas/Station'
        originJunction:
          $ref: '#/components/schemas/Station'
        destinationStation:
          $ref: '#/components/schemas/Station'
        destinationJunction:
          $ref: '#/components/schemas/Station'
        parties:
          type: array
          items:
            $ref: '#/components/schemas/Party'
        route:
          type: array
          items:
            $ref: '#/components/schemas/RouteEntry'
        emptyCarDispositions:
          type: array
          items:
            $ref: '#/components/schemas/EmptyCarDisposition'
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
        hazardousInfo:
          type: array
          items:
            $ref: '#/components/schemas/HazardousInformation'
        hazardousCertifications:
          type: array
          items:
            $ref: '#/components/schemas/HazardousCertification'
        release:
          $ref: '#/components/schemas/Release'
        defaultReceiver:
          type: string
        waybillTemplateId:
          type: integer
        waybillTemplateName:
          type: string
        waybillNumberSuffix:
          type: string
        originCarrierCode:
          type: string
        consigneeLocationId:
          type: integer
        shipperLocationId:
          type: integer
        inCareOfLocationId:
          type: integer
        freightBillPartyLocationId:
          type: integer
        pickupPartyLocationId:
          type: integer
        waybillNumber:
          type: integer
        waybillDate:
          type: string
        billOfLadingNumber:
          type: string
        originSystem:
          type: string
          enum:
          - ARMS
          - EDI
          - BRAVO
        preparationDate:
          type: string
        preparationTime:
          type: string
        revisionNumber:
          type: integer
        revisionTime:
          type: string
        revisionSourceType:
          type: string
          enum:
          - WAYBILL
          - CONSIST
          - BILL_OF_LADING
          - ADVANCE_CAR_DISPOSITION
          - LOAD
          - EMPTY
          - REBILL
          - CLM
        armsTrackingId:
          type: string
        resourceType:
          type: string
          enum:
          - Waybill
        resourceId:
          type: integer
        uuid:
          type: string
          description: UUID that complements the legacy numeric resourceId.
        waybillStatus:
          type: string
          enum:
          - PENDING
          - ACTIVE
          - ARCHIVED
        createdAt:
          type: string
    Terminal:
      type: object
      description: Port or terminal location on equipment (X12 R4).
      properties:
        terminalFunctionCode:
          type: string
          enum:
          - '1'
          - '5'
          - '6'
          - '7'
          - D
          - E
          - I
          - L
          - M
          - P
          - R
        locationQualifier:
          type: string
          enum:
          - CS
          - D
          - K
          - OL
          - SL
          - UN
          - ZZ
        locationIdentifier:
          type: string
        portName:
          type: string
    HistoryMoveType:
      type: string
      enum:
      - ABNO
      - AEIE
      - AEIN
      - AEIS
      - AEIW
      - AETA
      - AETI
      - AINV
      - ARIL
      - ARRI
      - BADO
      - BFRM
      - BHVY
      - BLGT
      - BOHR
      - BXNG
      - CGIP
      - CGRD
      - CH80
      - CH81
      - CH82
      - CH83
      - CH84
      - CH85
      - CH86
      - CH89
      - CHARGED
      - CHERRYPICK
      - CPRL
      - DELIVERED
      - DFLC
      - DIGOUTS
      - DIVERT
      - DRMP
      - ECYC
      - EMPTIED
      - EQOR
      - FFBO
      - FLIP
      - FTBO
      - HADR
      - HAND
      - HANR
      - HEMB
      - HEATSTRT
      - HEATSTP
      - HHAR
      - HIGT
      - HMIS
      - HOGT
      - HUMP
      - ICHD
      - ICHR
      - IGTI
      - IGTR
      - INTERPLANT
      - INTRAPLANT
      - LCOM
      - LDCH
      - LOADED
      - LTFR
      - LTTO
      - MAWY
      - MOTR
      - MOVE
      - NOBL
      - NOTP
      - OFFERED
      - OGTI
      - OGTR
      - ORDER
      - OSTH
      - PACT
      - PASL
      - PCON
      - PFLT
      - PFPS
      - PKGD
      - PKGR
      - PLJI
      - PLLF
      - PLLT
      - PUJI
      - RAMP
      - RECEIVED
      - RECONSIGN
      - REBL
      - REJS
      - REMB
      - RFLT
      - RICD
      - RLOD
      - RMTY
      - RRFS
      - RTAA
      - RTOI
      - RTPO
      - SCYC
      - SETBACK
      - SPARGSTRT
      - SPARGSTP
      - SPECIALSWITCH
      - STEA
      - STEX
      - STOP
      - STPD
      - STPE
      - STPL
      - STRD
      - STRE
      - STRT
      - STSE
      - STSU
      - STUN
      - SWAP
      - TRIM
      - TSET
      - TURN
      - ULCH
      - UNKN
      - UNSC
      - WAYB
      - WEIGH
      - WEIGHE
      - WEIGHL
    WagonDamage:
      type: object
      properties:
        reportId:
          type: string
          description: Report identifier for the damage.
        damageStatus:
          type: integer
          description: Status code for the damage.
        damageCode:
          type: string
          description: Damage code.
        damageDescription:
          type: string
          description: Description of the damage.
        damageIsNew:
          type: boolean
          description: Whether the damage is new.
        eventTimestamp:
          type: string
          format: date-time
          description: Timestamp of the damage event.
    LineItemDescription:
      type: object
      properties:
        ladingDescription:
          type: string
        commodityCode:
          type: string
        commodityCodeQualifier:
          type: string
          enum:
          - '3'
          - J
          - L
          - T
        packagingCode:
          type: string
        marksAndNumbers:
          type: string
        marksAndNumbersQualifier:
          type: string
        hazmatRatingCommodityCodeQualifier:
          type: string
        hazmatRatingCommodityCode:
          type: string
        compartmentIdCode:
          type: string
    HazmatReferenceNumber:
      type: object
      properties:
        referenceIdQualifier:
          type: string
        referenceId:
          type: string
        date:
          type: string
    BillingInformation:
      type: object
      properties:
        rebillReasonCode:
          type: string
          enum:
          - RC
          - RD
        origin:
          $ref: '#/components/schemas/Station'
        destination:
          $ref: '#/components/schemas/Station'
        carrierCodes:
          type: array
          items:
            type: string
    WaybillSearchFilterCore:
      type: object
      properties:
        initialAndNumber:
          type: string
        billedEquipmentNumbers:
          type: array
          items:
            type: string
        shipper:
          type: string
        consignee:
          type: string
        originStation:
          type: string
        destinationStation:
          type: string
        waybillNumber:
          type: integer
        waybillDate:
          type: string
          format: date
    ListEquipmentHistoryInput:
      type: object
      properties:
        pageSize:
          type: integer
          title: Page Size
        pageNextToken:
          type: string
          title: Page Next Token
        pagePrevToken:
          type: string
          title: Page Prev Token
        carrierId:
          type: integer
          title: Carrier Id
        waybillFilter:
          $ref: '#/components/schemas/WaybillSearchFilterCore'
        groupingFilters:
          type: array
          items:
            $ref: '#/components/schemas/HistoryGroupingNameFilter'
          title: Grouping Filters
        initialAndNumber:
          type: string
          title: Initial And Number
        exactMatchEquipmentInitialAndNumber:
          type: boolean
          title: Exact Match Equipment Initial And Number
        equipmentIds:
          type: array
          items:
            type: integer
          title: Equipment Ids
        moveTypes:
          type: array
          items:
            $ref: '#/components/schemas/HistoryMoveType'
        showDeletion:
          type: boolean
          title: Show Deletion
          default: true
        showRejection:
          type: boolean
          title: Show Rejection
          default: true
        showMuted:
          type: boolean
          title: Show Muted
        showOnlyValidatedMoveTypes:
          type: boolean
          title: Show Only Validated Move Types
        timestampBefore:
          type: string
          format: date-time
          title: Timestamp Before
        timestampAfter:
          type: string
          format: date-time
          title: Timestamp After
        revisionedSince:
          type: string
          format: date-time
          title: Revisioned Since
      required:
      - carrierId
    UmlerCommon:
      type: object
      description: Shared UMLER attributes for equipment records.
      additionalProperties: false
      properties:
        equipmentInitial:
          type: string
        equipmentNumber:
          type: integer
        car:
          type: string
        mechanicalDesignation:
          type: string
        owner:
          type: string
        elementEquipmentGroup:
          type: string
        lessee:
          type: string
        markOwnerCategory:
          type: string
        outsideLength:
          type: number
          description: Outside length in inches
        outsideLengthFt:
          type: number
          description: Outside length in feet (standardized)
        isIntl:
          type: boolean
          description: Whether this is international equipment
        grossRailWeight:
          type: number
        grossRailWeightUnit:
          type: string
          description: Unit of measure for gross rail weight
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        grossRailWeightLb:
          type: number
          description: Gross rail weight in pounds (standardized)
        loadLimit:
          type: number
        cubicFeetCapacity:
          type: number
        tareWeight:
          type: number
          description: Tare weight in pounds
        tareWeightUnit:
          type: string
          description: Unit of measure for tare weight
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        tareWeightLb:
          type: number
          description: Tare weight in pounds (standardized)
        plateCode:
          type: string
        insideLength:
          type: number
        insideLengthUnit:
          type: string
          description: Unit of measure for inside length
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        insideLengthFt:
          type: number
          description: Inside length in feet (standardized)
        insideHeight:
          type: number
        insideHeightUnit:
          type: string
          description: Unit of measure for inside height
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        insideHeightFt:
          type: number
          description: Inside height in feet (standardized)
        outsideExtremeWidth:
          type: number
        outsideExtremeWidthUnit:
          type: string
          description: Unit of measure for outside extreme width
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        outsideExtremeWidthFt:
          type: number
          description: Outside extreme width in feet (standardized)
        outerExtremeHeight:
          type: number
        outerExtremeHeightUnit:
          type: string
          description: Unit of measure for outer extreme height
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        outerExtremeHeightFt:
          type: number
          description: Outer extreme height in feet (standardized)
        outsideHeightExtremeWidth:
          type: number
        outsideHeightExtremeWidthUnit:
          type: string
          description: Unit of measure for outside height extreme width
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        outsideHeightExtremeWidthFt:
          type: number
          description: Outside height at extreme width in feet (standardized)
        sideDoorType:
          type: string
        sideDoorHeight:
          type: number
        sideDoorHeightUnit:
          type: string
          description: Unit of measure for side door height
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        sideDoorHeightFt:
          type: number
          description: Side door height in feet (standardized)
        sideDoorWidth:
          type: number
        sideDoorWidthUnit:
          type: string
          description: Unit of measure for side door width
          enum:
          - IN
          - LB
          - CM
          - KG
          - FT
          - M
          - G
          - T
          - MT
        sideDoorWidthFt:
          type: number
          description: Side door width in feet (standardized)
        boxSideDoorOrientation:
          type: string
        axleCount:
          type: integer
        brakeShoeType:
          type: string
        bodyMaterial:
          type: string
        operatingBrakes:
          type: number
        floorStrengthClassification:
          type: string
        poolNumber:
          type: string
        endOfTrainOnly:
          type: string
        shoveCarToRest:
          type: string
        shoveAdjCarToRest:
          type: string
        trainPositionSensitive:
          type: string
        couplerStyle:
          type: string
        unitEquipmentGroup:
          type: string
        abtDueDate:
          type: string
        carGrade:
          type: string
        lengthFt:
          type: number
          description: Length in feet (standardized, EU-specific)
        brakeWeightLb:
          type: number
          description: Brake weight in pounds (standardized)
        netWeightLb:
          type: number
          description: Net weight in pounds (standardized)
        allowedSpeed:
          type: string
          description: Allowed speed when taking commodity into account
        regionCode:
          type: string
          description: Source region code (US or SE)
        vkm:
          type: string
          description: Vehicle keeper code (KEEPER section)
        vkmValidTo:
          type: string
          format: date
          description: Keeper validity date (KEEPER section, ISO string)
        resp:
          type: string
          description: Responsible entity code (RESPONSIBLE section)
        responsibleValidTo:
          type: string
          format: date
          description: Responsible entity validity date (RESPONSIBLE section, ISO string)
        damages:
          type: array
          items:
            $ref: '#/components/schemas/WagonDamage'
          description: List of damage objects associated with the equipment.
    HazardousCertification:
      type: object
      properties:
        name:
          type: string
    HazmatShippingNameInformation:
      type: object
      properties:
        hazmatShippingName:
          type: string
        hazmatShippingNameQualifier:
          type: string
          enum:
          - C
          - D
          - I
        nosIndicatorCode:
          type: string
        railSafetySensitiveMaterial:
          type: boolean
    IntermodalUnitResource:
      type: object
      properties:
        resourceType:
          type: string
          enum:
          - IntermodalUnit
        resourceId:
          type: integer
        uuid:
          type: string
          description: UUID that complements the legacy numeric resourceId.
    Equipment:
      type: object
      properties:
        resourceType:
          type: string
          enum:
          - Equipment
        resourceId:
          type: integer
        uuid:
          type: string
          description: UUID that complements the legacy numeric resourceId.
        equipmentInitial:
          type: string
        equipmentNumber:
          type: integer
        aarCarType:
          type: string
        equipmentType:
          type: string
          enum:
          - CAR
          - LOCOMOTIVE
          - CABOOSE
          - TRAIN_DEVICE
        descriptionCode:
          type: string
        arrivalState:
          type: string
          enum:
          - INBOUND
          - ONLINE
          - OUTBOUND
        parentGroupings:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentParentGrouping'
        waybill:
          $ref: '#/components/schemas/Waybill'
        umler:
          $ref: '#/components/schemas/UmlerCommon'
        notes:
          type: string
        intermodalUnits:
          type: array
          items:
            $ref: '#/components/schemas/IntermodalUnitResource'
        loadStatus:
          type: string
          enum:
          - LOAD
          - EMPTY
          - UNKNOWN
        ichrTime:
          type: string
          format: date-time
        workOrder:
          $ref: '#/components/schemas/WorkOrderResource'
        workOrders:
          type: array
          items:
            $ref: '#/components/schemas/WorkOrderResource'
    ExtendedReferenceInformation:
      type: object
      description: Extended reference information from the waybill. Production notes are entries where referenceIdQualifier is "ZZ" and description is "TrpNotes"; the note text is in referenceId.
      properties:
        referenceIdQualifier:
          type: string
          description: Reference identification qualifier (e.g. "ZZ" for mutually defined references).
        referenceId:
          type: string
          description: Reference value. For production notes (ZZ/TrpNotes), this contains the note text.
        description:
          type: string
          description: Description of the reference (e.g. "TrpNotes" for production notes).
        date:
          type: string
        timestamp:
          type: string
    ListEquipmentHistoryOutput:
      type: object
      properties:
        nextToken:
          type: string
          title: Next Token
        prevToken:
          type: string
          title: Prev Token
        items:
          type: array
          items:
            $ref: '#/components/schemas/EquipmentHistoryItem'
          title: Items
      required:
      - items
    InterchangeMoveAuthority:
      type: object
      description: Interchange move authority on equipment (X12 IMA).
      properties:
        movementAuthorityCode:
          type: string
          enum:
          - A
          - B
          - C
          - D
          - DS
          - E
          - G
          - HM
          - I
          - L
          - N
          - NC
          - NU
          - O
          - OA
          - OS
          - P
          - R
          - RB
          - S
          - W
          - X
        carrierCode:
          type: string
        terminalTariffApplicationCode:
          type: string
          enum:
          - D
          - E
          - F
        stateTariffApplicationCode:
          type: string
          enum:
          - N
          - S
        rejectReasonCode:
          type: string
          enum:
          - AD
          - BA
          - BC
          - BD
          - BG
          - BL
          - BO
          - BV
          - BW
          - CN
          - CR
          - CW
          - DD
          - DR
          - DS
          - DV
          - ER
          - FD
          - FR
          - HB
          - HH
          - HX
          - LK
          - OG
          - OV
          - RF
          - RH
          - SU
          - ZZ
    Party:
      type: object
      properties:
        partyType:
          type: string
          enum:
          - '11'
          - AO
          - AP
          - AQ
          - BN
          - BT
          - C1
          - CB
          - CD
          - CE
          - CH
          - CN
          - CV
          - DH
          - DM
          - FW
          - HW
          - HX
          - HZ
          - IM
          - MC
          - N1
          - OH
          - OM
          - PF
          - PU
          - PV
          - RP
          - SF
          - SH
          - SS
          - ST
          - SU
          - TR
          - UC
          - XB
          - XQ
          - XR
          - XU
          - ZS
        name:
          type: string
        idCodeQualifier:
          type: string
          enum:
          - '1'
          - '2'
          - '9'
          - '12'
          - '17'
          - '20'
          - AB
          - AI
          - BF
          - BN
          - C5
          - FI
          - IN
          - M5
          - '93'
        idCode:
          type: string
        entitySubIdentifierRelationshipCode:
          type: string
        entitySubIdentifierCode:
          type: string
        additionalNames:
          type: array
          items:
            type: string
        address:
          type: array
          items:
            type: string
        cityName:
          type: string
        stateOrProvince:
          type: string
        postalCode:
          type: string
        countryCode:
          type: string
        locationQualifier:
          type: string
        locationIdentifier:
          type: string
        countrySubdivisionCode:
          type: string
        administrativeContacts:
          type: array
          items:
            $ref: '#/components/schemas/AdministrativeContact'
        billingInfo:
          type: array
          items:
            $ref: '#/components/

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cedarai/refs/heads/main/openapi/cedarai-equipment-history-api-openapi.yml