Data Import REST API Changelog

{
    "x-enum-descriptions": {
        "FreedomFibre": "FreedomFibre",
        "CommunityFibre": "CommunityFibre"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "FreedomFibre": "FreedomFibre",
        "CommunityFibre": "CommunityFibre"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "FreedomFibre": "FreedomFibre",
        "CommunityFibre": "CommunityFibre"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "FreedomFibre": "FreedomFibre",
        "CommunityFibre": "CommunityFibre"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "CLI": "CLI"
    }
}

{
    "x-enum-descriptions": {
        "PHONE_NUMBER": "PHONE_NUMBER"
    }
}

{
    "x-enum-descriptions": {
        "NUMBER_PORTING_FAILED": "NUMBER_PORTING_FAILED"
    }
}

{
    "x-enum-descriptions": {}
}

[
    {
        "name": "Validate that the product fields are valid for the product type as some fields are product type specific.",
        "description": "Validates that the product fields are valid for the product type as some fields are product type specific.",
        "possible_errors": [
            "product_field_invalid_for_type",
            "product_is_misconfigured",
            "required"
        ]
    },
    {
        "name": "Validate that equipment orders are provided for Set-top Box (TV) products.",
        "description": "Validates that the equipment_orders field is provided when the product type is Set-top Box (STB/TV), as equipment order details are required for TV product imports.",
        "possible_errors": [
            "required"
        ]
    },
    {
        "name": "Validate that the characteristic codes of the selected characteristic values are valid for the catalog product.",
        "description": "Validates that the characteristic codes of the selected characteristic values are valid for the catalog product.",
        "possible_errors": [
            "selected_characteristic_value_invalid_characteristic_code_for_product"
        ]
    },
    {
        "name": "Validate that the value is valid for the characteristic's value options.",
        "description": "Validates that the value is valid for the characteristic's value options.",
        "possible_errors": [
            "selected_characteristic_value_invalid_for_value_options"
        ]
    },
    {
        "name": "Validates that the broadband product contains the mandatory fields required for the specified network provider.",
        "description": "Validates that the broadband product contains the mandatory fields required for the specified network provider (e.g. ont port and reference for Openreach).",
        "possible_errors": [
            "missing_fields_for_network_provider"
        ]
    }
]

[
    {
        "name": "Validate that the product fields are valid for the product type as some fields are product type specific.",
        "description": "Validates that the product fields are valid for the product type as some fields are product type specific.",
        "possible_errors": [
            "product_field_invalid_for_type",
            "product_is_misconfigured",
            "required"
        ]
    },
    {
        "name": "Validate that the characteristic codes of the selected characteristic values are valid for the catalog product.",
        "description": "Validates that the characteristic codes of the selected characteristic values are valid for the catalog product.",
        "possible_errors": [
            "selected_characteristic_value_invalid_characteristic_code_for_product"
        ]
    },
    {
        "name": "Validate that the value is valid for the characteristic's value options.",
        "description": "Validates that the value is valid for the characteristic's value options.",
        "possible_errors": [
            "selected_characteristic_value_invalid_for_value_options"
        ]
    },
    {
        "name": "Validates that the broadband product contains the mandatory fields required for the specified network provider.",
        "description": "Validates that the broadband product contains the mandatory fields required for the specified network provider (e.g. ont port and reference for Openreach).",
        "possible_errors": [
            "missing_fields_for_network_provider"
        ]
    }
]

{
    "x-enum-descriptions": {
        "CUSTOM": "Custom"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "CUSTOM": "Custom"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "VoIP Bolton Boost": "VoIP Bolton Boost",
        "VoIP Bolton Paid Feature": "VoIP Bolton Paid Feature"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "VoIP Bolton Boost": "VoIP Bolton Boost",
        "VoIP Bolton Paid Feature": "VoIP Bolton Paid Feature"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "items": {
        "x-enum-descriptions": {
            "VoIP Bolton Boost": "VoIP Bolton Boost",
            "VoIP Bolton Paid Feature": "VoIP Bolton Paid Feature"
        }
    }
}

{
    "items": {
        "x-enum-descriptions": {}
    }
}

{
    "x-enum-descriptions": {
        "TELEPHONE_NUMBER": "TELEPHONE_NUMBER"
    }
}

{
    "x-enum-descriptions": {
        "EXISTING_TELEPHONE_NUMBER": "EXISTING_TELEPHONE_NUMBER",
        "REQUESTED_TELEPHONE_NUMBER": "REQUESTED_TELEPHONE_NUMBER"
    }
}

{
    "enum": [
        "Partial"
    ],
    "x-spec-enum-id": "84495b471b836dd1",
    "x-enum-descriptions": {
        "Partial": "Partial"
    }
}

{
    "enum": [
        "Disabled",
        "Basic",
        "Advanced"
    ],
    "x-spec-enum-id": "d637e353a50f2632",
    "x-enum-descriptions": {
        "Basic": "Basic",
        "Advanced": "Advanced",
        "Disabled": "Disabled"
    }
}

{
    "x-enum-descriptions": {
        "CEASE": "Cease",
        "LEAKAGE": "Leakage",
        "REGRADE": "Regrade",
        "RENEWAL": "Renewal",
        "SUSPEND": "Suspend",
        "ROLLOVER": "Rollover",
        "UNSUSPEND": "Unsuspend",
        "SPEED_CHANGE": "Speed Change",
        "CHANGE_OPTIONS": "Change Options",
        "CHANGE_CONTRACT": "Change Contract",
        "CHANGE_CONFIGURATION": "Change Configuration",
        "EQUIPMENT_REPLACEMENT": "Equipment Replacement",
        "EQUIPMENT RETURNS BAG ORDER": "Equipment Returns Bag Order",
        "EQUIPMENT_RETURNS_BAG_REORDER": "Equipment Returns Bag Reorder"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "BEREAVEMENT": "BEREAVEMENT",
        "GOODWILL_CREDIT_BALANCE": "GOODWILL_CREDIT_BALANCE"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "MARKETING.CONTACT_BY_PUSH": "User chooses to be contacted by push as a marketing preference."
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "MARKETING.CONTACT_BY_PUSH": "User chooses to be contacted by push as a marketing preference."
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "ADD_ADDON": "Add Addon"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "REMOVE_ADDON": "Remove Addon"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "VoIP Bolton": "VoIP Bolton"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "VoIP Bolton": "VoIP Bolton"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "items": {
        "x-enum-descriptions": {
            "VoIP Bolton": "VoIP Bolton"
        }
    }
}

{
    "items": {
        "x-enum-descriptions": {}
    }
}

{
    "x-enum-descriptions": {
        "CPWN_REFERENCE": "CPWN_REFERENCE"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "CHANGE_CONFIGURATION": "Change Configuration"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "exc_coll": "Exc Collections - Do not use"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "Exc Collections - Do not use": "Exc Collections - Do not use"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-validators": [
        {
            "name": "Validate <code>organisation_number</code>",
            "description": "Validate that the given <code>organisation_number</code> has a corresponding organisation registered in the database.",
            "possible_errors": [
                "partner_organisation_does_not_exist"
            ]
        }
    ]
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "TalkTalk Android TV": "TalkTalk Android TV"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "TalkTalk Android TV": "TalkTalk Android TV"
    }
}

{
    "items": {
        "x-enum-descriptions": {}
    }
}

{
    "items": {
        "x-enum-descriptions": {
            "TalkTalk Android TV": "TalkTalk Android TV"
        }
    }
}

{
    "pattern": "^-?\\d{0,7}(?:\\.\\d{0,4})?$"
}

{
    "pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$"
}

{
    "x-enum-descriptions": {
        "DIRECTORY_ENTRY_TYPE": "DIRECTORY_ENTRY_TYPE",
        "DIRECTORY_ENTRY_LINE_USE": "DIRECTORY_ENTRY_LINE_USE",
        "DIRECTORY_ENTRY_POSTCODE": "DIRECTORY_ENTRY_POSTCODE",
        "DIRECTORY_ENTRY_PREFERENCE": "DIRECTORY_ENTRY_PREFERENCE",
        "DIRECTORY_ENTRY_FILE_PLACEMENT": "DIRECTORY_ENTRY_FILE_PLACEMENT",
        "DIRECTORY_ENTRY_PARTIAL_ADDRESS_INDICATOR": "DIRECTORY_ENTRY_PARTIAL_ADDRESS_INDICATOR"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "skip_annual_price_rise": "Skip annual price rise"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "Skip annual price rise": "Skip annual price rise"
    }
}

{
    "x-enum-descriptions": {}
}

[
    {
        "name": "Validate that an active product rate exists for the product at the start of the product offering's validity period",
        "description": "Validates that an active product rate exists for the product at the start of the product offering's validity period. If a characteristics-based rate specification is configured for the product, an active product rate must exist matching the characteristic variant profile.",
        "possible_errors": [
            "product_rate_is_misconfigured"
        ]
    },
    {
        "name": "Validate that the product offering date range is correct",
        "description": "Validate that the product offering valid from date is before the valid to date.",
        "possible_errors": [
            "invalid_product_offering_date_range"
        ]
    },
    {
        "name": "Validate that the product dates are within the product offering validity period",
        "description": "Validates that the product dates (e.g. product.valid_from_date) are within the product offering validity period.",
        "possible_errors": [
            "product_dates_not_in_offering_date_range"
        ]
    },
    {
        "name": "telco:data-import--validation--location-identifier-and-scheme-consistency--display-name",
        "description": "telco:data-import--validation--location-identifier-and-scheme-consistency--help-text",
        "possible_errors": [
            "location_identified_and_scheme_mismatch"
        ]
    },
    {
        "name": "Validate that the location scheme matches the location identifier",
        "description": "Validates that the location scheme provided matches the expected scheme for the location identifier provided.",
        "possible_errors": [
            "location_identified_and_scheme_mismatch"
        ]
    },
    {
        "name": "Validate that the product code exists within the product offering",
        "description": "Validates that the product code exists within the product offering.",
        "possible_errors": [
            "product_code_not_in_offering"
        ]
    },
    {
        "name": "Validate that the product quantity is valid for the offering",
        "description": "Validates that the product quantity is valid for the offering.",
        "possible_errors": [
            "invalid_product_quantity_within_offering"
        ]
    }
]

[
    {
        "name": "Validate that the product offering date range is correct",
        "description": "Validate that the product offering valid from date is before the valid to date.",
        "possible_errors": [
            "invalid_product_offering_date_range"
        ]
    },
    {
        "name": "Validate that the product code exists within the product offering",
        "description": "Validates that the product code exists within the product offering.",
        "possible_errors": [
            "product_code_not_in_offering"
        ]
    },
    {
        "name": "Validate that the product quantity is valid for the offering",
        "description": "Validates that the product quantity is valid for the offering.",
        "possible_errors": [
            "invalid_product_quantity_within_offering"
        ]
    },
    {
        "name": "Validate that an active product rate exists for the product at the start of the product offering's validity period",
        "description": "Validates that an active product rate exists for the product at the start of the product offering's validity period. If a characteristics-based rate specification is configured for the product, an active product rate must exist matching the characteristic variant profile.",
        "possible_errors": [
            "product_rate_is_misconfigured"
        ]
    },
    {
        "name": "Validate that the product dates are within the product offering validity period",
        "description": "Validates that the product dates (e.g. product.valid_from_date) are within the product offering validity period.",
        "possible_errors": [
            "product_dates_not_in_offering_date_range"
        ]
    },
    {
        "name": "telco:data-import--validation--location-identifier-and-scheme-consistency--display-name",
        "description": "telco:data-import--validation--location-identifier-and-scheme-consistency--help-text",
        "possible_errors": [
            "location_identified_and_scheme_mismatch"
        ]
    },
    {
        "name": "Validate that the location scheme matches the location identifier",
        "description": "Validates that the location scheme provided matches the expected scheme for the location identifier provided.",
        "possible_errors": [
            "location_identified_and_scheme_mismatch"
        ]
    }
]

{
    "x-validators": [
        {
            "name": "Validate that active product offering internal name exists",
            "description": "Validates that the active product offering internal name exists.",
            "possible_errors": [
                "offering_internal_name_does_not_exist"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate that active product offering internal name exists",
            "description": "Validates that the active product offering internal name exists.",
            "possible_errors": [
                "product_offering_internal_name_does_not_exist"
            ]
        }
    ]
}

[
    {
        "name": "Validate that contract versions include a version for the current terms",
        "description": "Validate that the earliest version in the list of contract versions provided has an <code>applicable_at_date</code> that is equal to the contract <code>valid_from_date</code>.",
        "possible_errors": [
            "contract_versions_does_not_include_current"
        ]
    },
    {
        "name": "Validate that the initial price adjustment effective from date matches the contract start date.",
        "description": "Validates that the initial price adjustment effective from date matches the contract valid from date.",
        "possible_errors": [
            "initial_rate_event_effective_from_mismatch"
        ]
    },
    {
        "name": "Validate that selected_offerings and product_offerings fields are mutually exclusive",
        "description": "Validates that selected_offerings and product_offerings fields are mutually exclusive.",
        "possible_errors": [
            "mutually_exclusive_selected_offerings_provided"
        ]
    }
]

[
    {
        "name": "Validate that contract versions include a version for the current terms",
        "description": "Validate that the earliest version in the list of contract versions provided has an <code>applicable_at_date</code> that is equal to the contract <code>valid_from_date</code>.",
        "possible_errors": [
            "contract_versions_does_not_include_current"
        ]
    },
    {
        "name": "Validate that the initial price adjustment effective from date matches the contract start date.",
        "description": "Validates that the initial price adjustment effective from date matches the contract valid from date.",
        "possible_errors": [
            "initial_rate_event_effective_from_mismatch"
        ]
    }
]