{
"title": "Get transaction reply v1",
"description": "Get a broadband transaction.",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://api.nextpertise.nl/schemas/broadband/list_transactions_reply_v1.json",
"type": "object",
"properties": {
"transactions": {
"description": "The transaction list",
"type": "array",
"items": {
"title": "All default transaction attributes for customer usage.",
"type": "object",
"properties": {
"nid": {
"title": "Broadband NID",
"description": "Carrier or circuit identification. To harmonize the way ordered broadband products are identified.",
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$"
},
"uuid": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"offer",
"new",
"migrate",
"change",
"terminate",
"migrate_out"
],
"description": "Enum options:offer|new|migrate|change|terminate|migrate_out
. undefined"
},
"open": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"new",
"processing",
"finished",
"cancelled"
],
"description": "Enum options:new|processing|finished|cancelled
. undefined"
},
"last_updated": {
"title": "Datetime",
"description": "Datetime in UTC format YYYY-MM-DDThh:mm:ssZ",
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
"sitesurvey_plan_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"sitesurvey_date_replan": {
"type": [
"boolean",
"null"
]
},
"sitesurvey_executed_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"sitesurvey_document": {
"type": [
"string",
"null"
]
},
"internalworks_plan_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"internalworks_date_replan": {
"type": [
"boolean",
"null"
]
},
"internalworks_executed_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"externalworks_plan_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"externalworks_date_replan": {
"type": [
"boolean",
"null"
]
},
"externalworks_executed_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"expected_completion_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"expected_completion_date_delayed": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"expected_completion_date_is_forecast": {
"type": [
"boolean",
"null"
]
},
"expected_completion_date_replan": {
"type": [
"boolean",
"null"
]
},
"customer_wish_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"customer_wish_date_replan": {
"type": [
"boolean",
"null"
]
},
"cancelled_by": {
"type": [
"string",
"null"
],
"enum": [
"provider",
"customer",
null
]
},
"cancel_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"cancel_reason": {
"type": [
"string",
"null"
]
},
"cancel_possible": {
"type": "boolean"
},
"replan_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"replan_requested": {
"type": "boolean"
},
"cleanorder_executed_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
},
"created_at": {
"title": "Datetime",
"description": "Datetime in UTC format YYYY-MM-DDThh:mm:ssZ",
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
"cancel_requested": {
"type": [
"boolean",
"null"
]
},
"document_before_transaction": {
"type": [
"null",
"object"
]
},
"document_after_transaction": {
"type": [
"null",
"object"
]
},
"document": {
"type": [
"null",
"object"
]
},
"ftu_count": {
"type": [
"null",
"integer"
]
},
"appointment_url": {
"type": [
"string",
"null"
]
},
"replan_possible": {
"type": "boolean"
},
"is_complex": {
"type": [
"boolean",
"null"
]
},
"is_realtime": {
"type": [
"boolean",
"null"
]
},
"closed_at": {
"oneOf": [
{
"title": "Datetime",
"description": "Datetime in UTC format YYYY-MM-DDThh:mm:ssZ",
"type": [
"string",
"null"
],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": [
"null",
"one of"
]
}
],
"type": "one of"
},
"on_demand": {
"type": "boolean"
},
"on_demand_requested": {
"type": "boolean"
},
"ont_registration": {
"type": "boolean"
},
"termination_contract_end_date": {
"title": "Optional date",
"description": "Optional date in international format YYYY-MM-DD",
"oneOf": [
{
"title": "Date",
"description": "Date in international format YYYY-MM-DD",
"type": [
"string",
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
],
"pattern": "^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$"
},
{
"type": [
"null",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of",
"one of"
]
}
],
"type": "one of"
}
},
"required": [
"nid",
"uuid",
"action",
"open",
"state",
"last_updated",
"created_at"
],
"additionalProperties": false
}
},
"pagination": {
"description": "Information about the pagination settings. If a (next|prev)_page returns null, the page does not exist.",
"type": "object",
"properties": {
"previous_page": {
"title": "Optional integer",
"description": "An integer or no value at all.",
"type": [
"integer",
"null"
]
},
"next_page": {
"title": "Optional integer",
"description": "An integer or no value at all.",
"type": [
"integer",
"null"
]
},
"per_page": {
"description": "Max amount of tickets per page.",
"type": "integer"
},
"count": {
"title": "Optional integer",
"description": "An integer or no value at all.",
"type": [
"integer",
"null"
]
}
},
"required": [
"prev_page",
"next_page",
"per_page",
"count"
]
}
},
"additionalProperties": false,
"required": [
"transactions",
"pagination"
]
}